clang::StackFrameContext Class Reference

It represents a stack frame of the call stack (based on CallEvent). More...

#include "clang/Analysis/AnalysisDeclContext.h"

Inheritance diagram for clang::StackFrameContext:

Public Member Functions
	~StackFrameContext () override=default
const Stmt *	getCallSite () const
const CFGBlock *	getCallSiteBlock () const
bool	inTopFrame () const override
unsigned	getIndex () const
CFGElement	getCallSiteCFGElement () const
void	Profile (llvm::FoldingSetNodeID &ID) override
Public Member Functions inherited from clang::LocationContext
virtual	~LocationContext ()
ContextKind	getKind () const
int64_t	getID () const
LLVM_ATTRIBUTE_RETURNS_NONNULL AnalysisDeclContext *	getAnalysisDeclContext () const
const LocationContext *	getParent () const
	It might return null.
bool	isParentOf (const LocationContext *LC) const
const Decl *	getDecl () const
CFG *	getCFG () const
template<typename T >
T *	getAnalysis () const
const ParentMap &	getParentMap () const
const ImplicitParamDecl *	getSelfDecl () const
const StackFrameContext *	getStackFrame () const
virtual bool	inTopFrame () const
virtual void	Profile (llvm::FoldingSetNodeID &ID)=0
LLVM_DUMP_METHOD void	dumpStack (raw_ostream &Out) const
	Prints out the call stack.
void	printJson (raw_ostream &Out, const char *NL="\n", unsigned int Space=0, bool IsDot=false, std::function< void(const LocationContext *)> printMoreInfoPerContext=[](const LocationContext *) {}) const
	Prints out the call stack in json format.
LLVM_DUMP_METHOD void	dump () const

Static Public Member Functions
static void	Profile (llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ADC, const LocationContext *ParentLC, const Stmt *S, const CFGBlock *Block, unsigned BlockCount, unsigned Index)
static bool	classof (const LocationContext *LC)
Static Public Member Functions inherited from clang::LocationContext
static void	ProfileCommon (llvm::FoldingSetNodeID &ID, ContextKind ck, AnalysisDeclContext *ctx, const LocationContext *parent, const void *data)

Friends
class	LocationContextManager

Additional Inherited Members
Public Types inherited from clang::LocationContext
enum	ContextKind { StackFrame , Block }
Protected Member Functions inherited from clang::LocationContext
	LocationContext (ContextKind k, AnalysisDeclContext *ctx, const LocationContext *parent, int64_t ID)

Detailed Description

It represents a stack frame of the call stack (based on CallEvent).

Examples

/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/StaticAnalyzer/Core/RegionStore.cpp.

Definition at line 299 of file AnalysisDeclContext.h.

Constructor & Destructor Documentation

~StackFrameContext()

clang::StackFrameContext::~StackFrameContext ( )

overridedefault

Member Function Documentation

classof()

static bool clang::StackFrameContext::classof ( const LocationContext *  LC )

inlinestatic

Definition at line 347 of file AnalysisDeclContext.h.

References clang::LocationContext::getKind(), and clang::LocationContext::StackFrame.

getCallSite()

const Stmt * clang::StackFrameContext::getCallSite ( ) const

inline

Definition at line 325 of file AnalysisDeclContext.h.

Referenced by clang::ento::ExprEngine::computeObjectUnderConstruction(), clang::ento::CallEventManager::getCaller(), clang::ento::CXXInheritedConstructorCall::getInheritingStackFrame(), clang::ento::StackHintGeneratorForSymbol::getMessage(), clang::ento::MemRegionManager::getVarRegion(), clang::ento::ExprEngine::processCallExit(), clang::ento::ExprEngine::updateObjectsUnderConstruction(), and clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode().

getCallSiteBlock()

const CFGBlock * clang::StackFrameContext::getCallSiteBlock ( ) const

inline

Definition at line 327 of file AnalysisDeclContext.h.

References Block.

Referenced by clang::ento::ExprEngine::computeObjectUnderConstruction(), clang::ento::CallEventManager::getCaller(), getLocationForCaller(), clang::ento::ExprEngine::processCallExit(), and clang::ento::ExprEngine::updateObjectsUnderConstruction().

getCallSiteCFGElement()

CFGElement clang::StackFrameContext::getCallSiteCFGElement ( ) const

inline

Definition at line 333 of file AnalysisDeclContext.h.

References Block.

Referenced by clang::ento::CallEvent::getConstructionContext().

getIndex()

unsigned clang::StackFrameContext::getIndex ( ) const

inline

Definition at line 331 of file AnalysisDeclContext.h.

Referenced by clang::ento::ExprEngine::computeObjectUnderConstruction(), clang::ento::CallEventManager::getCaller(), getLocationForCaller(), clang::ento::ExprEngine::processCallExit(), and clang::ento::ExprEngine::updateObjectsUnderConstruction().

inTopFrame()

bool clang::StackFrameContext::inTopFrame ( ) const

inlineoverridevirtual

Returns

Whether the current LocationContext has no caller context.

Reimplemented from clang::LocationContext.

Definition at line 329 of file AnalysisDeclContext.h.

References clang::LocationContext::getParent().

Referenced by getCalleeNode(), clang::LocationContext::inTopFrame(), and clang::ento::ExprEngine::processEndOfFunction().

Profile() [1/2]

void StackFrameContext::Profile ( llvm::FoldingSetNodeID &  ID )

overridevirtual

Implements clang::LocationContext.

Definition at line 414 of file AnalysisDeclContext.cpp.

References clang::LocationContext::getAnalysisDeclContext(), clang::LocationContext::getParent(), and Profile().

Referenced by clang::LocationContextManager::getStackFrame(), and Profile().

Profile() [2/2]

static void clang::StackFrameContext::Profile ( llvm::FoldingSetNodeID &  ID, AnalysisDeclContext *  ADC, const LocationContext *  ParentLC, const Stmt *  S, const CFGBlock *  Block, unsigned  BlockCount, unsigned  Index  )

inlinestatic

Definition at line 337 of file AnalysisDeclContext.h.

References Block, ID, clang::LocationContext::ProfileCommon(), and clang::LocationContext::StackFrame.

Friends And Related Function Documentation

LocationContextManager

friend class LocationContextManager

friend

Definition at line 300 of file AnalysisDeclContext.h.

---

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

• include/clang/Analysis/AnalysisDeclContext.h
• lib/Analysis/AnalysisDeclContext.cpp