clang::lifetimes::internal::OriginEscapesFact Class Reference

Represents that an origin escapes the current scope through various means. More...

#include "clang/Analysis/Analyses/LifetimeSafety/Facts.h"

Inheritance diagram for clang::lifetimes::internal::OriginEscapesFact:

Public Types
enum class	EscapeKind : uint8_t { Return , Field }
	The way an origin can escape the current scope. More...
Public Types inherited from clang::lifetimes::internal::Fact
enum class	Kind : uint8_t {   Issue , Expire , OriginFlow , Use ,   TestPoint , OriginEscapes }

Public Member Functions
	OriginEscapesFact (OriginID OID, EscapeKind EscKind)
OriginID	getEscapedOriginID () const
EscapeKind	getEscapeKind () const
Public Member Functions inherited from clang::lifetimes::internal::Fact
virtual	~Fact ()=default
Kind	getKind () const
void	setID (FactID ID)
FactID	getID () const
template<typename T>
const T *	getAs () const
virtual void	dump (llvm::raw_ostream &OS, const LoanManager &, const OriginManager &) const

Static Public Member Functions
static bool	classof (const Fact *F)

Public Attributes
enum clang::lifetimes::internal::OriginEscapesFact::EscapeKind	EscKind

Additional Inherited Members
Protected Member Functions inherited from clang::lifetimes::internal::Fact
	Fact (Kind K)

Detailed Description

Represents that an origin escapes the current scope through various means.

This is the base class for different escape scenarios.

Definition at line 141 of file Facts.h.

Member Enumeration Documentation

EscapeKind

enum class clang::lifetimes::internal::OriginEscapesFact::EscapeKind : uint8_t

strong

The way an origin can escape the current scope.

Enumerator
Return
Field	Escapes via return statement.

Definition at line 146 of file Facts.h.

Constructor & Destructor Documentation

OriginEscapesFact()

clang::lifetimes::internal::OriginEscapesFact::OriginEscapesFact ( OriginID OID, EscapeKind EscKind )

inline

Definition at line 156 of file Facts.h.

References EscKind, clang::lifetimes::internal::Fact::Fact(), and clang::lifetimes::internal::Fact::OriginEscapes.

Referenced by clang::lifetimes::internal::FieldEscapeFact::classof(), clang::lifetimes::internal::ReturnEscapeFact::classof(), clang::lifetimes::internal::FieldEscapeFact::FieldEscapeFact(), and clang::lifetimes::internal::ReturnEscapeFact::ReturnEscapeFact().

Member Function Documentation

classof()

bool clang::lifetimes::internal::OriginEscapesFact::classof ( const Fact * F )

inlinestatic

Definition at line 152 of file Facts.h.

References clang::lifetimes::internal::Fact::Fact(), clang::lifetimes::internal::Fact::getKind(), and clang::lifetimes::internal::Fact::OriginEscapes.

getEscapedOriginID()

OriginID clang::lifetimes::internal::OriginEscapesFact::getEscapedOriginID ( ) const

inline

Definition at line 158 of file Facts.h.

Referenced by clang::lifetimes::internal::FieldEscapeFact::dump(), and clang::lifetimes::internal::ReturnEscapeFact::dump().

getEscapeKind()

EscapeKind clang::lifetimes::internal::OriginEscapesFact::getEscapeKind ( ) const

inline

Definition at line 159 of file Facts.h.

References EscKind.

Referenced by clang::lifetimes::internal::FieldEscapeFact::classof(), and clang::lifetimes::internal::ReturnEscapeFact::classof().

Member Data Documentation

EscKind

enum clang::lifetimes::internal::OriginEscapesFact::EscapeKind clang::lifetimes::internal::OriginEscapesFact::EscKind

Referenced by getEscapeKind(), and OriginEscapesFact().

---

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

• include/clang/Analysis/Analyses/LifetimeSafety/Facts.h