clang  3.9.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::CFG Class Reference

CFG - Represents a source-level, intra-procedural CFG that represents the control-flow of a Stmt. More...

#include <CFG.h>

Classes

class  BuildOptions
 
class  const_graph_iterator
 
class  graph_iterator
 Provides a custom implementation of the iterator class to have the same interface as Function::iterator - iterator returns CFGBlock (not a pointer to CFGBlock). More...
 

Public Types

typedef BumpVector< CFGBlock * > CFGBlockListTy
 
typedef CFGBlockListTy::iterator iterator
 
typedef
CFGBlockListTy::const_iterator 
const_iterator
 
typedef std::reverse_iterator
< iterator
reverse_iterator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_iterator
 
typedef std::vector< const
CFGBlock * >::const_iterator 
try_block_iterator
 
typedef llvm::DenseMap< const
DeclStmt *, const DeclStmt * >
::const_iterator 
synthetic_stmt_iterator
 

Public Member Functions

CFGBlockcreateBlock ()
 createBlock - Create a new block in the CFG. More...
 
void setEntry (CFGBlock *B)
 setEntry - Set the entry block of the CFG. More...
 
void setIndirectGotoBlock (CFGBlock *B)
 setIndirectGotoBlock - Set the block used for indirect goto jumps. More...
 
CFGBlockfront ()
 
CFGBlockback ()
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
graph_iterator nodes_begin ()
 
graph_iterator nodes_end ()
 
const_graph_iterator nodes_begin () const
 
const_graph_iterator nodes_end () const
 
reverse_iterator rbegin ()
 
reverse_iterator rend ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator rend () const
 
CFGBlockgetEntry ()
 
const CFGBlockgetEntry () const
 
CFGBlockgetExit ()
 
const CFGBlockgetExit () const
 
CFGBlockgetIndirectGotoBlock ()
 
const CFGBlockgetIndirectGotoBlock () const
 
try_block_iterator try_blocks_begin () const
 
try_block_iterator try_blocks_end () const
 
void addTryDispatchBlock (const CFGBlock *block)
 
void addSyntheticDeclStmt (const DeclStmt *Synthetic, const DeclStmt *Source)
 Records a synthetic DeclStmt and the DeclStmt it was constructed from. More...
 
synthetic_stmt_iterator synthetic_stmt_begin () const
 Iterates over synthetic DeclStmts in the CFG. More...
 
synthetic_stmt_iterator synthetic_stmt_end () const
 
template<typename CALLBACK >
void VisitBlockStmts (CALLBACK &O) const
 
unsigned getNumBlockIDs () const
 getNumBlockIDs - Returns the total number of BlockIDs allocated (which start at 0). More...
 
unsigned size () const
 size - Return the total number of CFGBlocks within the CFG This is simply a renaming of the getNumBlockIDs(). More...
 
void viewCFG (const LangOptions &LO) const
 
void print (raw_ostream &OS, const LangOptions &LO, bool ShowColors) const
 print - A simple pretty printer of a CFG that outputs to an ostream. More...
 
void dump (const LangOptions &LO, bool ShowColors) const
 dump - A simple pretty printer of a CFG that outputs to stderr. More...
 
 CFG ()
 
llvm::BumpPtrAllocator & getAllocator ()
 
BumpVectorContextgetBumpVectorContext ()
 

Static Public Member Functions

static std::unique_ptr< CFGbuildCFG (const Decl *D, Stmt *AST, ASTContext *C, const BuildOptions &BO)
 buildCFG - Builds a CFG from an AST. More...
 

Detailed Description

CFG - Represents a source-level, intra-procedural CFG that represents the control-flow of a Stmt.

The Stmt can represent an entire function body, or a single expression. A CFG will always contain one empty block that represents the Exit point of the CFG. A CFG will also contain a designated Entry block. The CFG solely represents control-flow; it consists of CFGBlocks which are simply containers of Stmt*'s in the AST the CFG was constructed from.

Definition at line 721 of file CFG.h.

Member Typedef Documentation

Definition at line 834 of file CFG.h.

Definition at line 836 of file CFG.h.

typedef std::reverse_iterator<const_iterator> clang::CFG::const_reverse_iterator

Definition at line 838 of file CFG.h.

Definition at line 835 of file CFG.h.

typedef std::reverse_iterator<iterator> clang::CFG::reverse_iterator

Definition at line 837 of file CFG.h.

typedef llvm::DenseMap<const DeclStmt *, const DeclStmt *>::const_iterator clang::CFG::synthetic_stmt_iterator

Definition at line 895 of file CFG.h.

Definition at line 870 of file CFG.h.

Constructor & Destructor Documentation

clang::CFG::CFG ( )
inline

Definition at line 950 of file CFG.h.

Member Function Documentation

void clang::CFG::addSyntheticDeclStmt ( const DeclStmt Synthetic,
const DeclStmt Source 
)
inline

Records a synthetic DeclStmt and the DeclStmt it was constructed from.

The CFG uses synthetic DeclStmts when a single AST DeclStmt contains multiple decls.

Definition at line 886 of file CFG.h.

References clang::DeclStmt::isSingleDecl().

void clang::CFG::addTryDispatchBlock ( const CFGBlock block)
inline

Definition at line 878 of file CFG.h.

CFGBlock& clang::CFG::back ( )
inline

Definition at line 841 of file CFG.h.

References clang::BumpVector< T >::back().

Referenced by createBlock().

iterator clang::CFG::begin ( )
inline
const_iterator clang::CFG::begin ( ) const
inline

Definition at line 845 of file CFG.h.

References clang::BumpVector< T >::begin().

std::unique_ptr< CFG > CFG::buildCFG ( const Decl D,
Stmt AST,
ASTContext C,
const BuildOptions BO 
)
static

buildCFG - Builds a CFG from an AST.

buildCFG - Constructs a CFG from an AST.

Definition at line 3888 of file CFG.cpp.

References Builder.

Referenced by clang::AnalysisDeclContext::getCFG(), and clang::AnalysisDeclContext::getUnoptimizedCFG().

CFGBlock * CFG::createBlock ( )

createBlock - Create a new block in the CFG.

createBlock - Constructs and adds a new CFGBlock to the CFG.

The CFG owns the block; the caller should not directly free it.

The block has no successors or predecessors. If this is the first block created in the CFG, it is automatically set to be the Entry and Exit of the CFG.

Definition at line 3871 of file CFG.cpp.

References back(), begin(), end(), getAllocator(), and clang::BumpVector< T >::push_back().

void CFG::dump ( const LangOptions LO,
bool  ShowColors 
) const

dump - A simple pretty printer of a CFG that outputs to stderr.

Definition at line 4527 of file CFG.cpp.

References clang::CFGBlock::print().

Referenced by clang::AnalysisDeclContext::dumpCFG().

iterator clang::CFG::end ( )
inline
const_iterator clang::CFG::end ( ) const
inline

Definition at line 846 of file CFG.h.

References clang::BumpVector< T >::end().

CFGBlock& clang::CFG::front ( )
inline

Definition at line 840 of file CFG.h.

References clang::BumpVector< T >::front().

llvm::BumpPtrAllocator& clang::CFG::getAllocator ( )
inline

Definition at line 954 of file CFG.h.

References clang::BumpVectorContext::getAllocator().

Referenced by createBlock().

BumpVectorContext& clang::CFG::getBumpVectorContext ( )
inline

Definition at line 958 of file CFG.h.

CFGBlock& clang::CFG::getEntry ( )
inline
const CFGBlock& clang::CFG::getEntry ( ) const
inline

Definition at line 863 of file CFG.h.

CFGBlock& clang::CFG::getExit ( )
inline
const CFGBlock& clang::CFG::getExit ( ) const
inline

Definition at line 865 of file CFG.h.

CFGBlock* clang::CFG::getIndirectGotoBlock ( )
inline

Definition at line 867 of file CFG.h.

Referenced by print_block().

const CFGBlock* clang::CFG::getIndirectGotoBlock ( ) const
inline

Definition at line 868 of file CFG.h.

unsigned clang::CFG::getNumBlockIDs ( ) const
inline
graph_iterator clang::CFG::nodes_begin ( )
inline
const_graph_iterator clang::CFG::nodes_begin ( ) const
inline

Definition at line 850 of file CFG.h.

References clang::BumpVector< T >::begin().

graph_iterator clang::CFG::nodes_end ( )
inline
const_graph_iterator clang::CFG::nodes_end ( ) const
inline

Definition at line 853 of file CFG.h.

References clang::BumpVector< T >::end().

void CFG::print ( raw_ostream &  OS,
const LangOptions LO,
bool  ShowColors 
) const

print - A simple pretty printer of a CFG that outputs to an ostream.

Definition at line 4532 of file CFG.cpp.

References E, I, and print_block().

reverse_iterator clang::CFG::rbegin ( )
inline

Definition at line 857 of file CFG.h.

References clang::BumpVector< T >::rbegin().

const_reverse_iterator clang::CFG::rbegin ( ) const
inline

Definition at line 859 of file CFG.h.

References clang::BumpVector< T >::rbegin().

reverse_iterator clang::CFG::rend ( )
inline

Definition at line 858 of file CFG.h.

References clang::BumpVector< T >::rend().

const_reverse_iterator clang::CFG::rend ( ) const
inline

Definition at line 860 of file CFG.h.

References clang::BumpVector< T >::rend().

void clang::CFG::setEntry ( CFGBlock B)
inline

setEntry - Set the entry block of the CFG.

This is typically used only during CFG construction. Most CFG clients expect that the entry block has no predecessors and contains no statements.

Definition at line 824 of file CFG.h.

void clang::CFG::setIndirectGotoBlock ( CFGBlock B)
inline

setIndirectGotoBlock - Set the block used for indirect goto jumps.

This is typically used only during CFG construction.

Definition at line 828 of file CFG.h.

unsigned clang::CFG::size ( ) const
inline

size - Return the total number of CFGBlocks within the CFG This is simply a renaming of the getNumBlockIDs().

This is necessary because the dominator implementation needs such an interface.

Definition at line 936 of file CFG.h.

Referenced by llvm::GraphTraits< ::clang::CFG * >::size().

synthetic_stmt_iterator clang::CFG::synthetic_stmt_begin ( ) const
inline

Iterates over synthetic DeclStmts in the CFG.

Each element is a (synthetic statement, source statement) pair.

See Also
addSyntheticDeclStmt

Definition at line 902 of file CFG.h.

Referenced by addParentsForSyntheticStmts().

synthetic_stmt_iterator clang::CFG::synthetic_stmt_end ( ) const
inline
See Also
synthetic_stmt_begin

Definition at line 907 of file CFG.h.

Referenced by addParentsForSyntheticStmts().

try_block_iterator clang::CFG::try_blocks_begin ( ) const
inline

Definition at line 871 of file CFG.h.

Referenced by clang::reachable_code::FindUnreachableCode().

try_block_iterator clang::CFG::try_blocks_end ( ) const
inline

Definition at line 874 of file CFG.h.

Referenced by clang::reachable_code::FindUnreachableCode().

void CFG::viewCFG ( const LangOptions LO) const

Definition at line 4653 of file CFG.cpp.

template<typename CALLBACK >
void clang::CFG::VisitBlockStmts ( CALLBACK &  O) const
inline

Definition at line 916 of file CFG.h.

References begin(), E, end(), I, and clang::ast_matchers::stmt.

Referenced by clang::runUninitializedVariablesAnalysis().


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