clang 19.0.0git
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::ento::BlockDataRegion Class Reference

BlockDataRegion - A region that represents a block instance. More...

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

Inheritance diagram for clang::ento::BlockDataRegion:
Inheritance graph
[legend]

Classes

class  referenced_vars_iterator
 

Public Member Functions

LLVM_ATTRIBUTE_RETURNS_NONNULL const BlockCodeRegiongetCodeRegion () const
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const BlockDeclgetDecl () const
 
QualType getLocationType () const override
 
const VarRegiongetOriginalRegion (const VarRegion *VR) const
 Return the original region for a captured region, if one exists.
 
referenced_vars_iterator referenced_vars_begin () const
 
referenced_vars_iterator referenced_vars_end () const
 
llvm::iterator_range< referenced_vars_iteratorreferenced_vars () const
 
void dumpToStream (raw_ostream &os) const override
 
void Profile (llvm::FoldingSetNodeID &ID) const override
 
- Public Member Functions inherited from clang::ento::TypedRegion
virtual QualType getLocationType () const =0
 
QualType getDesugaredLocationType (ASTContext &Context) const
 
bool isBoundable () const override
 
- Public Member Functions inherited from clang::ento::SubRegion
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegiongetSuperRegion () const
 
MemRegionManagergetMemRegionManager () const override
 
bool isSubRegionOf (const MemRegion *R) const override
 Check if the region is a subregion of the given region.
 
- Public Member Functions inherited from clang::ento::MemRegion
ASTContextgetContext () const
 
virtual void Profile (llvm::FoldingSetNodeID &ID) const =0
 
virtual MemRegionManagergetMemRegionManager () const =0
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemSpaceRegiongetMemorySpace () const
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegiongetBaseRegion () const
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegiongetMostDerivedObjectRegion () const
 Recursively retrieve the region of the most derived class instance of regions of C++ base class instances.
 
virtual bool isSubRegionOf (const MemRegion *R) const
 Check if the region is a subregion of the given region.
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegionStripCasts (bool StripBaseAndDerivedCasts=true) const
 
const SymbolicRegiongetSymbolicBase () const
 If this is a symbolic region, returns the region.
 
bool hasStackStorage () const
 
bool hasStackNonParametersStorage () const
 
bool hasStackParametersStorage () const
 
RegionOffset getAsOffset () const
 Compute the offset within the top level memory object.
 
std::string getString () const
 Get a string representation of a region for debug use.
 
virtual void dumpToStream (raw_ostream &os) const
 
void dump () const
 
virtual bool canPrintPretty () const
 Returns true if this region can be printed in a user-friendly way.
 
virtual void printPretty (raw_ostream &os) const
 Print the region for use in diagnostics.
 
virtual bool canPrintPrettyAsExpr () const
 Returns true if this region's textual representation can be used as part of a larger expression.
 
virtual void printPrettyAsExpr (raw_ostream &os) const
 Print the region as expression.
 
Kind getKind () const
 
template<typename RegionTy >
const RegionTy * getAs () const
 
template<typename RegionTy >
LLVM_ATTRIBUTE_RETURNS_NONNULL const RegionTy * castAs () const
 
virtual bool isBoundable () const
 
std::string getDescriptiveName (bool UseQuotes=true) const
 Get descriptive name for memory region.
 
SourceRange sourceRange () const
 Retrieve source range from memory region.
 

Static Public Member Functions

static bool classof (const MemRegion *R)
 
- Static Public Member Functions inherited from clang::ento::TypedRegion
static bool classof (const MemRegion *R)
 
- Static Public Member Functions inherited from clang::ento::SubRegion
static bool classof (const MemRegion *R)
 

Friends

class MemRegionManager
 

Additional Inherited Members

- Public Types inherited from clang::ento::MemRegion
enum  Kind
 
- Protected Member Functions inherited from clang::ento::TypedRegion
 TypedRegion (const MemRegion *sReg, Kind k)
 
- Protected Member Functions inherited from clang::ento::SubRegion
 SubRegion (const MemRegion *sReg, Kind k)
 
- Protected Member Functions inherited from clang::ento::MemRegion
 MemRegion (Kind k)
 
virtual ~MemRegion ()
 
- Protected Attributes inherited from clang::ento::SubRegion
const MemRegionsuperRegion
 

Detailed Description

BlockDataRegion - A region that represents a block instance.

Blocks are represented with two kinds of regions. BlockCodeRegions represent the "code", while BlockDataRegions represent instances of blocks, which correspond to "code+data". The distinction is important, because like a closure a block captures the values of externally referenced variables.

Definition at line 673 of file MemRegion.h.

Member Function Documentation

◆ classof()

static bool clang::ento::BlockDataRegion::classof ( const MemRegion R)
inlinestatic

Definition at line 760 of file MemRegion.h.

References clang::ento::MemRegion::getKind().

◆ dumpToStream()

void BlockDataRegion::dumpToStream ( raw_ostream &  os) const
overridevirtual

Reimplemented from clang::ento::MemRegion.

Definition at line 492 of file MemRegion.cpp.

References referenced_vars().

◆ getCodeRegion()

LLVM_ATTRIBUTE_RETURNS_NONNULL const BlockCodeRegion * clang::ento::BlockDataRegion::getCodeRegion ( ) const
inline

Definition at line 700 of file MemRegion.h.

◆ getDecl()

LLVM_ATTRIBUTE_RETURNS_NONNULL const BlockDecl * clang::ento::BlockDataRegion::getDecl ( ) const
inline

Definition at line 703 of file MemRegion.h.

References clang::ento::BlockCodeRegion::getDecl().

Referenced by clang::ento::BlockCall::getDecl().

◆ getLocationType()

QualType clang::ento::BlockDataRegion::getLocationType ( ) const
inlineoverridevirtual

Implements clang::ento::TypedRegion.

Definition at line 705 of file MemRegion.h.

References clang::ento::BlockCodeRegion::getLocationType().

◆ getOriginalRegion()

const VarRegion * BlockDataRegion::getOriginalRegion ( const VarRegion VR) const

Return the original region for a captured region, if one exists.

It might return null.

Definition at line 1758 of file MemRegion.cpp.

References referenced_vars().

◆ Profile()

void BlockDataRegion::Profile ( llvm::FoldingSetNodeID &  ID) const
overridevirtual

Implements clang::ento::MemRegion.

Definition at line 390 of file MemRegion.cpp.

References clang::ento::SubRegion::getSuperRegion().

◆ referenced_vars()

llvm::iterator_range< BlockDataRegion::referenced_vars_iterator > BlockDataRegion::referenced_vars ( ) const

◆ referenced_vars_begin()

BlockDataRegion::referenced_vars_iterator BlockDataRegion::referenced_vars_begin ( ) const

Definition at line 1722 of file MemRegion.cpp.

Referenced by referenced_vars().

◆ referenced_vars_end()

BlockDataRegion::referenced_vars_iterator BlockDataRegion::referenced_vars_end ( ) const

Definition at line 1738 of file MemRegion.cpp.

Referenced by referenced_vars().

Friends And Related Function Documentation

◆ MemRegionManager

friend class MemRegionManager
friend

Definition at line 674 of file MemRegion.h.


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