Coverage Report

Created: 2020-09-19 12:23

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