clang 20.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::ento::BlockCodeRegion Class Reference

BlockCodeRegion - A region that represents code texts of blocks (closures). More...

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

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

Public Member Functions

QualType getLocationType () const override
 
LLVM_ATTRIBUTE_RETURNS_NONNULL const BlockDeclgetDecl () const
 
LLVM_ATTRIBUTE_RETURNS_NONNULL AnalysisDeclContextgetAnalysisDeclContext () const
 
void dumpToStream (raw_ostream &os) const override
 
void Profile (llvm::FoldingSetNodeID &ID) const override
 
- Public Member Functions inherited from clang::ento::CodeTextRegion
bool isBoundable () 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
 
StringRef getKindStr () 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::CodeTextRegion
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::CodeTextRegion
 CodeTextRegion (const MemSpaceRegion *sreg, Kind k)
 
- 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

BlockCodeRegion - A region that represents code texts of blocks (closures).

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 631 of file MemRegion.h.

Member Function Documentation

◆ classof()

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

Definition at line 667 of file MemRegion.h.

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

◆ dumpToStream()

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

Reimplemented from clang::ento::MemRegion.

Definition at line 488 of file MemRegion.cpp.

◆ getAnalysisDeclContext()

LLVM_ATTRIBUTE_RETURNS_NONNULL AnalysisDeclContext * clang::ento::BlockCodeRegion::getAnalysisDeclContext ( ) const
inline

Definition at line 661 of file MemRegion.h.

◆ getDecl()

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

◆ getLocationType()

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

Implements clang::ento::TypedRegion.

Definition at line 651 of file MemRegion.h.

Referenced by clang::ento::BlockDataRegion::getLocationType().

◆ Profile()

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

Implements clang::ento::MemRegion.

Definition at line 374 of file MemRegion.cpp.

References clang::ento::SubRegion::superRegion.

Friends And Related Function Documentation

◆ MemRegionManager

friend class MemRegionManager
friend

Definition at line 632 of file MemRegion.h.


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