clang 20.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::ento::SubRegion Class Reference

SubRegion - A region that subsets another larger region. More...

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

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

Public Member Functions

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)
 

Protected Member Functions

 SubRegion (const MemRegion *sReg, Kind k)
 
- Protected Member Functions inherited from clang::ento::MemRegion
 MemRegion (Kind k)
 
virtual ~MemRegion ()
 

Protected Attributes

const MemRegionsuperRegion
 

Additional Inherited Members

- Public Types inherited from clang::ento::MemRegion
enum  Kind
 

Detailed Description

SubRegion - A region that subsets another larger region.

Most regions are subclasses of SubRegion.

Definition at line 446 of file MemRegion.h.

Constructor & Destructor Documentation

◆ SubRegion()

clang::ento::SubRegion::SubRegion ( const MemRegion sReg,
Kind  k 
)
inlineprotected

Definition at line 452 of file MemRegion.h.

References classof().

Member Function Documentation

◆ classof()

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

Definition at line 467 of file MemRegion.h.

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

Referenced by SubRegion().

◆ getMemRegionManager()

MemRegionManager & SubRegion::getMemRegionManager ( ) const
overridevirtual

◆ getSuperRegion()

LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegion * clang::ento::SubRegion::getSuperRegion ( ) const
inline

◆ isSubRegionOf()

bool SubRegion::isSubRegionOf ( const MemRegion R) const
overridevirtual

Check if the region is a subregion of the given region.

Each region is a subregion of itself.

Reimplemented from clang::ento::MemRegion.

Definition at line 132 of file MemRegion.cpp.

Referenced by collectSubRegionBindings(), clang::ento::taint::getTaintedSymbolsImpl(), wasRegionOfInterestModifiedAt(), and willObjectBeAnalyzedLater().

Member Data Documentation

◆ superRegion

const MemRegion* clang::ento::SubRegion::superRegion
protected

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