clang 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
clang::ProgramPoint Class Reference

#include "clang/Analysis/ProgramPoint.h"

Inheritance diagram for clang::ProgramPoint:
Inheritance graph
[legend]

Public Types

enum  Kind {
  BlockEdgeKind , BlockEntranceKind , BlockExitKind , PreStmtKind ,
  PreStmtPurgeDeadSymbolsKind , PostStmtPurgeDeadSymbolsKind , PostStmtKind , PreLoadKind ,
  PostLoadKind , PreStoreKind , PostStoreKind , PostConditionKind ,
  PostLValueKind , PostAllocatorCallKind , MinPostStmtKind = PostStmtKind , MaxPostStmtKind = PostAllocatorCallKind ,
  PostInitializerKind , CallEnterKind , CallExitBeginKind , CallExitEndKind ,
  FunctionExitKind , PreImplicitCallKind , PostImplicitCallKind , MinImplicitCallKind = PreImplicitCallKind ,
  MaxImplicitCallKind = PostImplicitCallKind , LoopExitKind , EpsilonKind
}
 

Public Member Functions

ProgramPoint withTag (const ProgramPointTag *tag) const
 Create a new ProgramPoint object that is the same as the original except for using the specified tag value.
 
template<typename T >
T castAs () const
 Convert to the specified ProgramPoint type, asserting that this ProgramPoint is of the desired type.
 
template<typename T >
std::optional< T > getAs () const
 Convert to the specified ProgramPoint type, returning std::nullopt if this ProgramPoint is not of the desired type.
 
Kind getKind () const
 
bool isPurgeKind ()
 Is this a program point corresponding to purge/removal of dead symbols and bindings.
 
const ProgramPointTag * getTag () const
 
const LocationContext * getLocationContext () const
 
const StackFrameContext * getStackFrame () const
 
unsigned getHashValue () const
 
bool operator== (const ProgramPoint &RHS) const
 
bool operator!= (const ProgramPoint &RHS) const
 
void Profile (llvm::FoldingSetNodeID &ID) const
 
void printJson (llvm::raw_ostream &Out, const char *NL="\n") const
 
LLVM_DUMP_METHOD void dump () const
 

Static Public Member Functions

static ProgramPoint getProgramPoint (const Stmt *S, ProgramPoint::Kind K, const LocationContext *LC, const ProgramPointTag *tag)
 

Protected Member Functions

 ProgramPoint ()=default
 
 ProgramPoint (const void *P, Kind k, const LocationContext *l, const ProgramPointTag *tag=nullptr, CFGBlock::ConstCFGElementRef ElemRef={nullptr, 0})
 
 ProgramPoint (const void *P1, const void *P2, Kind k, const LocationContext *l, const ProgramPointTag *tag=nullptr, CFGBlock::ConstCFGElementRef ElemRef={nullptr, 0})
 
const void * getData1 () const
 
const void * getData2 () const
 
void setData2 (const void *d)
 
CFGBlock::ConstCFGElementRef getElementRef () const
 

Detailed Description

Definition at line 58 of file ProgramPoint.h.

Member Enumeration Documentation

◆ Kind

enum clang::ProgramPoint::Kind
Enumerator
BlockEdgeKind 
BlockEntranceKind 
BlockExitKind 
PreStmtKind 
PreStmtPurgeDeadSymbolsKind 
PostStmtPurgeDeadSymbolsKind 
PostStmtKind 
PreLoadKind 
PostLoadKind 
PreStoreKind 
PostStoreKind 
PostConditionKind 
PostLValueKind 
PostAllocatorCallKind 
MinPostStmtKind 
MaxPostStmtKind 
PostInitializerKind 
CallEnterKind 
CallExitBeginKind 
CallExitEndKind 
FunctionExitKind 
PreImplicitCallKind 
PostImplicitCallKind 
MinImplicitCallKind 
MaxImplicitCallKind 
LoopExitKind 
EpsilonKind 

Definition at line 60 of file ProgramPoint.h.

Constructor & Destructor Documentation

◆ ProgramPoint() [1/3]

clang::ProgramPoint::ProgramPoint ( )
protecteddefault

Referenced by withTag().

◆ ProgramPoint() [2/3]

clang::ProgramPoint::ProgramPoint ( const void *  P,
Kind  k,
const LocationContext *  l,
const ProgramPointTag *  tag = nullptr,
CFGBlock::ConstCFGElementRef  ElemRef = {nullptr, 0} 
)
inlineprotected

Definition at line 102 of file ProgramPoint.h.

◆ ProgramPoint() [3/3]

clang::ProgramPoint::ProgramPoint ( const void *  P1,
const void *  P2,
Kind  k,
const LocationContext *  l,
const ProgramPointTag *  tag = nullptr,
CFGBlock::ConstCFGElementRef  ElemRef = {nullptr, 0} 
)
inlineprotected

Definition at line 113 of file ProgramPoint.h.

Member Function Documentation

◆ castAs()

template<typename T >
T clang::ProgramPoint::castAs ( ) const
inline

Convert to the specified ProgramPoint type, asserting that this ProgramPoint is of the desired type.

Definition at line 137 of file ProgramPoint.h.

References clang::T.

Referenced by clang::ento::ExprEngine::VisitGuardedExpr(), clang::ento::ExprEngine::VisitLogicalExpr(), and clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode().

◆ dump()

LLVM_DUMP_METHOD void ProgramPoint::dump ( ) const

Definition at line 47 of file ProgramPoint.cpp.

References printJson().

◆ getAs()

template<typename T >
std::optional< T > clang::ProgramPoint::getAs ( ) const
inline

Convert to the specified ProgramPoint type, returning std::nullopt if this ProgramPoint is not of the desired type.

Definition at line 147 of file ProgramPoint.h.

References clang::T.

Referenced by clang::ento::CoreEngine::enqueueStmtNode(), GetAllocationSite(), getLastStmt(), clang::ento::CheckerContext::getLocationRegionIfPostStore(), clang::ento::PathSensitiveBugReport::getStmt(), getStmtBeforeCond(), peelOffOuterExpr(), shouldRemoveDeadBindings(), clang::ento::ExprEngine::VisitGuardedExpr(), clang::ento::ExprEngine::VisitLogicalExpr(), clang::ento::UndefOrNullArgVisitor::VisitNode(), clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode(), clang::ento::SuppressInlineDefensiveChecksVisitor::VisitNode(), and clang::ento::ConditionBRVisitor::VisitNodeImpl().

◆ getData1()

const void * clang::ProgramPoint::getData1 ( ) const
inlineprotected

Definition at line 121 of file ProgramPoint.h.

Referenced by clang::BlockEntrance::getBlock(), clang::BlockExit::getBlock(), clang::CallExitEnd::getCalleeContext(), clang::CallEnter::getCallExpr(), clang::EpsilonPoint::getData(), clang::PostInitializer::getInitializer(), clang::ImplicitCallPoint::getLocation(), clang::LoopExit::getLoopStmt(), clang::CallExitBegin::getReturnStmt(), clang::BlockEdge::getSrc(), clang::StmtPoint::getStmt(), clang::FunctionExitPoint::getStmt(), Profile(), and withTag().

◆ getData2()

const void * clang::ProgramPoint::getData2 ( ) const
inlineprotected

Definition at line 122 of file ProgramPoint.h.

Referenced by clang::CallEnter::getCalleeContext(), clang::ImplicitCallPoint::getDecl(), clang::BlockEdge::getDst(), clang::PostStore::getLocationValue(), clang::PostInitializer::getLocationValue(), clang::PreStmt::getSubStmt(), clang::PostStore::PostStore(), Profile(), and withTag().

◆ getElementRef()

CFGBlock::ConstCFGElementRef clang::ProgramPoint::getElementRef ( ) const
inlineprotected

Definition at line 124 of file ProgramPoint.h.

◆ getHashValue()

unsigned clang::ProgramPoint::getHashValue ( ) const
inline

Definition at line 184 of file ProgramPoint.h.

References ID, and Profile().

Referenced by llvm::DenseMapInfo< clang::ProgramPoint >::getHashValue().

◆ getKind()

Kind clang::ProgramPoint::getKind ( ) const
inline

Definition at line 156 of file ProgramPoint.h.

Referenced by clang::ento::WorkList::enqueue(), isPurgeKind(), printJson(), Profile(), and withTag().

◆ getLocationContext()

const LocationContext * clang::ProgramPoint::getLocationContext ( ) const
inline

Definition at line 175 of file ProgramPoint.h.

Referenced by clang::ento::PathDiagnosticCallPiece::construct(), clang::FunctionExitPoint::getBlock(), clang::ento::ExplodedNode::getLocationContext(), getStackFrame(), clang::ento::PathSensitiveBugReport::getStmt(), printJson(), clang::ento::ExprEngine::processCFGBlockEntrance(), Profile(), clang::ento::PathDiagnosticCallPiece::setCallee(), and withTag().

◆ getProgramPoint()

ProgramPoint ProgramPoint::getProgramPoint ( const Stmt *  S,
ProgramPoint::Kind  K,
const LocationContext *  LC,
const ProgramPointTag *  tag 
)
static

Definition at line 22 of file ProgramPoint.cpp.

References PostLoadKind, PostLValueKind, PostStmtKind, PostStmtPurgeDeadSymbolsKind, PreLoadKind, PreStmtKind, PreStmtPurgeDeadSymbolsKind, and PreStoreKind.

Referenced by clang::ento::StmtNodeBuilder::generateNode(), clang::ento::StmtNodeBuilder::generateSink(), and clang::ento::CheckerManager::runCheckersForEvalCall().

◆ getStackFrame()

const StackFrameContext * clang::ProgramPoint::getStackFrame ( ) const
inline

Definition at line 179 of file ProgramPoint.h.

References getLocationContext(), and clang::LocationContext::getStackFrame().

Referenced by getLastStmt(), and clang::ento::ExplodedNode::getStackFrame().

◆ getTag()

const ProgramPointTag * clang::ProgramPoint::getTag ( ) const
inline

Definition at line 173 of file ProgramPoint.h.

Referenced by clang::ento::CheckerContext::generateErrorNode(), clang::ento::CheckerContext::generateNonFatalErrorNode(), llvm::DOTGraphTraits< ExplodedGraph * >::getNodeLabel(), Profile(), clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode(), clang::ento::TagVisitor::VisitNode(), clang::ento::ConditionBRVisitor::VisitNodeImpl(), and clang::ento::ExprEngine::VisitObjCMessage().

◆ isPurgeKind()

bool clang::ProgramPoint::isPurgeKind ( )
inline

Is this a program point corresponding to purge/removal of dead symbols and bindings.

Definition at line 167 of file ProgramPoint.h.

References getKind(), PostStmtPurgeDeadSymbolsKind, and PreStmtPurgeDeadSymbolsKind.

◆ operator!=()

bool clang::ProgramPoint::operator!= ( const ProgramPoint &  RHS) const
inline

Definition at line 195 of file ProgramPoint.h.

◆ operator==()

bool clang::ProgramPoint::operator== ( const ProgramPoint &  RHS) const
inline

Definition at line 190 of file ProgramPoint.h.

◆ printJson()

void ProgramPoint::printJson ( llvm::raw_ostream &  Out,
const char *  NL = "\n" 
) const

Definition at line 51 of file ProgramPoint.cpp.

References BlockEdgeKind, BlockEntranceKind, BlockExitKind, clang::C, CallEnterKind, CallExitBeginKind, CallExitEndKind, EpsilonKind, FunctionExitKind, clang::LocationContext::getAnalysisDeclContext(), clang::Decl::getAsFunction(), clang::AnalysisDeclContext::getASTContext(), clang::CFGBlock::getBlockID(), clang::ImplicitCallPoint::getDecl(), clang::BlockEdge::getDst(), getKind(), clang::CFGBlock::getLabel(), clang::ASTContext::getLangOpts(), clang::QualType::getLocalUnqualifiedType(), clang::ImplicitCallPoint::getLocation(), getLocationContext(), clang::ASTContext::getPrintingPolicy(), clang::NamedDecl::getQualifiedNameAsString(), clang::ASTContext::getSourceManager(), clang::BlockEdge::getSrc(), clang::CFGBlock::getTerminatorStmt(), clang::Init, Label, LoopExitKind, PostImplicitCallKind, PostInitializerKind, PreImplicitCallKind, clang::QualType::print(), clang::printSourceLocationAsJson(), clang::CFGBlock::printTerminatorJson(), SM, clang::CFGBlock::succ_begin(), and clang::T.

Referenced by dump(), and llvm::DOTGraphTraits< ExplodedGraph * >::getNodeLabel().

◆ Profile()

void clang::ProgramPoint::Profile ( llvm::FoldingSetNodeID &  ID) const
inline

Definition at line 200 of file ProgramPoint.h.

References getData1(), getData2(), getKind(), getLocationContext(), getTag(), and ID.

Referenced by getHashValue().

◆ setData2()

void clang::ProgramPoint::setData2 ( const void *  d)
inlineprotected

Definition at line 123 of file ProgramPoint.h.

Referenced by clang::PostStore::PostStore().

◆ withTag()

ProgramPoint clang::ProgramPoint::withTag ( const ProgramPointTag *  tag) const
inline

Create a new ProgramPoint object that is the same as the original except for using the specified tag value.

Definition at line 129 of file ProgramPoint.h.

References getData1(), getData2(), getKind(), getLocationContext(), and ProgramPoint().

Referenced by clang::ento::CoreEngine::enqueueStmtNode(), clang::ento::NodeBuilderWithSinks::generateNode(), clang::ento::NodeBuilderWithSinks::generateSink(), and clang::ento::ExprEngine::VisitCXXDestructor().

The documentation for this class was generated from the following files:
Generated on Fri Apr 26 2024 01:34:12 for clang by doxygen 1.9.6