Coverage Report

Created: 2022-07-16 07:03

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Sema/Scope.h
Line
Count
Source (jump to first uncovered line)
1
//===- Scope.h - Scope interface --------------------------------*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
//  This file defines the Scope interface.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_SEMA_SCOPE_H
14
#define LLVM_CLANG_SEMA_SCOPE_H
15
16
#include "clang/AST/Decl.h"
17
#include "clang/Basic/Diagnostic.h"
18
#include "llvm/ADT/PointerIntPair.h"
19
#include "llvm/ADT/SmallPtrSet.h"
20
#include "llvm/ADT/SmallVector.h"
21
#include "llvm/ADT/iterator_range.h"
22
#include <cassert>
23
24
namespace llvm {
25
26
class raw_ostream;
27
28
} // namespace llvm
29
30
namespace clang {
31
32
class Decl;
33
class DeclContext;
34
class UsingDirectiveDecl;
35
class VarDecl;
36
37
/// Scope - A scope is a transient data structure that is used while parsing the
38
/// program.  It assists with resolving identifiers to the appropriate
39
/// declaration.
40
class Scope {
41
public:
42
  /// ScopeFlags - These are bitfields that are or'd together when creating a
43
  /// scope, which defines the sorts of things the scope contains.
44
  enum ScopeFlags {
45
    /// This indicates that the scope corresponds to a function, which
46
    /// means that labels are set here.
47
    FnScope       = 0x01,
48
49
    /// This is a while, do, switch, for, etc that can have break
50
    /// statements embedded into it.
51
    BreakScope    = 0x02,
52
53
    /// This is a while, do, for, which can have continue statements
54
    /// embedded into it.
55
    ContinueScope = 0x04,
56
57
    /// This is a scope that can contain a declaration.  Some scopes
58
    /// just contain loop constructs but don't contain decls.
59
    DeclScope = 0x08,
60
61
    /// The controlling scope in a if/switch/while/for statement.
62
    ControlScope = 0x10,
63
64
    /// The scope of a struct/union/class definition.
65
    ClassScope = 0x20,
66
67
    /// This is a scope that corresponds to a block/closure object.
68
    /// Blocks serve as top-level scopes for some objects like labels, they
69
    /// also prevent things like break and continue.  BlockScopes always have
70
    /// the FnScope and DeclScope flags set as well.
71
    BlockScope = 0x40,
72
73
    /// This is a scope that corresponds to the
74
    /// template parameters of a C++ template. Template parameter
75
    /// scope starts at the 'template' keyword and ends when the
76
    /// template declaration ends.
77
    TemplateParamScope = 0x80,
78
79
    /// This is a scope that corresponds to the
80
    /// parameters within a function prototype.
81
    FunctionPrototypeScope = 0x100,
82
83
    /// This is a scope that corresponds to the parameters within
84
    /// a function prototype for a function declaration (as opposed to any
85
    /// other kind of function declarator). Always has FunctionPrototypeScope
86
    /// set as well.
87
    FunctionDeclarationScope = 0x200,
88
89
    /// This is a scope that corresponds to the Objective-C
90
    /// \@catch statement.
91
    AtCatchScope = 0x400,
92
93
    /// This scope corresponds to an Objective-C method body.
94
    /// It always has FnScope and DeclScope set as well.
95
    ObjCMethodScope = 0x800,
96
97
    /// This is a scope that corresponds to a switch statement.
98
    SwitchScope = 0x1000,
99
100
    /// This is the scope of a C++ try statement.
101
    TryScope = 0x2000,
102
103
    /// This is the scope for a function-level C++ try or catch scope.
104
    FnTryCatchScope = 0x4000,
105
106
    /// This is the scope of OpenMP executable directive.
107
    OpenMPDirectiveScope = 0x8000,
108
109
    /// This is the scope of some OpenMP loop directive.
110
    OpenMPLoopDirectiveScope = 0x10000,
111
112
    /// This is the scope of some OpenMP simd directive.
113
    /// For example, it is used for 'omp simd', 'omp for simd'.
114
    /// This flag is propagated to children scopes.
115
    OpenMPSimdDirectiveScope = 0x20000,
116
117
    /// This scope corresponds to an enum.
118
    EnumScope = 0x40000,
119
120
    /// This scope corresponds to an SEH try.
121
    SEHTryScope = 0x80000,
122
123
    /// This scope corresponds to an SEH except.
124
    SEHExceptScope = 0x100000,
125
126
    /// We are currently in the filter expression of an SEH except block.
127
    SEHFilterScope = 0x200000,
128
129
    /// This is a compound statement scope.
130
    CompoundStmtScope = 0x400000,
131
132
    /// We are between inheritance colon and the real class/struct definition
133
    /// scope.
134
    ClassInheritanceScope = 0x800000,
135
136
    /// This is the scope of a C++ catch statement.
137
    CatchScope = 0x1000000,
138
139
    /// This is a scope in which a condition variable is currently being
140
    /// parsed. If such a scope is a ContinueScope, it's invalid to jump to the
141
    /// continue block from here.
142
    ConditionVarScope = 0x2000000,
143
  };
144
145
private:
146
  /// The parent scope for this scope.  This is null for the translation-unit
147
  /// scope.
148
  Scope *AnyParent;
149
150
  /// Flags - This contains a set of ScopeFlags, which indicates how the scope
151
  /// interrelates with other control flow statements.
152
  unsigned Flags;
153
154
  /// Depth - This is the depth of this scope.  The translation-unit scope has
155
  /// depth 0.
156
  unsigned short Depth;
157
158
  /// Declarations with static linkage are mangled with the number of
159
  /// scopes seen as a component.
160
  unsigned short MSLastManglingNumber;
161
162
  unsigned short MSCurManglingNumber;
163
164
  /// PrototypeDepth - This is the number of function prototype scopes
165
  /// enclosing this scope, including this scope.
166
  unsigned short PrototypeDepth;
167
168
  /// PrototypeIndex - This is the number of parameters currently
169
  /// declared in this scope.
170
  unsigned short PrototypeIndex;
171
172
  /// FnParent - If this scope has a parent scope that is a function body, this
173
  /// pointer is non-null and points to it.  This is used for label processing.
174
  Scope *FnParent;
175
  Scope *MSLastManglingParent;
176
177
  /// BreakParent/ContinueParent - This is a direct link to the innermost
178
  /// BreakScope/ContinueScope which contains the contents of this scope
179
  /// for control flow purposes (and might be this scope itself), or null
180
  /// if there is no such scope.
181
  Scope *BreakParent, *ContinueParent;
182
183
  /// BlockParent - This is a direct link to the immediately containing
184
  /// BlockScope if this scope is not one, or null if there is none.
185
  Scope *BlockParent;
186
187
  /// TemplateParamParent - This is a direct link to the
188
  /// immediately containing template parameter scope. In the
189
  /// case of nested templates, template parameter scopes can have
190
  /// other template parameter scopes as parents.
191
  Scope *TemplateParamParent;
192
193
  /// DeclsInScope - This keeps track of all declarations in this scope.  When
194
  /// the declaration is added to the scope, it is set as the current
195
  /// declaration for the identifier in the IdentifierTable.  When the scope is
196
  /// popped, these declarations are removed from the IdentifierTable's notion
197
  /// of current declaration.  It is up to the current Action implementation to
198
  /// implement these semantics.
199
  using DeclSetTy = llvm::SmallPtrSet<Decl *, 32>;
200
  DeclSetTy DeclsInScope;
201
202
  /// The DeclContext with which this scope is associated. For
203
  /// example, the entity of a class scope is the class itself, the
204
  /// entity of a function scope is a function, etc.
205
  DeclContext *Entity;
206
207
  using UsingDirectivesTy = SmallVector<UsingDirectiveDecl *, 2>;
208
  UsingDirectivesTy UsingDirectives;
209
210
  /// Used to determine if errors occurred in this scope.
211
  DiagnosticErrorTrap ErrorTrap;
212
213
  /// A lattice consisting of undefined, a single NRVO candidate variable in
214
  /// this scope, or over-defined. The bit is true when over-defined.
215
  llvm::PointerIntPair<VarDecl *, 1, bool> NRVO;
216
217
  void setFlags(Scope *Parent, unsigned F);
218
219
public:
220
  Scope(Scope *Parent, unsigned ScopeFlags, DiagnosticsEngine &Diag)
221
358k
      : ErrorTrap(Diag) {
222
358k
    Init(Parent, ScopeFlags);
223
358k
  }
224
225
  /// getFlags - Return the flags for this scope.
226
1.22G
  unsigned getFlags() const { return Flags; }
227
228
272
  void setFlags(unsigned F) { setFlags(getParent(), F); }
229
230
  /// isBlockScope - Return true if this scope correspond to a closure.
231
0
  bool isBlockScope() const { return Flags & BlockScope; }
232
233
  /// getParent - Return the scope that this is nested in.
234
971k
  const Scope *getParent() const { return AnyParent; }
235
1.40G
  Scope *getParent() { return AnyParent; }
236
237
  /// getFnParent - Return the closest scope that is a function body.
238
372k
  const Scope *getFnParent() const { return FnParent; }
239
6.72M
  Scope *getFnParent() { return FnParent; }
240
241
42.8M
  const Scope *getMSLastManglingParent() const {
242
42.8M
    return MSLastManglingParent;
243
42.8M
  }
244
8.00M
  Scope *getMSLastManglingParent() { return MSLastManglingParent; }
245
246
  /// getContinueParent - Return the closest scope that a continue statement
247
  /// would be affected by.
248
15.6k
  Scope *getContinueParent() {
249
15.6k
    return ContinueParent;
250
15.6k
  }
251
252
0
  const Scope *getContinueParent() const {
253
0
    return const_cast<Scope*>(this)->getContinueParent();
254
0
  }
255
256
  // Set whether we're in the scope of a condition variable, where 'continue'
257
  // is disallowed despite being a continue scope.
258
418k
  void setIsConditionVarScope(bool InConditionVarScope) {
259
418k
    Flags = (Flags & ~ConditionVarScope) |
260
418k
            (InConditionVarScope ? 
ConditionVarScope111
:
0418k
);
261
418k
  }
262
263
13.0k
  bool isConditionVarScope() const {
264
13.0k
    return Flags & ConditionVarScope;
265
13.0k
  }
266
267
  /// getBreakParent - Return the closest scope that a break statement
268
  /// would be affected by.
269
59.7k
  Scope *getBreakParent() {
270
59.7k
    return BreakParent;
271
59.7k
  }
272
0
  const Scope *getBreakParent() const {
273
0
    return const_cast<Scope*>(this)->getBreakParent();
274
0
  }
275
276
429k
  Scope *getBlockParent() { return BlockParent; }
277
0
  const Scope *getBlockParent() const { return BlockParent; }
278
279
1.87M
  Scope *getTemplateParamParent() { return TemplateParamParent; }
280
0
  const Scope *getTemplateParamParent() const { return TemplateParamParent; }
281
282
  /// Returns the depth of this scope. The translation-unit has scope depth 0.
283
8.69k
  unsigned getDepth() const { return Depth; }
284
285
  /// Returns the number of function prototype scopes in this scope
286
  /// chain.
287
155M
  unsigned getFunctionPrototypeDepth() const {
288
155M
    return PrototypeDepth;
289
155M
  }
290
291
  /// Return the number of parameters declared in this function
292
  /// prototype, increasing it by one for the next call.
293
65.3M
  unsigned getNextFunctionPrototypeIndex() {
294
65.3M
    assert(isFunctionPrototypeScope());
295
0
    return PrototypeIndex++;
296
65.3M
  }
297
298
  using decl_range = llvm::iterator_range<DeclSetTy::iterator>;
299
300
46.2M
  decl_range decls() const {
301
46.2M
    return decl_range(DeclsInScope.begin(), DeclsInScope.end());
302
46.2M
  }
303
304
37.0M
  bool decl_empty() const { return DeclsInScope.empty(); }
305
306
117M
  void AddDecl(Decl *D) {
307
117M
    DeclsInScope.insert(D);
308
117M
  }
309
310
607k
  void RemoveDecl(Decl *D) {
311
607k
    DeclsInScope.erase(D);
312
607k
  }
313
314
7.77M
  void incrementMSManglingNumber() {
315
7.77M
    if (Scope *MSLMP = getMSLastManglingParent()) {
316
7.10M
      MSLMP->MSLastManglingNumber += 1;
317
7.10M
      MSCurManglingNumber += 1;
318
7.10M
    }
319
7.77M
  }
320
321
226k
  void decrementMSManglingNumber() {
322
226k
    if (Scope *MSLMP = getMSLastManglingParent()) {
323
226k
      MSLMP->MSLastManglingNumber -= 1;
324
226k
      MSCurManglingNumber -= 1;
325
226k
    }
326
226k
  }
327
328
42.8M
  unsigned getMSLastManglingNumber() const {
329
42.8M
    if (const Scope *MSLMP = getMSLastManglingParent())
330
7.50M
      return MSLMP->MSLastManglingNumber;
331
35.3M
    return 1;
332
42.8M
  }
333
334
148
  unsigned getMSCurManglingNumber() const {
335
148
    return MSCurManglingNumber;
336
148
  }
337
338
  /// isDeclScope - Return true if this is the scope that the specified decl is
339
  /// declared in.
340
1.10G
  bool isDeclScope(const Decl *D) const { return DeclsInScope.contains(D); }
341
342
  /// Get the entity corresponding to this scope.
343
747M
  DeclContext *getEntity() const {
344
747M
    return isTemplateParamScope() ? 
nullptr43.0M
:
Entity704M
;
345
747M
  }
346
347
  /// Get the DeclContext in which to continue unqualified lookup after a
348
  /// lookup in this scope.
349
303M
  DeclContext *getLookupEntity() const { return Entity; }
350
351
7.02M
  void setEntity(DeclContext *E) {
352
7.02M
    assert(!isTemplateParamScope() &&
353
7.02M
           "entity associated with template param scope");
354
0
    Entity = E;
355
7.02M
  }
356
516k
  void setLookupEntity(DeclContext *E) { Entity = E; }
357
358
  /// Determine whether any unrecoverable errors have occurred within this
359
  /// scope. Note that this may return false even if the scope contains invalid
360
  /// declarations or statements, if the errors for those invalid constructs
361
  /// were suppressed because some prior invalid construct was referenced.
362
85.4M
  bool hasUnrecoverableErrorOccurred() const {
363
85.4M
    return ErrorTrap.hasUnrecoverableErrorOccurred();
364
85.4M
  }
365
366
  /// isFunctionScope() - Return true if this scope is a function scope.
367
21.0k
  bool isFunctionScope() const { return getFlags() & Scope::FnScope; }
368
369
  /// isClassScope - Return true if this scope is a class/struct/union scope.
370
27.3M
  bool isClassScope() const { return getFlags() & Scope::ClassScope; }
371
372
  /// Determines whether this scope is between inheritance colon and the real
373
  /// class/struct definition.
374
9
  bool isClassInheritanceScope() const {
375
9
    return getFlags() & Scope::ClassInheritanceScope;
376
9
  }
377
378
  /// isInCXXInlineMethodScope - Return true if this scope is a C++ inline
379
  /// method scope or is inside one.
380
0
  bool isInCXXInlineMethodScope() const {
381
0
    if (const Scope *FnS = getFnParent()) {
382
0
      assert(FnS->getParent() && "TUScope not created?");
383
0
      return FnS->getParent()->isClassScope();
384
0
    }
385
0
    return false;
386
0
  }
387
388
  /// isInObjcMethodScope - Return true if this scope is, or is contained in, an
389
  /// Objective-C method body.  Note that this method is not constant time.
390
442k
  bool isInObjcMethodScope() const {
391
1.13M
    for (const Scope *S = this; S; 
S = S->getParent()697k
) {
392
      // If this scope is an objc method scope, then we succeed.
393
698k
      if (S->getFlags() & ObjCMethodScope)
394
1.35k
        return true;
395
698k
    }
396
440k
    return false;
397
442k
  }
398
399
  /// isInObjcMethodOuterScope - Return true if this scope is an
400
  /// Objective-C method outer most body.
401
0
  bool isInObjcMethodOuterScope() const {
402
0
    if (const Scope *S = this) {
403
0
      // If this scope is an objc method scope, then we succeed.
404
0
      if (S->getFlags() & ObjCMethodScope)
405
0
        return true;
406
0
    }
407
0
    return false;
408
0
  }
409
410
  /// isTemplateParamScope - Return true if this scope is a C++
411
  /// template parameter scope.
412
841M
  bool isTemplateParamScope() const {
413
841M
    return getFlags() & Scope::TemplateParamScope;
414
841M
  }
415
416
  /// isFunctionPrototypeScope - Return true if this scope is a
417
  /// function prototype scope.
418
215M
  bool isFunctionPrototypeScope() const {
419
215M
    return getFlags() & Scope::FunctionPrototypeScope;
420
215M
  }
421
422
  /// isFunctionDeclarationScope - Return true if this scope is a
423
  /// function prototype scope.
424
25.3M
  bool isFunctionDeclarationScope() const {
425
25.3M
    return getFlags() & Scope::FunctionDeclarationScope;
426
25.3M
  }
427
428
  /// isAtCatchScope - Return true if this scope is \@catch.
429
26
  bool isAtCatchScope() const {
430
26
    return getFlags() & Scope::AtCatchScope;
431
26
  }
432
433
  /// isCatchScope - Return true if this scope is a C++ catch statement.
434
126
  bool isCatchScope() const { return getFlags() & Scope::CatchScope; }
435
436
  /// isSwitchScope - Return true if this scope is a switch scope.
437
19
  bool isSwitchScope() const {
438
53
    for (const Scope *S = this; S; 
S = S->getParent()34
) {
439
53
      if (S->getFlags() & Scope::SwitchScope)
440
18
        return true;
441
35
      else if (S->getFlags() & (Scope::FnScope | Scope::ClassScope |
442
35
                                Scope::BlockScope | Scope::TemplateParamScope |
443
35
                                Scope::FunctionPrototypeScope |
444
35
                                Scope::AtCatchScope | Scope::ObjCMethodScope))
445
1
        return false;
446
53
    }
447
0
    return false;
448
19
  }
449
450
  /// Determines whether this scope is the OpenMP directive scope
451
358
  bool isOpenMPDirectiveScope() const {
452
358
    return (getFlags() & Scope::OpenMPDirectiveScope);
453
358
  }
454
455
  /// Determine whether this scope is some OpenMP loop directive scope
456
  /// (for example, 'omp for', 'omp simd').
457
38.8k
  bool isOpenMPLoopDirectiveScope() const {
458
38.8k
    if (getFlags() & Scope::OpenMPLoopDirectiveScope) {
459
358
      assert(isOpenMPDirectiveScope() &&
460
358
             "OpenMP loop directive scope is not a directive scope");
461
0
      return true;
462
358
    }
463
38.5k
    return false;
464
38.8k
  }
465
466
  /// Determine whether this scope is (or is nested into) some OpenMP
467
  /// loop simd directive scope (for example, 'omp simd', 'omp for simd').
468
33.2k
  bool isOpenMPSimdDirectiveScope() const {
469
33.2k
    return getFlags() & Scope::OpenMPSimdDirectiveScope;
470
33.2k
  }
471
472
  /// Determine whether this scope is a loop having OpenMP loop
473
  /// directive attached.
474
38.8k
  bool isOpenMPLoopScope() const {
475
38.8k
    const Scope *P = getParent();
476
38.8k
    return P && P->isOpenMPLoopDirectiveScope();
477
38.8k
  }
478
479
  /// Determine whether this scope is a while/do/for statement, which can have
480
  /// continue statements embedded into it.
481
220k
  bool isContinueScope() const {
482
220k
    return getFlags() & ScopeFlags::ContinueScope;
483
220k
  }
484
485
  /// Determine whether this scope is a C++ 'try' block.
486
0
  bool isTryScope() const { return getFlags() & Scope::TryScope; }
487
488
  /// Determine whether this scope is a function-level C++ try or catch scope.
489
275k
  bool isFnTryCatchScope() const {
490
275k
    return getFlags() & ScopeFlags::FnTryCatchScope;
491
275k
  }
492
493
  /// Determine whether this scope is a SEH '__try' block.
494
73
  bool isSEHTryScope() const { return getFlags() & Scope::SEHTryScope; }
495
496
  /// Determine whether this scope is a SEH '__except' block.
497
62
  bool isSEHExceptScope() const { return getFlags() & Scope::SEHExceptScope; }
498
499
  /// Determine whether this scope is a compound statement scope.
500
456
  bool isCompoundStmtScope() const {
501
456
    return getFlags() & Scope::CompoundStmtScope;
502
456
  }
503
504
  /// Determine whether this scope is a controlling scope in a
505
  /// if/switch/while/for statement.
506
55.8k
  bool isControlScope() const { return getFlags() & Scope::ControlScope; }
507
508
  /// Returns if rhs has a higher scope depth than this.
509
  ///
510
  /// The caller is responsible for calling this only if one of the two scopes
511
  /// is an ancestor of the other.
512
32
  bool Contains(const Scope& rhs) const { return Depth < rhs.Depth; }
513
514
  /// containedInPrototypeScope - Return true if this or a parent scope
515
  /// is a FunctionPrototypeScope.
516
  bool containedInPrototypeScope() const;
517
518
1.96k
  void PushUsingDirective(UsingDirectiveDecl *UDir) {
519
1.96k
    UsingDirectives.push_back(UDir);
520
1.96k
  }
521
522
  using using_directives_range =
523
      llvm::iterator_range<UsingDirectivesTy::iterator>;
524
525
63.0M
  using_directives_range using_directives() {
526
63.0M
    return using_directives_range(UsingDirectives.begin(),
527
63.0M
                                  UsingDirectives.end());
528
63.0M
  }
529
530
93.9k
  void addNRVOCandidate(VarDecl *VD) {
531
93.9k
    if (NRVO.getInt())
532
2.59k
      return;
533
91.3k
    if (NRVO.getPointer() == nullptr) {
534
88.7k
      NRVO.setPointer(VD);
535
88.7k
      return;
536
88.7k
    }
537
2.62k
    if (NRVO.getPointer() != VD)
538
879
      setNoNRVO();
539
2.62k
  }
540
541
3.68M
  void setNoNRVO() {
542
3.68M
    NRVO.setInt(true);
543
3.68M
    NRVO.setPointer(nullptr);
544
3.68M
  }
545
546
  void mergeNRVOIntoParent();
547
548
  /// Init - This is used by the parser to implement scope caching.
549
  void Init(Scope *parent, unsigned flags);
550
551
  /// Sets up the specified scope flags and adjusts the scope state
552
  /// variables accordingly.
553
  void AddFlags(unsigned Flags);
554
555
  void dumpImpl(raw_ostream &OS) const;
556
  void dump() const;
557
};
558
559
} // namespace clang
560
561
#endif // LLVM_CLANG_SEMA_SCOPE_H