Coverage Report

Created: 2018-09-19 20:53

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/clang/include/clang/Sema/Lookup.h
Line
Count
Source (jump to first uncovered line)
1
//===- Lookup.h - Classes for name lookup -----------------------*- C++ -*-===//
2
//
3
//                     The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
//
10
// This file defines the LookupResult class, which is integral to
11
// Sema's name-lookup subsystem.
12
//
13
//===----------------------------------------------------------------------===//
14
15
#ifndef LLVM_CLANG_SEMA_LOOKUP_H
16
#define LLVM_CLANG_SEMA_LOOKUP_H
17
18
#include "clang/AST/Decl.h"
19
#include "clang/AST/DeclBase.h"
20
#include "clang/AST/DeclCXX.h"
21
#include "clang/AST/DeclarationName.h"
22
#include "clang/AST/Type.h"
23
#include "clang/AST/UnresolvedSet.h"
24
#include "clang/Basic/LLVM.h"
25
#include "clang/Basic/LangOptions.h"
26
#include "clang/Basic/SourceLocation.h"
27
#include "clang/Basic/Specifiers.h"
28
#include "clang/Sema/Sema.h"
29
#include "llvm/ADT/MapVector.h"
30
#include "llvm/ADT/Optional.h"
31
#include "llvm/ADT/STLExtras.h"
32
#include "llvm/Support/Casting.h"
33
#include <cassert>
34
#include <utility>
35
36
namespace clang {
37
38
class CXXBasePaths;
39
40
/// Represents the results of name lookup.
41
///
42
/// An instance of the LookupResult class captures the results of a
43
/// single name lookup, which can return no result (nothing found),
44
/// a single declaration, a set of overloaded functions, or an
45
/// ambiguity. Use the getKind() method to determine which of these
46
/// results occurred for a given lookup.
47
class LookupResult {
48
public:
49
  enum LookupResultKind {
50
    /// No entity found met the criteria.
51
    NotFound = 0,
52
53
    /// No entity found met the criteria within the current
54
    /// instantiation,, but there were dependent base classes of the
55
    /// current instantiation that could not be searched.
56
    NotFoundInCurrentInstantiation,
57
58
    /// Name lookup found a single declaration that met the
59
    /// criteria.  getFoundDecl() will return this declaration.
60
    Found,
61
62
    /// Name lookup found a set of overloaded functions that
63
    /// met the criteria.
64
    FoundOverloaded,
65
66
    /// Name lookup found an unresolvable value declaration
67
    /// and cannot yet complete.  This only happens in C++ dependent
68
    /// contexts with dependent using declarations.
69
    FoundUnresolvedValue,
70
71
    /// Name lookup results in an ambiguity; use
72
    /// getAmbiguityKind to figure out what kind of ambiguity
73
    /// we have.
74
    Ambiguous
75
  };
76
77
  enum AmbiguityKind {
78
    /// Name lookup results in an ambiguity because multiple
79
    /// entities that meet the lookup criteria were found in
80
    /// subobjects of different types. For example:
81
    /// @code
82
    /// struct A { void f(int); }
83
    /// struct B { void f(double); }
84
    /// struct C : A, B { };
85
    /// void test(C c) {
86
    ///   c.f(0); // error: A::f and B::f come from subobjects of different
87
    ///           // types. overload resolution is not performed.
88
    /// }
89
    /// @endcode
90
    AmbiguousBaseSubobjectTypes,
91
92
    /// Name lookup results in an ambiguity because multiple
93
    /// nonstatic entities that meet the lookup criteria were found
94
    /// in different subobjects of the same type. For example:
95
    /// @code
96
    /// struct A { int x; };
97
    /// struct B : A { };
98
    /// struct C : A { };
99
    /// struct D : B, C { };
100
    /// int test(D d) {
101
    ///   return d.x; // error: 'x' is found in two A subobjects (of B and C)
102
    /// }
103
    /// @endcode
104
    AmbiguousBaseSubobjects,
105
106
    /// Name lookup results in an ambiguity because multiple definitions
107
    /// of entity that meet the lookup criteria were found in different
108
    /// declaration contexts.
109
    /// @code
110
    /// namespace A {
111
    ///   int i;
112
    ///   namespace B { int i; }
113
    ///   int test() {
114
    ///     using namespace B;
115
    ///     return i; // error 'i' is found in namespace A and A::B
116
    ///    }
117
    /// }
118
    /// @endcode
119
    AmbiguousReference,
120
121
    /// Name lookup results in an ambiguity because an entity with a
122
    /// tag name was hidden by an entity with an ordinary name from
123
    /// a different context.
124
    /// @code
125
    /// namespace A { struct Foo {}; }
126
    /// namespace B { void Foo(); }
127
    /// namespace C {
128
    ///   using namespace A;
129
    ///   using namespace B;
130
    /// }
131
    /// void test() {
132
    ///   C::Foo(); // error: tag 'A::Foo' is hidden by an object in a
133
    ///             // different namespace
134
    /// }
135
    /// @endcode
136
    AmbiguousTagHiding
137
  };
138
139
  /// A little identifier for flagging temporary lookup results.
140
  enum TemporaryToken {
141
    Temporary
142
  };
143
144
  using iterator = UnresolvedSetImpl::iterator;
145
146
  LookupResult(Sema &SemaRef, const DeclarationNameInfo &NameInfo,
147
               Sema::LookupNameKind LookupKind,
148
               Sema::RedeclarationKind Redecl = Sema::NotForRedeclaration)
149
      : SemaPtr(&SemaRef), NameInfo(NameInfo), LookupKind(LookupKind),
150
        Redecl(Redecl != Sema::NotForRedeclaration),
151
        ExternalRedecl(Redecl == Sema::ForExternalRedeclaration),
152
20.9M
        Diagnose(Redecl == Sema::NotForRedeclaration) {
153
20.9M
    configure();
154
20.9M
  }
155
156
  // TODO: consider whether this constructor should be restricted to take
157
  // as input a const IdentifierInfo* (instead of Name),
158
  // forcing other cases towards the constructor taking a DNInfo.
159
  LookupResult(Sema &SemaRef, DeclarationName Name,
160
               SourceLocation NameLoc, Sema::LookupNameKind LookupKind,
161
               Sema::RedeclarationKind Redecl = Sema::NotForRedeclaration)
162
      : SemaPtr(&SemaRef), NameInfo(Name, NameLoc), LookupKind(LookupKind),
163
        Redecl(Redecl != Sema::NotForRedeclaration),
164
        ExternalRedecl(Redecl == Sema::ForExternalRedeclaration),
165
39.5M
        Diagnose(Redecl == Sema::NotForRedeclaration) {
166
39.5M
    configure();
167
39.5M
  }
168
169
  /// Creates a temporary lookup result, initializing its core data
170
  /// using the information from another result.  Diagnostics are always
171
  /// disabled.
172
  LookupResult(TemporaryToken _, const LookupResult &Other)
173
      : SemaPtr(Other.SemaPtr), NameInfo(Other.NameInfo),
174
        LookupKind(Other.LookupKind), IDNS(Other.IDNS), Redecl(Other.Redecl),
175
        ExternalRedecl(Other.ExternalRedecl), HideTags(Other.HideTags),
176
8.07k
        AllowHidden(Other.AllowHidden) {}
177
178
  // FIXME: Remove these deleted methods once the default build includes
179
  // -Wdeprecated.
180
  LookupResult(const LookupResult &) = delete;
181
  LookupResult &operator=(const LookupResult &) = delete;
182
183
  LookupResult(LookupResult &&Other)
184
      : ResultKind(std::move(Other.ResultKind)),
185
        Ambiguity(std::move(Other.Ambiguity)), Decls(std::move(Other.Decls)),
186
        Paths(std::move(Other.Paths)),
187
        NamingClass(std::move(Other.NamingClass)),
188
        BaseObjectType(std::move(Other.BaseObjectType)),
189
        SemaPtr(std::move(Other.SemaPtr)), NameInfo(std::move(Other.NameInfo)),
190
        NameContextRange(std::move(Other.NameContextRange)),
191
        LookupKind(std::move(Other.LookupKind)), IDNS(std::move(Other.IDNS)),
192
        Redecl(std::move(Other.Redecl)),
193
        ExternalRedecl(std::move(Other.ExternalRedecl)),
194
        HideTags(std::move(Other.HideTags)),
195
        Diagnose(std::move(Other.Diagnose)),
196
        AllowHidden(std::move(Other.AllowHidden)),
197
        Shadowed(std::move(Other.Shadowed)) {
198
    Other.Paths = nullptr;
199
    Other.Diagnose = false;
200
  }
201
202
  LookupResult &operator=(LookupResult &&Other) {
203
    ResultKind = std::move(Other.ResultKind);
204
    Ambiguity = std::move(Other.Ambiguity);
205
    Decls = std::move(Other.Decls);
206
    Paths = std::move(Other.Paths);
207
    NamingClass = std::move(Other.NamingClass);
208
    BaseObjectType = std::move(Other.BaseObjectType);
209
    SemaPtr = std::move(Other.SemaPtr);
210
    NameInfo = std::move(Other.NameInfo);
211
    NameContextRange = std::move(Other.NameContextRange);
212
    LookupKind = std::move(Other.LookupKind);
213
    IDNS = std::move(Other.IDNS);
214
    Redecl = std::move(Other.Redecl);
215
    ExternalRedecl = std::move(Other.ExternalRedecl);
216
    HideTags = std::move(Other.HideTags);
217
    Diagnose = std::move(Other.Diagnose);
218
    AllowHidden = std::move(Other.AllowHidden);
219
    Shadowed = std::move(Other.Shadowed);
220
    Other.Paths = nullptr;
221
    Other.Diagnose = false;
222
    return *this;
223
  }
224
225
60.4M
  ~LookupResult() {
226
60.4M
    if (Diagnose) 
diagnose()35.5M
;
227
60.4M
    if (Paths) 
deletePaths(Paths)0
;
228
60.4M
  }
229
230
  /// Gets the name info to look up.
231
15.6M
  const DeclarationNameInfo &getLookupNameInfo() const {
232
15.6M
    return NameInfo;
233
15.6M
  }
234
235
  /// Sets the name info to look up.
236
  void setLookupNameInfo(const DeclarationNameInfo &NameInfo) {
237
    this->NameInfo = NameInfo;
238
  }
239
240
  /// Gets the name to look up.
241
316M
  DeclarationName getLookupName() const {
242
316M
    return NameInfo.getName();
243
316M
  }
244
245
  /// Sets the name to look up.
246
2.31k
  void setLookupName(DeclarationName Name) {
247
2.31k
    NameInfo.setName(Name);
248
2.31k
  }
249
250
  /// Gets the kind of lookup to perform.
251
116M
  Sema::LookupNameKind getLookupKind() const {
252
116M
    return LookupKind;
253
116M
  }
254
255
  /// True if this lookup is just looking for an existing declaration.
256
125M
  bool isForRedeclaration() const {
257
125M
    return Redecl;
258
125M
  }
259
260
  /// True if this lookup is just looking for an existing declaration to link
261
  /// against a declaration with external linkage.
262
0
  bool isForExternalRedeclaration() const {
263
0
    return ExternalRedecl;
264
0
  }
265
266
162
  Sema::RedeclarationKind redeclarationKind() const {
267
162
    return ExternalRedecl ? 
Sema::ForExternalRedeclaration0
:
268
162
           Redecl ? 
Sema::ForVisibleRedeclaration0
: Sema::NotForRedeclaration;
269
162
  }
270
271
  /// Specify whether hidden declarations are visible, e.g.,
272
  /// for recovery reasons.
273
1.83k
  void setAllowHidden(bool AH) {
274
1.83k
    AllowHidden = AH;
275
1.83k
  }
276
277
  /// Determine whether this lookup is permitted to see hidden
278
  /// declarations, such as those in modules that have not yet been imported.
279
0
  bool isHiddenDeclarationVisible(NamedDecl *ND) const {
280
0
    return AllowHidden ||
281
0
           (isForExternalRedeclaration() && ND->isExternallyDeclarable());
282
0
  }
283
284
  /// Sets whether tag declarations should be hidden by non-tag
285
  /// declarations during resolution.  The default is true.
286
218k
  void setHideTags(bool Hide) {
287
218k
    HideTags = Hide;
288
218k
  }
289
290
55.5M
  bool isAmbiguous() const {
291
55.5M
    return getResultKind() == Ambiguous;
292
55.5M
  }
293
294
  /// Determines if this names a single result which is not an
295
  /// unresolved value using decl.  If so, it is safe to call
296
  /// getFoundDecl().
297
28.8M
  bool isSingleResult() const {
298
28.8M
    return getResultKind() == Found;
299
28.8M
  }
300
301
  /// Determines if the results are overloaded.
302
3.97M
  bool isOverloadedResult() const {
303
3.97M
    return getResultKind() == FoundOverloaded;
304
3.97M
  }
305
306
6.03M
  bool isUnresolvableResult() const {
307
6.03M
    return getResultKind() == FoundUnresolvedValue;
308
6.03M
  }
309
310
154M
  LookupResultKind getResultKind() const {
311
154M
    assert(sanity());
312
154M
    return ResultKind;
313
154M
  }
314
315
0
  AmbiguityKind getAmbiguityKind() const {
316
0
    assert(isAmbiguous());
317
0
    return Ambiguity;
318
0
  }
319
320
1.44k
  const UnresolvedSetImpl &asUnresolvedSet() const {
321
1.44k
    return Decls;
322
1.44k
  }
323
324
130M
  iterator begin() const { return iterator(Decls.begin()); }
325
43.6M
  iterator end() const { return iterator(Decls.end()); }
326
327
  /// Return true if no decls were found
328
96.3M
  bool empty() const { return Decls.empty(); }
329
330
  /// Return the base paths structure that's associated with
331
  /// these results, or null if none is.
332
0
  CXXBasePaths *getBasePaths() const {
333
0
    return Paths;
334
0
  }
335
336
  /// Determine whether the given declaration is visible to the
337
  /// program.
338
64.4M
  static bool isVisible(Sema &SemaRef, NamedDecl *D) {
339
64.4M
    // If this declaration is not hidden, it's visible.
340
64.4M
    if (!D->isHidden())
341
64.4M
      return true;
342
0
343
0
    // During template instantiation, we can refer to hidden declarations, if
344
0
    // they were visible in any module along the path of instantiation.
345
0
    return isVisibleSlow(SemaRef, D);
346
0
  }
347
348
  /// Retrieve the accepted (re)declaration of the given declaration,
349
  /// if there is one.
350
65.8M
  NamedDecl *getAcceptableDecl(NamedDecl *D) const {
351
65.8M
    if (!D->isInIdentifierNamespace(IDNS))
352
1.61M
      return nullptr;
353
64.2M
354
64.2M
    if (isVisible(getSema(), D) || 
isHiddenDeclarationVisible(D)0
)
355
64.2M
      return D;
356
0
357
0
    return getAcceptableDeclSlow(D);
358
0
  }
359
360
private:
361
  static bool isVisibleSlow(Sema &SemaRef, NamedDecl *D);
362
  NamedDecl *getAcceptableDeclSlow(NamedDecl *D) const;
363
364
public:
365
  /// Returns the identifier namespace mask for this lookup.
366
101M
  unsigned getIdentifierNamespace() const {
367
101M
    return IDNS;
368
101M
  }
369
370
  /// Returns whether these results arose from performing a
371
  /// lookup into a class.
372
35.5M
  bool isClassLookup() const {
373
35.5M
    return NamingClass != nullptr;
374
35.5M
  }
375
376
  /// Returns the 'naming class' for this lookup, i.e. the
377
  /// class which was looked into to find these results.
378
  ///
379
  /// C++0x [class.access.base]p5:
380
  ///   The access to a member is affected by the class in which the
381
  ///   member is named. This naming class is the class in which the
382
  ///   member name was looked up and found. [Note: this class can be
383
  ///   explicit, e.g., when a qualified-id is used, or implicit,
384
  ///   e.g., when a class member access operator (5.2.5) is used
385
  ///   (including cases where an implicit "this->" is added). If both
386
  ///   a class member access operator and a qualified-id are used to
387
  ///   name the member (as in p->T::m), the class naming the member
388
  ///   is the class named by the nested-name-specifier of the
389
  ///   qualified-id (that is, T). -- end note ]
390
  ///
391
  /// This is set by the lookup routines when they find results in a class.
392
6.22M
  CXXRecordDecl *getNamingClass() const {
393
6.22M
    return NamingClass;
394
6.22M
  }
395
396
  /// Sets the 'naming class' for this lookup.
397
8.94M
  void setNamingClass(CXXRecordDecl *Record) {
398
8.94M
    NamingClass = Record;
399
8.94M
  }
400
401
  /// Returns the base object type associated with this lookup;
402
  /// important for [class.protected].  Most lookups do not have an
403
  /// associated base object.
404
1.65M
  QualType getBaseObjectType() const {
405
1.65M
    return BaseObjectType;
406
1.65M
  }
407
408
  /// Sets the base object type for this lookup.
409
2.93M
  void setBaseObjectType(QualType T) {
410
2.93M
    BaseObjectType = T;
411
2.93M
  }
412
413
  /// Add a declaration to these results with its natural access.
414
  /// Does not test the acceptance criteria.
415
67.0M
  void addDecl(NamedDecl *D) {
416
67.0M
    addDecl(D, D->getAccess());
417
67.0M
  }
418
419
  /// Add a declaration to these results with the given access.
420
  /// Does not test the acceptance criteria.
421
68.0M
  void addDecl(NamedDecl *D, AccessSpecifier AS) {
422
68.0M
    Decls.addDecl(D, AS);
423
68.0M
    ResultKind = Found;
424
68.0M
  }
425
426
  /// Add all the declarations from another set of lookup
427
  /// results.
428
13
  void addAllDecls(const LookupResult &Other) {
429
13
    Decls.append(Other.Decls.begin(), Other.Decls.end());
430
13
    ResultKind = Found;
431
13
  }
432
433
  /// Determine whether no result was found because we could not
434
  /// search into dependent base classes of the current instantiation.
435
3.47M
  bool wasNotFoundInCurrentInstantiation() const {
436
3.47M
    return ResultKind == NotFoundInCurrentInstantiation;
437
3.47M
  }
438
439
  /// Note that while no result was found in the current instantiation,
440
  /// there were dependent base classes that could not be searched.
441
9.59k
  void setNotFoundInCurrentInstantiation() {
442
9.59k
    assert(ResultKind == NotFound && Decls.empty());
443
9.59k
    ResultKind = NotFoundInCurrentInstantiation;
444
9.59k
  }
445
446
  /// Determine whether the lookup result was shadowed by some other
447
  /// declaration that lookup ignored.
448
980k
  bool isShadowed() const { return Shadowed; }
449
450
  /// Note that we found and ignored a declaration while performing
451
  /// lookup.
452
10
  void setShadowed() { Shadowed = true; }
453
454
  /// Resolves the result kind of the lookup, possibly hiding
455
  /// decls.
456
  ///
457
  /// This should be called in any environment where lookup might
458
  /// generate multiple lookup results.
459
  void resolveKind();
460
461
  /// Re-resolves the result kind of the lookup after a set of
462
  /// removals has been performed.
463
790k
  void resolveKindAfterFilter() {
464
790k
    if (Decls.empty()) {
465
710k
      if (ResultKind != NotFoundInCurrentInstantiation)
466
710k
        ResultKind = NotFound;
467
710k
468
710k
      if (Paths) {
469
0
        deletePaths(Paths);
470
0
        Paths = nullptr;
471
0
      }
472
710k
    } else {
473
80.2k
      llvm::Optional<AmbiguityKind> SavedAK;
474
80.2k
      bool WasAmbiguous = false;
475
80.2k
      if (ResultKind == Ambiguous) {
476
1
        SavedAK = Ambiguity;
477
1
        WasAmbiguous = true;
478
1
      }
479
80.2k
      ResultKind = Found;
480
80.2k
      resolveKind();
481
80.2k
482
80.2k
      // If we didn't make the lookup unambiguous, restore the old
483
80.2k
      // ambiguity kind.
484
80.2k
      if (ResultKind == Ambiguous) {
485
0
        (void)WasAmbiguous;
486
0
        assert(WasAmbiguous);
487
0
        Ambiguity = SavedAK.getValue();
488
80.2k
      } else if (Paths) {
489
0
        deletePaths(Paths);
490
0
        Paths = nullptr;
491
0
      }
492
80.2k
    }
493
790k
  }
494
495
  template <class DeclClass>
496
15.8M
  DeclClass *getAsSingle() const {
497
15.8M
    if (getResultKind() != Found) 
return nullptr3.33M
;
498
12.5M
    return dyn_cast<DeclClass>(getFoundDecl());
499
12.5M
  }
clang::VarDecl* clang::LookupResult::getAsSingle<clang::VarDecl>() const
Line
Count
Source
496
38
  DeclClass *getAsSingle() const {
497
38
    if (getResultKind() != Found) 
return nullptr0
;
498
38
    return dyn_cast<DeclClass>(getFoundDecl());
499
38
  }
clang::NamespaceDecl* clang::LookupResult::getAsSingle<clang::NamespaceDecl>() const
Line
Count
Source
496
131k
  DeclClass *getAsSingle() const {
497
131k
    if (getResultKind() != Found) 
return nullptr14.3k
;
498
117k
    return dyn_cast<DeclClass>(getFoundDecl());
499
117k
  }
clang::NamedDecl* clang::LookupResult::getAsSingle<clang::NamedDecl>() const
Line
Count
Source
496
2.53M
  DeclClass *getAsSingle() const {
497
2.53M
    if (getResultKind() != Found) 
return nullptr2.48M
;
498
47.0k
    return dyn_cast<DeclClass>(getFoundDecl());
499
47.0k
  }
clang::TypeDecl* clang::LookupResult::getAsSingle<clang::TypeDecl>() const
Line
Count
Source
496
923k
  DeclClass *getAsSingle() const {
497
923k
    if (getResultKind() != Found) 
return nullptr593
;
498
922k
    return dyn_cast<DeclClass>(getFoundDecl());
499
922k
  }
clang::FunctionDecl* clang::LookupResult::getAsSingle<clang::FunctionDecl>() const
Line
Count
Source
496
348
  DeclClass *getAsSingle() const {
497
348
    if (getResultKind() != Found) 
return nullptr0
;
498
348
    return dyn_cast<DeclClass>(getFoundDecl());
499
348
  }
clang::ClassTemplateDecl* clang::LookupResult::getAsSingle<clang::ClassTemplateDecl>() const
Line
Count
Source
496
22.5k
  DeclClass *getAsSingle() const {
497
22.5k
    if (getResultKind() != Found) 
return nullptr16.9k
;
498
5.59k
    return dyn_cast<DeclClass>(getFoundDecl());
499
5.59k
  }
clang::TagDecl* clang::LookupResult::getAsSingle<clang::TagDecl>() const
Line
Count
Source
496
3
  DeclClass *getAsSingle() const {
497
3
    if (getResultKind() != Found) return nullptr;
498
0
    return dyn_cast<DeclClass>(getFoundDecl());
499
0
  }
Unexecuted instantiation: clang::ObjCIvarDecl* clang::LookupResult::getAsSingle<clang::ObjCIvarDecl>() const
clang::EnumConstantDecl* clang::LookupResult::getAsSingle<clang::EnumConstantDecl>() const
Line
Count
Source
496
109k
  DeclClass *getAsSingle() const {
497
109k
    if (getResultKind() != Found) 
return nullptr14.3k
;
498
94.7k
    return dyn_cast<DeclClass>(getFoundDecl());
499
94.7k
  }
Unexecuted instantiation: clang::TypeAliasTemplateDecl* clang::LookupResult::getAsSingle<clang::TypeAliasTemplateDecl>() const
clang::FunctionTemplateDecl* clang::LookupResult::getAsSingle<clang::FunctionTemplateDecl>() const
Line
Count
Source
496
11.3M
  DeclClass *getAsSingle() const {
497
11.3M
    if (getResultKind() != Found) 
return nullptr0
;
498
11.3M
    return dyn_cast<DeclClass>(getFoundDecl());
499
11.3M
  }
clang::FieldDecl* clang::LookupResult::getAsSingle<clang::FieldDecl>() const
Line
Count
Source
496
3.98k
  DeclClass *getAsSingle() const {
497
3.98k
    if (getResultKind() != Found) 
return nullptr0
;
498
3.98k
    return dyn_cast<DeclClass>(getFoundDecl());
499
3.98k
  }
Unexecuted instantiation: clang::IndirectFieldDecl* clang::LookupResult::getAsSingle<clang::IndirectFieldDecl>() const
clang::RecordDecl* clang::LookupResult::getAsSingle<clang::RecordDecl>() const
Line
Count
Source
496
294
  DeclClass *getAsSingle() const {
497
294
    if (getResultKind() != Found) 
return nullptr0
;
498
294
    return dyn_cast<DeclClass>(getFoundDecl());
499
294
  }
clang::TemplateDecl* clang::LookupResult::getAsSingle<clang::TemplateDecl>() const
Line
Count
Source
496
403k
  DeclClass *getAsSingle() const {
497
403k
    if (getResultKind() != Found) return nullptr;
498
0
    return dyn_cast<DeclClass>(getFoundDecl());
499
0
  }
clang::VarTemplateDecl* clang::LookupResult::getAsSingle<clang::VarTemplateDecl>() const
Line
Count
Source
496
403k
  DeclClass *getAsSingle() const {
497
403k
    if (getResultKind() != Found) return nullptr;
498
0
    return dyn_cast<DeclClass>(getFoundDecl());
499
0
  }
500
501
  /// Fetch the unique decl found by this lookup.  Asserts
502
  /// that one was found.
503
  ///
504
  /// This is intended for users who have examined the result kind
505
  /// and are certain that there is only one result.
506
52.3M
  NamedDecl *getFoundDecl() const {
507
52.3M
    assert(getResultKind() == Found
508
52.3M
           && "getFoundDecl called on non-unique result");
509
52.3M
    return (*begin())->getUnderlyingDecl();
510
52.3M
  }
511
512
  /// Fetches a representative decl.  Useful for lazy diagnostics.
513
18.2M
  NamedDecl *getRepresentativeDecl() const {
514
18.2M
    assert(!Decls.empty() && "cannot get representative of empty set");
515
18.2M
    return *begin();
516
18.2M
  }
517
518
  /// Asks if the result is a single tag decl.
519
8.84M
  bool isSingleTagDecl() const {
520
8.84M
    return getResultKind() == Found && 
isa<TagDecl>(getFoundDecl())907k
;
521
8.84M
  }
522
523
  /// Make these results show that the name was found in
524
  /// base classes of different types.
525
  ///
526
  /// The given paths object is copied and invalidated.
527
  void setAmbiguousBaseSubobjectTypes(CXXBasePaths &P);
528
529
  /// Make these results show that the name was found in
530
  /// distinct base classes of the same type.
531
  ///
532
  /// The given paths object is copied and invalidated.
533
  void setAmbiguousBaseSubobjects(CXXBasePaths &P);
534
535
  /// Make these results show that the name was found in
536
  /// different contexts and a tag decl was hidden by an ordinary
537
  /// decl in a different context.
538
0
  void setAmbiguousQualifiedTagHiding() {
539
0
    setAmbiguous(AmbiguousTagHiding);
540
0
  }
541
542
  /// Clears out any current state.
543
662k
  void clear() {
544
662k
    ResultKind = NotFound;
545
662k
    Decls.clear();
546
662k
    if (Paths) 
deletePaths(Paths)0
;
547
662k
    Paths = nullptr;
548
662k
    NamingClass = nullptr;
549
662k
    Shadowed = false;
550
662k
  }
551
552
  /// Clears out any current state and re-initializes for a
553
  /// different kind of lookup.
554
3.33k
  void clear(Sema::LookupNameKind Kind) {
555
3.33k
    clear();
556
3.33k
    LookupKind = Kind;
557
3.33k
    configure();
558
3.33k
  }
559
560
  /// Change this lookup's redeclaration kind.
561
18.8k
  void setRedeclarationKind(Sema::RedeclarationKind RK) {
562
18.8k
    Redecl = (RK != Sema::NotForRedeclaration);
563
18.8k
    ExternalRedecl = (RK == Sema::ForExternalRedeclaration);
564
18.8k
    configure();
565
18.8k
  }
566
567
  void dump();
568
  void print(raw_ostream &);
569
570
  /// Suppress the diagnostics that would normally fire because of this
571
  /// lookup.  This happens during (e.g.) redeclaration lookups.
572
7.21M
  void suppressDiagnostics() {
573
7.21M
    Diagnose = false;
574
7.21M
  }
575
576
  /// Determines whether this lookup is suppressing diagnostics.
577
0
  bool isSuppressingDiagnostics() const {
578
0
    return !Diagnose;
579
0
  }
580
581
  /// Sets a 'context' source range.
582
928k
  void setContextRange(SourceRange SR) {
583
928k
    NameContextRange = SR;
584
928k
  }
585
586
  /// Gets the source range of the context of this name; for C++
587
  /// qualified lookups, this is the source range of the scope
588
  /// specifier.
589
0
  SourceRange getContextRange() const {
590
0
    return NameContextRange;
591
0
  }
592
593
  /// Gets the location of the identifier.  This isn't always defined:
594
  /// sometimes we're doing lookups on synthesized names.
595
69.8M
  SourceLocation getNameLoc() const {
596
69.8M
    return NameInfo.getLoc();
597
69.8M
  }
598
599
  /// Get the Sema object that this lookup result is searching
600
  /// with.
601
158M
  Sema &getSema() const { return *SemaPtr; }
602
603
  /// A class for iterating through a result set and possibly
604
  /// filtering out results.  The results returned are possibly
605
  /// sugared.
606
  class Filter {
607
    friend class LookupResult;
608
609
    LookupResult &Results;
610
    LookupResult::iterator I;
611
    bool Changed = false;
612
    bool CalledDone = false;
613
614
11.5M
    Filter(LookupResult &Results) : Results(Results), I(Results.begin()) {}
615
616
  public:
617
    Filter(Filter &&F)
618
        : Results(F.Results), I(F.I), Changed(F.Changed),
619
          CalledDone(F.CalledDone) {
620
      F.CalledDone = true;
621
    }
622
623
11.5M
    ~Filter() {
624
11.5M
      assert(CalledDone &&
625
11.5M
             "LookupResult::Filter destroyed without done() call");
626
11.5M
    }
627
628
20.9M
    bool hasNext() const {
629
20.9M
      return I != Results.end();
630
20.9M
    }
631
632
9.36M
    NamedDecl *next() {
633
9.36M
      assert(I != Results.end() && "next() called on empty filter");
634
9.36M
      return *I++;
635
9.36M
    }
636
637
    /// Restart the iteration.
638
0
    void restart() {
639
0
      I = Results.begin();
640
0
    }
641
642
    /// Erase the last element returned from this iterator.
643
987k
    void erase() {
644
987k
      Results.Decls.erase(--I);
645
987k
      Changed = true;
646
987k
    }
647
648
    /// Replaces the current entry with the given one, preserving the
649
    /// access bits.
650
0
    void replace(NamedDecl *D) {
651
0
      Results.Decls.replace(I-1, D);
652
0
      Changed = true;
653
0
    }
654
655
    /// Replaces the current entry with the given one.
656
78.0k
    void replace(NamedDecl *D, AccessSpecifier AS) {
657
78.0k
      Results.Decls.replace(I-1, D, AS);
658
78.0k
      Changed = true;
659
78.0k
    }
660
661
11.5M
    void done() {
662
11.5M
      assert(!CalledDone && "done() called twice");
663
11.5M
      CalledDone = true;
664
11.5M
665
11.5M
      if (Changed)
666
790k
        Results.resolveKindAfterFilter();
667
11.5M
    }
668
  };
669
670
  /// Create a filter for this result set.
671
11.5M
  Filter makeFilter() {
672
11.5M
    return Filter(*this);
673
11.5M
  }
674
675
113M
  void setFindLocalExtern(bool FindLocalExtern) {
676
113M
    if (FindLocalExtern)
677
62.1M
      IDNS |= Decl::IDNS_LocalExtern;
678
51.0M
    else
679
51.0M
      IDNS &= ~Decl::IDNS_LocalExtern;
680
113M
  }
681
682
private:
683
35.5M
  void diagnose() {
684
35.5M
    if (isAmbiguous())
685
0
      getSema().DiagnoseAmbiguousLookup(*this);
686
35.5M
    else if (isClassLookup() && 
getSema().getLangOpts().AccessControl6.57M
)
687
6.57M
      getSema().CheckLookupAccess(*this);
688
35.5M
  }
689
690
2.59k
  void setAmbiguous(AmbiguityKind AK) {
691
2.59k
    ResultKind = Ambiguous;
692
2.59k
    Ambiguity = AK;
693
2.59k
  }
694
695
  void addDeclsFromBasePaths(const CXXBasePaths &P);
696
  void configure();
697
698
  // Sanity checks.
699
  bool sanity() const;
700
701
  bool sanityCheckUnresolved() const {
702
    for (iterator I = begin(), E = end(); I != E; ++I)
703
      if (isa<UnresolvedUsingValueDecl>((*I)->getUnderlyingDecl()))
704
        return true;
705
    return false;
706
  }
707
708
  static void deletePaths(CXXBasePaths *);
709
710
  // Results.
711
  LookupResultKind ResultKind = NotFound;
712
  AmbiguityKind Ambiguity; // ill-defined unless ambiguous
713
  UnresolvedSet<8> Decls;
714
  CXXBasePaths *Paths = nullptr;
715
  CXXRecordDecl *NamingClass = nullptr;
716
  QualType BaseObjectType;
717
718
  // Parameters.
719
  Sema *SemaPtr;
720
  DeclarationNameInfo NameInfo;
721
  SourceRange NameContextRange;
722
  Sema::LookupNameKind LookupKind;
723
  unsigned IDNS = 0; // set by configure()
724
725
  bool Redecl;
726
  bool ExternalRedecl;
727
728
  /// True if tag declarations should be hidden if non-tags
729
  ///   are present
730
  bool HideTags = true;
731
732
  bool Diagnose = false;
733
734
  /// True if we should allow hidden declarations to be 'visible'.
735
  bool AllowHidden = false;
736
737
  /// True if the found declarations were shadowed by some other
738
  /// declaration that we skipped. This only happens when \c LookupKind
739
  /// is \c LookupRedeclarationWithLinkage.
740
  bool Shadowed = false;
741
};
742
743
/// Consumes visible declarations found when searching for
744
/// all visible names within a given scope or context.
745
///
746
/// This abstract class is meant to be subclassed by clients of \c
747
/// Sema::LookupVisibleDecls(), each of which should override the \c
748
/// FoundDecl() function to process declarations as they are found.
749
class VisibleDeclConsumer {
750
public:
751
  /// Destroys the visible declaration consumer.
752
  virtual ~VisibleDeclConsumer();
753
754
  /// Determine whether hidden declarations (from unimported
755
  /// modules) should be given to this consumer. By default, they
756
  /// are not included.
757
  virtual bool includeHiddenDecls() const;
758
759
  /// Invoked each time \p Sema::LookupVisibleDecls() finds a
760
  /// declaration visible from the current scope or context.
761
  ///
762
  /// \param ND the declaration found.
763
  ///
764
  /// \param Hiding a declaration that hides the declaration \p ND,
765
  /// or NULL if no such declaration exists.
766
  ///
767
  /// \param Ctx the original context from which the lookup started.
768
  ///
769
  /// \param InBaseClass whether this declaration was found in base
770
  /// class of the context we searched.
771
  virtual void FoundDecl(NamedDecl *ND, NamedDecl *Hiding, DeclContext *Ctx,
772
                         bool InBaseClass) = 0;
773
774
  /// Callback to inform the client that Sema entered into a new context
775
  /// to find a visible declaration.
776
  //
777
  /// \param Ctx the context which Sema entered.
778
1
  virtual void EnteredContext(DeclContext *Ctx) {}
779
};
780
781
/// A class for storing results from argument-dependent lookup.
782
class ADLResult {
783
private:
784
  /// A map from canonical decls to the 'most recent' decl.
785
  llvm::MapVector<NamedDecl*, NamedDecl*> Decls;
786
787
  struct select_second {
788
2.77M
    NamedDecl *operator()(std::pair<NamedDecl*, NamedDecl*> P) const {
789
2.77M
      return P.second;
790
2.77M
    }
791
  };
792
793
public:
794
  /// Adds a new ADL candidate to this map.
795
  void insert(NamedDecl *D);
796
797
  /// Removes any data associated with a given decl.
798
1.50M
  void erase(NamedDecl *D) {
799
1.50M
    Decls.erase(cast<NamedDecl>(D->getCanonicalDecl()));
800
1.50M
  }
801
802
  using iterator =
803
      llvm::mapped_iterator<decltype(Decls)::iterator, select_second>;
804
805
729k
  iterator begin() { return iterator(Decls.begin(), select_second()); }
806
729k
  iterator end() { return iterator(Decls.end(), select_second()); }
807
};
808
809
} // namespace clang
810
811
#endif // LLVM_CLANG_SEMA_LOOKUP_H