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

ParamVarRegion - Represents a region for paremters. More...

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

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

Public Member Functions

LLVM_ATTRIBUTE_RETURNS_NONNULL const ExprgetOriginExpr () const
 
unsigned getIndex () const
 
void Profile (llvm::FoldingSetNodeID &ID) const override
 
void dumpToStream (raw_ostream &os) const override
 
QualType getValueType () const override
 
const ParmVarDeclgetDecl () const override
 TODO: What does this return?
 
bool canPrintPrettyAsExpr () const override
 Returns true if this region's textual representation can be used as part of a larger expression.
 
void printPrettyAsExpr (raw_ostream &os) const override
 Print the region as expression.
 
- Public Member Functions inherited from clang::ento::VarRegion
const VarDeclgetDecl () const override=0
 
const StackFrameContextgetStackFrame () const
 It might return null.
 
QualType getValueType () const override
 
virtual const ValueDeclgetDecl () const =0
 
- Public Member Functions inherited from clang::ento::TypedValueRegion
virtual QualType getValueType () const =0
 
QualType getLocationType () const override
 
QualType getDesugaredValueType (ASTContext &Context) const
 
- 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::VarRegion
static bool classof (const MemRegion *R)
 
- Static Public Member Functions inherited from clang::ento::DeclRegion
static bool classof (const MemRegion *R)
 
- Static Public Member Functions inherited from clang::ento::TypedValueRegion
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::VarRegion
 VarRegion (const MemRegion *sReg, Kind k)
 
- Protected Member Functions inherited from clang::ento::DeclRegion
 DeclRegion (const MemRegion *sReg, Kind k)
 
- Protected Member Functions inherited from clang::ento::TypedValueRegion
 TypedValueRegion (const MemRegion *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

ParamVarRegion - Represents a region for paremters.

Only parameters of the function in the current stack frame are represented as ParamVarRegions. Parameters of top-level analyzed functions as well as captured paremeters by lambdas and blocks are repesented as VarRegions.

Definition at line 1034 of file MemRegion.h.

Member Function Documentation

◆ canPrintPrettyAsExpr()

bool ParamVarRegion::canPrintPrettyAsExpr ( ) const
overridevirtual

Returns true if this region's textual representation can be used as part of a larger expression.

Reimplemented from clang::ento::MemRegion.

Definition at line 661 of file MemRegion.cpp.

◆ classof()

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

Definition at line 1066 of file MemRegion.h.

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

◆ dumpToStream()

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

Reimplemented from clang::ento::MemRegion.

Definition at line 613 of file MemRegion.cpp.

References getDecl(), clang::Decl::getID(), and clang::NamedDecl::getIdentifier().

◆ getDecl()

const ParmVarDecl * ParamVarRegion::getDecl ( ) const
overridevirtual

◆ getIndex()

unsigned clang::ento::ParamVarRegion::getIndex ( ) const
inline

Definition at line 1052 of file MemRegion.h.

Referenced by Profile(), and clang::ento::SValExplainer::VisitParamVarRegion().

◆ getOriginExpr()

LLVM_ATTRIBUTE_RETURNS_NONNULL const Expr * clang::ento::ParamVarRegion::getOriginExpr ( ) const
inline

Definition at line 1051 of file MemRegion.h.

Referenced by Profile().

◆ getValueType()

QualType ParamVarRegion::getValueType ( ) const
overridevirtual

Reimplemented from clang::ento::VarRegion.

Definition at line 193 of file MemRegion.cpp.

References getDecl(), and clang::ValueDecl::getType().

◆ printPrettyAsExpr()

void ParamVarRegion::printPrettyAsExpr ( raw_ostream &  os) const
overridevirtual

Print the region as expression.

When this region represents a subexpression, the method is for printing an expression containing it.

Reimplemented from clang::ento::MemRegion.

Definition at line 663 of file MemRegion.cpp.

References getDecl(), and clang::NamedDecl::getName().

◆ Profile()

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

Friends And Related Function Documentation

◆ MemRegionManager

friend class MemRegionManager
friend

Definition at line 1035 of file MemRegion.h.


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