clang 20.0.0git
Public Types | Public Member Functions | List of all members
clang::Scope Class Reference

Scope - A scope is a transient data structure that is used while parsing the program. More...

#include "clang/Sema/Scope.h"

Public Types

enum  ScopeFlags {
  NoScope = 0 , FnScope = 0x01 , BreakScope = 0x02 , ContinueScope = 0x04 ,
  DeclScope = 0x08 , ControlScope = 0x10 , ClassScope = 0x20 , BlockScope = 0x40 ,
  TemplateParamScope = 0x80 , FunctionPrototypeScope = 0x100 , FunctionDeclarationScope = 0x200 , AtCatchScope = 0x400 ,
  ObjCMethodScope = 0x800 , SwitchScope = 0x1000 , TryScope = 0x2000 , FnTryCatchScope = 0x4000 ,
  OpenMPDirectiveScope = 0x8000 , OpenMPLoopDirectiveScope = 0x10000 , OpenMPSimdDirectiveScope = 0x20000 , EnumScope = 0x40000 ,
  SEHTryScope = 0x80000 , SEHExceptScope = 0x100000 , SEHFilterScope = 0x200000 , CompoundStmtScope = 0x400000 ,
  ClassInheritanceScope = 0x800000 , CatchScope = 0x1000000 , ConditionVarScope = 0x2000000 , OpenMPOrderClauseScope = 0x4000000 ,
  LambdaScope = 0x8000000 , OpenACCComputeConstructScope = 0x10000000 , TypeAliasScope = 0x20000000 , FriendScope = 0x40000000
}
 ScopeFlags - These are bitfields that are or'd together when creating a scope, which defines the sorts of things the scope contains. More...
 
using decl_range = llvm::iterator_range< DeclSetTy::iterator >
 
using using_directives_range = llvm::iterator_range< UsingDirectivesTy::iterator >
 

Public Member Functions

 Scope (Scope *Parent, unsigned ScopeFlags, DiagnosticsEngine &Diag)
 
unsigned getFlags () const
 getFlags - Return the flags for this scope.
 
void setFlags (unsigned F)
 
bool isBlockScope () const
 isBlockScope - Return true if this scope correspond to a closure.
 
const ScopegetParent () const
 getParent - Return the scope that this is nested in.
 
ScopegetParent ()
 
const ScopegetFnParent () const
 getFnParent - Return the closest scope that is a function body.
 
ScopegetFnParent ()
 
const ScopegetMSLastManglingParent () const
 
ScopegetMSLastManglingParent ()
 
ScopegetContinueParent ()
 getContinueParent - Return the closest scope that a continue statement would be affected by.
 
const ScopegetContinueParent () const
 
void setIsConditionVarScope (bool InConditionVarScope)
 
bool isConditionVarScope () const
 
ScopegetBreakParent ()
 getBreakParent - Return the closest scope that a break statement would be affected by.
 
const ScopegetBreakParent () const
 
ScopegetBlockParent ()
 
const ScopegetBlockParent () const
 
ScopegetTemplateParamParent ()
 
const ScopegetTemplateParamParent () const
 
ScopegetDeclParent ()
 
const ScopegetDeclParent () const
 
unsigned getDepth () const
 Returns the depth of this scope. The translation-unit has scope depth 0.
 
unsigned getFunctionPrototypeDepth () const
 Returns the number of function prototype scopes in this scope chain.
 
unsigned getNextFunctionPrototypeIndex ()
 Return the number of parameters declared in this function prototype, increasing it by one for the next call.
 
decl_range decls () const
 
bool decl_empty () const
 
void AddDecl (Decl *D)
 
void RemoveDecl (Decl *D)
 
void incrementMSManglingNumber ()
 
void decrementMSManglingNumber ()
 
unsigned getMSLastManglingNumber () const
 
unsigned getMSCurManglingNumber () const
 
bool isDeclScope (const Decl *D) const
 isDeclScope - Return true if this is the scope that the specified decl is declared in.
 
DeclContextgetEntity () const
 Get the entity corresponding to this scope.
 
DeclContextgetLookupEntity () const
 Get the DeclContext in which to continue unqualified lookup after a lookup in this scope.
 
void setEntity (DeclContext *E)
 
void setLookupEntity (DeclContext *E)
 
bool hasUnrecoverableErrorOccurred () const
 Determine whether any unrecoverable errors have occurred within this scope.
 
bool isFunctionScope () const
 isFunctionScope() - Return true if this scope is a function scope.
 
bool isClassScope () const
 isClassScope - Return true if this scope is a class/struct/union scope.
 
bool isClassInheritanceScope () const
 Determines whether this scope is between inheritance colon and the real class/struct definition.
 
bool isInCXXInlineMethodScope () const
 isInCXXInlineMethodScope - Return true if this scope is a C++ inline method scope or is inside one.
 
bool isInObjcMethodScope () const
 isInObjcMethodScope - Return true if this scope is, or is contained in, an Objective-C method body.
 
bool isInObjcMethodOuterScope () const
 isInObjcMethodOuterScope - Return true if this scope is an Objective-C method outer most body.
 
bool isTemplateParamScope () const
 isTemplateParamScope - Return true if this scope is a C++ template parameter scope.
 
bool isFunctionPrototypeScope () const
 isFunctionPrototypeScope - Return true if this scope is a function prototype scope.
 
bool isFunctionDeclarationScope () const
 isFunctionDeclarationScope - Return true if this scope is a function prototype scope.
 
bool isAtCatchScope () const
 isAtCatchScope - Return true if this scope is @catch.
 
bool isCatchScope () const
 isCatchScope - Return true if this scope is a C++ catch statement.
 
bool isSwitchScope () const
 isSwitchScope - Return true if this scope is a switch scope.
 
bool isLoopScope () const
 Return true if this scope is a loop.
 
bool isOpenMPDirectiveScope () const
 Determines whether this scope is the OpenMP directive scope.
 
bool isOpenMPLoopDirectiveScope () const
 Determine whether this scope is some OpenMP loop directive scope (for example, 'omp for', 'omp simd').
 
bool isOpenMPSimdDirectiveScope () const
 Determine whether this scope is (or is nested into) some OpenMP loop simd directive scope (for example, 'omp simd', 'omp for simd').
 
bool isOpenMPLoopScope () const
 Determine whether this scope is a loop having OpenMP loop directive attached.
 
bool isOpenMPOrderClauseScope () const
 Determine whether this scope is some OpenMP directive with order clause which specifies concurrent scope.
 
bool isOpenACCComputeConstructScope () const
 Determine whether this scope is the statement associated with an OpenACC Compute construct directive.
 
bool isInOpenACCComputeConstructScope (ScopeFlags Flags=NoScope) const
 Determine if this scope (or its parents) are a compute construct.
 
bool isContinueScope () const
 Determine whether this scope is a while/do/for statement, which can have continue statements embedded into it.
 
bool isTryScope () const
 Determine whether this scope is a C++ 'try' block.
 
bool isFnTryCatchScope () const
 Determine whether this scope is a function-level C++ try or catch scope.
 
bool isSEHTryScope () const
 Determine whether this scope is a SEH '__try' block.
 
bool isSEHExceptScope () const
 Determine whether this scope is a SEH '__except' block.
 
bool isCompoundStmtScope () const
 Determine whether this scope is a compound statement scope.
 
bool isControlScope () const
 Determine whether this scope is a controlling scope in a if/switch/while/for statement.
 
bool isTypeAliasScope () const
 Determine whether this scope is a type alias scope.
 
bool isFriendScope () const
 Determine whether this scope is a friend scope.
 
bool Contains (const Scope &rhs) const
 Returns if rhs has a higher scope depth than this.
 
bool containedInPrototypeScope () const
 containedInPrototypeScope - Return true if this or a parent scope is a FunctionPrototypeScope.
 
void PushUsingDirective (UsingDirectiveDecl *UDir)
 
using_directives_range using_directives ()
 
void updateNRVOCandidate (VarDecl *VD)
 
void applyNRVO ()
 
void Init (Scope *parent, unsigned flags)
 Init - This is used by the parser to implement scope caching.
 
void AddFlags (unsigned Flags)
 Sets up the specified scope flags and adjusts the scope state variables accordingly.
 
void dumpImpl (raw_ostream &OS) const
 
void dump () const
 

Detailed Description

Scope - A scope is a transient data structure that is used while parsing the program.

It assists with resolving identifiers to the appropriate declaration.

Definition at line 41 of file Scope.h.

Member Typedef Documentation

◆ decl_range

using clang::Scope::decl_range = llvm::iterator_range<DeclSetTy::iterator>

Definition at line 338 of file Scope.h.

◆ using_directives_range

using clang::Scope::using_directives_range = llvm::iterator_range<UsingDirectivesTy::iterator>

Definition at line 610 of file Scope.h.

Member Enumeration Documentation

◆ ScopeFlags

ScopeFlags - These are bitfields that are or'd together when creating a scope, which defines the sorts of things the scope contains.

Enumerator
NoScope 
FnScope 

This indicates that the scope corresponds to a function, which means that labels are set here.

BreakScope 

This is a while, do, switch, for, etc that can have break statements embedded into it.

ContinueScope 

This is a while, do, for, which can have continue statements embedded into it.

DeclScope 

This is a scope that can contain a declaration.

Some scopes just contain loop constructs but don't contain decls.

ControlScope 

The controlling scope in a if/switch/while/for statement.

ClassScope 

The scope of a struct/union/class definition.

BlockScope 

This is a scope that corresponds to a block/closure object.

Blocks serve as top-level scopes for some objects like labels, they also prevent things like break and continue. BlockScopes always have the FnScope and DeclScope flags set as well.

TemplateParamScope 

This is a scope that corresponds to the template parameters of a C++ template.

Template parameter scope starts at the 'template' keyword and ends when the template declaration ends.

FunctionPrototypeScope 

This is a scope that corresponds to the parameters within a function prototype.

FunctionDeclarationScope 

This is a scope that corresponds to the parameters within a function prototype for a function declaration (as opposed to any other kind of function declarator).

Always has FunctionPrototypeScope set as well.

AtCatchScope 

This is a scope that corresponds to the Objective-C @catch statement.

ObjCMethodScope 

This scope corresponds to an Objective-C method body.

It always has FnScope and DeclScope set as well.

SwitchScope 

This is a scope that corresponds to a switch statement.

TryScope 

This is the scope of a C++ try statement.

FnTryCatchScope 

This is the scope for a function-level C++ try or catch scope.

OpenMPDirectiveScope 

This is the scope of OpenMP executable directive.

OpenMPLoopDirectiveScope 

This is the scope of some OpenMP loop directive.

OpenMPSimdDirectiveScope 

This is the scope of some OpenMP simd directive.

For example, it is used for 'omp simd', 'omp for simd'. This flag is propagated to children scopes.

EnumScope 

This scope corresponds to an enum.

SEHTryScope 

This scope corresponds to an SEH try.

SEHExceptScope 

This scope corresponds to an SEH except.

SEHFilterScope 

We are currently in the filter expression of an SEH except block.

CompoundStmtScope 

This is a compound statement scope.

ClassInheritanceScope 

We are between inheritance colon and the real class/struct definition scope.

CatchScope 

This is the scope of a C++ catch statement.

ConditionVarScope 

This is a scope in which a condition variable is currently being parsed.

If such a scope is a ContinueScope, it's invalid to jump to the continue block from here.

OpenMPOrderClauseScope 

This is a scope of some OpenMP directive with order clause which specifies concurrent.

LambdaScope 

This is the scope for a lambda, after the lambda introducer.

Lambdas need two FunctionPrototypeScope scopes (because there is a template scope in between), the outer scope does not increase the depth of recursion.

OpenACCComputeConstructScope 

This is the scope of an OpenACC Compute Construct, which restricts jumping into/out of it.

We also use this to represent 'combined' constructs, since they have the same behavior.

TypeAliasScope 

This is a scope of type alias declaration.

FriendScope 

This is a scope of friend declaration.

Definition at line 45 of file Scope.h.

Constructor & Destructor Documentation

◆ Scope()

clang::Scope::Scope ( Scope Parent,
unsigned  ScopeFlags,
DiagnosticsEngine Diag 
)
inline

Definition at line 257 of file Scope.h.

References clang::Init, and Parent.

Referenced by CollectARMPACBTIOptions().

Member Function Documentation

◆ AddDecl()

void clang::Scope::AddDecl ( Decl D)
inline

Definition at line 346 of file Scope.h.

References D.

Referenced by clang::Sema::ActOnReenterTemplateScope().

◆ AddFlags()

void Scope::AddFlags ( unsigned  Flags)

Sets up the specified scope flags and adjusts the scope state variables accordingly.

Definition at line 115 of file Scope.cpp.

References BreakScope, and ContinueScope.

◆ applyNRVO()

void Scope::applyNRVO ( )

Definition at line 165 of file Scope.cpp.

References getEntity(), getParent(), and isDeclScope().

◆ containedInPrototypeScope()

bool Scope::containedInPrototypeScope ( ) const

containedInPrototypeScope - Return true if this or a parent scope is a FunctionPrototypeScope.

Definition at line 105 of file Scope.cpp.

◆ Contains()

bool clang::Scope::Contains ( const Scope rhs) const
inline

Returns if rhs has a higher scope depth than this.

The caller is responsible for calling this only if one of the two scopes is an ancestor of the other.

Definition at line 600 of file Scope.h.

Referenced by CheckJumpOutOfSEHFinally().

◆ decl_empty()

bool clang::Scope::decl_empty ( ) const
inline

Definition at line 344 of file Scope.h.

◆ decls()

decl_range clang::Scope::decls ( ) const
inline

Definition at line 340 of file Scope.h.

◆ decrementMSManglingNumber()

void clang::Scope::decrementMSManglingNumber ( )
inline

Definition at line 363 of file Scope.h.

References getMSLastManglingParent().

◆ dump()

LLVM_DUMP_METHOD void Scope::dump ( ) const

Definition at line 196 of file Scope.cpp.

References dumpImpl().

◆ dumpImpl()

void Scope::dumpImpl ( raw_ostream &  OS) const

◆ getBlockParent() [1/2]

Scope * clang::Scope::getBlockParent ( )
inline

Definition at line 313 of file Scope.h.

◆ getBlockParent() [2/2]

const Scope * clang::Scope::getBlockParent ( ) const
inline

Definition at line 314 of file Scope.h.

◆ getBreakParent() [1/2]

Scope * clang::Scope::getBreakParent ( )
inline

getBreakParent - Return the closest scope that a break statement would be affected by.

Definition at line 306 of file Scope.h.

Referenced by clang::Sema::ActOnBreakStmt(), clang::SemaOpenMP::ActOnOpenMPScanDirective(), and getBreakParent().

◆ getBreakParent() [2/2]

const Scope * clang::Scope::getBreakParent ( ) const
inline

Definition at line 309 of file Scope.h.

References getBreakParent().

◆ getContinueParent() [1/2]

Scope * clang::Scope::getContinueParent ( )
inline

getContinueParent - Return the closest scope that a continue statement would be affected by.

Definition at line 285 of file Scope.h.

Referenced by clang::Sema::ActOnContinueStmt(), and getContinueParent().

◆ getContinueParent() [2/2]

const Scope * clang::Scope::getContinueParent ( ) const
inline

Definition at line 289 of file Scope.h.

References getContinueParent().

◆ getDeclParent() [1/2]