clang  8.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::threadSafety::til::Variable Class Reference

A named variable, e.g. More...

#include "clang/Analysis/Analyses/ThreadSafetyTIL.h"

Inheritance diagram for clang::threadSafety::til::Variable:
Inheritance graph
[legend]
Collaboration diagram for clang::threadSafety::til::Variable:
Collaboration graph
[legend]

Public Types

enum  VariableKind { VK_Let, VK_Fun, VK_SFun }
 

Public Member Functions

 Variable (StringRef s, SExpr *D=nullptr)
 
 Variable (SExpr *D, const ValueDecl *Cvd=nullptr)
 
 Variable (const Variable &Vd, SExpr *D)
 
VariableKind kind () const
 Return the kind of variable (let, function param, or self) More...
 
StringRef name () const
 Return the name of the variable, if any. More...
 
const ValueDeclclangDecl () const
 Return the clang declaration for this variable, if any. More...
 
SExprdefinition ()
 Return the definition of the variable. More...
 
const SExprdefinition () const
 
void setName (StringRef S)
 
void setKind (VariableKind K)
 
void setDefinition (SExpr *E)
 
void setClangDecl (const ValueDecl *VD)
 
template<class V >
V::R_SExpr traverse (V &Vs, typename V::R_Ctx Ctx)
 
template<class C >
C::CType compare (const Variable *E, C &Cmp) const
 
- Public Member Functions inherited from clang::threadSafety::til::SExpr
 SExpr ()=delete
 
TIL_Opcode opcode () const
 
void * operator new (size_t S, MemRegionRef &R)
 
void * operator new (size_t)=delete
 SExpr objects must be created in an arena. More...
 
void operator delete (void *)=delete
 SExpr objects cannot be deleted. More...
 
unsigned id () const
 Returns the instruction ID for this expression. More...
 
BasicBlockblock () const
 Returns the block, if this is an instruction in a basic block, otherwise returns null. More...
 
void setID (BasicBlock *B, unsigned id)
 Set the basic block and instruction ID for this expression. More...
 

Static Public Member Functions

static bool classof (const SExpr *E)
 

Friends

class BasicBlock
 
class Function
 
class Let
 
class SFunction
 

Additional Inherited Members

- Protected Member Functions inherited from clang::threadSafety::til::SExpr
 SExpr (TIL_Opcode Op)
 
 SExpr (const SExpr &E)
 
- Protected Attributes inherited from clang::threadSafety::til::SExpr
const unsigned char Opcode
 
unsigned char Reserved = 0
 
unsigned short Flags = 0
 
unsigned SExprID = 0
 
BasicBlockBlock = nullptr
 

Detailed Description

A named variable, e.g.

"x".

There are two distinct places in which a Variable can appear in the AST. A variable declaration introduces a new variable, and can occur in 3 places: Let-expressions: (Let (x = t) u) Functions: (Function (x : t) u) Self-applicable functions (SFunction (x) t)

If a variable occurs in any other location, it is a reference to an existing variable declaration – e.g. 'x' in (x * y + z). To save space, we don't allocate a separate AST node for variable references; a reference is just a pointer to the original declaration.

Definition at line 356 of file ThreadSafetyTIL.h.

Member Enumeration Documentation

◆ VariableKind

Enumerator
VK_Let 

Let-variable.

VK_Fun 

Function parameter.

VK_SFun 

SFunction (self) parameter.

Definition at line 358 of file ThreadSafetyTIL.h.

Constructor & Destructor Documentation

◆ Variable() [1/3]

clang::threadSafety::til::Variable::Variable ( StringRef  s,
SExpr D = nullptr 
)
inline

Definition at line 369 of file ThreadSafetyTIL.h.

◆ Variable() [2/3]

clang::threadSafety::til::Variable::Variable ( SExpr D,
const ValueDecl Cvd = nullptr 
)
inline

Definition at line 374 of file ThreadSafetyTIL.h.

◆ Variable() [3/3]

clang::threadSafety::til::Variable::Variable ( const Variable Vd,
SExpr D 
)
inline

Definition at line 380 of file ThreadSafetyTIL.h.

Member Function Documentation

◆ clangDecl()

const ValueDecl* clang::threadSafety::til::Variable::clangDecl ( ) const
inline

Return the clang declaration for this variable, if any.

Definition at line 394 of file ThreadSafetyTIL.h.

◆ classof()

static bool clang::threadSafety::til::Variable::classof ( const SExpr E)
inlinestatic

Definition at line 385 of file ThreadSafetyTIL.h.

References clang::threadSafety::til::SExpr::opcode().

◆ compare()

template<class C >
C::CType clang::threadSafety::til::Variable::compare ( const Variable E,
C &  Cmp 
) const
inline

Definition at line 414 of file ThreadSafetyTIL.h.

◆ definition() [1/2]

SExpr* clang::threadSafety::til::Variable::definition ( )
inline

Return the definition of the variable.

For let-vars, this is the setting expression. For function and self parameters, it is the type of the variable.

Definition at line 399 of file ThreadSafetyTIL.h.

Referenced by clang::threadSafety::til::PrettyPrinter< StdPrinter, std::ostream >::printFunction(), and clang::threadSafety::til::PrettyPrinter< StdPrinter, std::ostream >::printLet().

◆ definition() [2/2]

const SExpr* clang::threadSafety::til::Variable::definition ( ) const
inline

Definition at line 400 of file ThreadSafetyTIL.h.

◆ kind()

VariableKind clang::threadSafety::til::Variable::kind ( ) const
inline

Return the kind of variable (let, function param, or self)

Definition at line 388 of file ThreadSafetyTIL.h.

Referenced by clang::threadSafety::til::PrettyPrinter< StdPrinter, std::ostream >::printVariable().

◆ name()

StringRef clang::threadSafety::til::Variable::name ( ) const
inline

Return the name of the variable, if any.

Definition at line 391 of file ThreadSafetyTIL.h.

Referenced by clang::threadSafety::til::PrettyPrinter< StdPrinter, std::ostream >::printVariable().

◆ setClangDecl()

void clang::threadSafety::til::Variable::setClangDecl ( const ValueDecl VD)
inline

Definition at line 405 of file ThreadSafetyTIL.h.

◆ setDefinition()

void clang::threadSafety::til::Variable::setDefinition ( SExpr E)
inline

Definition at line 404 of file ThreadSafetyTIL.h.

◆ setKind()

void clang::threadSafety::til::Variable::setKind ( VariableKind  K)
inline

◆ setName()

void clang::threadSafety::til::Variable::setName ( StringRef  S)
inline

Definition at line 402 of file ThreadSafetyTIL.h.

◆ traverse()

template<class V >
V::R_SExpr clang::threadSafety::til::Variable::traverse ( V &  Vs,
typename V::R_Ctx  Ctx 
)
inline

Friends And Related Function Documentation

◆ BasicBlock

friend class BasicBlock
friend

Definition at line 419 of file ThreadSafetyTIL.h.

◆ Function

friend class Function
friend

Definition at line 420 of file ThreadSafetyTIL.h.

◆ Let

friend class Let
friend

Definition at line 421 of file ThreadSafetyTIL.h.

◆ SFunction

friend class SFunction
friend

Definition at line 422 of file ThreadSafetyTIL.h.


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