clang 22.0.0git
clang::ento::StringRegion Class Reference

StringRegion - Region associated with a StringLiteral. More...

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

Inheritance diagram for clang::ento::StringRegion:
[legend]

Public Member Functions

LLVM_ATTRIBUTE_RETURNS_NONNULL const StringLiteralgetStringLiteral () const
QualType getValueType () const override
bool isBoundable () const override
void Profile (llvm::FoldingSetNodeID &ID) const override
void dumpToStream (raw_ostream &os) const override
Public Member Functions inherited from clang::ento::TypedValueRegion
QualType getLocationType () const override
QualType getDesugaredValueType (ASTContext &Context) const
Public Member Functions inherited from clang::ento::TypedRegion
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
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemSpaceRegiongetRawMemorySpace () const
 Deprecated.
template<class MemSpace>
const MemSpace * getRawMemorySpaceAs () const
 Deprecated. Use getMemorySpace(ProgramStateRef) instead.
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemSpaceRegiongetMemorySpace (ProgramStateRef State) const
 Returns the most specific memory space for this memory region in the given ProgramStateRef.
template<class MemSpace>
const MemSpace * getMemorySpaceAs (ProgramStateRef State) const
template<typename... MemorySpaces>
bool hasMemorySpace (ProgramStateRef State) const
ProgramStateRef setMemorySpace (ProgramStateRef State, const MemSpaceRegion *Space) const
 Set the dynamically deduced memory space of a MemRegion that currently has UnknownSpaceRegion.
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.
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegionStripCasts (bool StripBaseAndDerivedCasts=true) const
const SymbolicRegiongetSymbolicBase () const
 If this is a symbolic region, returns the region.
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.
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
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::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::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

StringRegion - Region associated with a StringLiteral.

Definition at line 857 of file MemRegion.h.

Member Function Documentation

◆ classof()

bool clang::ento::StringRegion::classof ( const MemRegion * R)
inlinestatic

Definition at line 885 of file MemRegion.h.

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

◆ dumpToStream()

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

Reimplemented from clang::ento::MemRegion.

Definition at line 555 of file MemRegion.cpp.

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

◆ getStringLiteral()

LLVM_ATTRIBUTE_RETURNS_NONNULL const StringLiteral * clang::ento::StringRegion::getStringLiteral ( ) const
inline

Definition at line 873 of file MemRegion.h.

◆ getValueType()

QualType clang::ento::StringRegion::getValueType ( ) const
inlineoverridevirtual

Implements clang::ento::TypedValueRegion.

Definition at line 875 of file MemRegion.h.

◆ isBoundable()

bool clang::ento::StringRegion::isBoundable ( ) const
inlineoverridevirtual

Reimplemented from clang::ento::MemRegion.

Definition at line 877 of file MemRegion.h.

◆ Profile()

void clang::ento::StringRegion::Profile ( llvm::FoldingSetNodeID & ID) const
inlineoverridevirtual

Implements clang::ento::MemRegion.

Definition at line 879 of file MemRegion.h.

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

◆ MemRegionManager

friend class MemRegionManager
friend

Definition at line 858 of file MemRegion.h.

References MemRegionManager, and clang::ento::TypedValueRegion::TypedValueRegion().

Referenced by MemRegionManager.


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