clang  9.0.0svn
DeclLookups.h
Go to the documentation of this file.
1 //===- DeclLookups.h - Low-level interface to all names in a DC -*- 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 DeclContext::all_lookups_iterator.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_CLANG_AST_DECLLOOKUPS_H
14 #define LLVM_CLANG_AST_DECLLOOKUPS_H
15 
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/DeclBase.h"
21 #include <cstddef>
22 #include <iterator>
23 
24 namespace clang {
25 
26 /// all_lookups_iterator - An iterator that provides a view over the results
27 /// of looking up every possible name.
29  StoredDeclsMap::iterator It, End;
30 
31 public:
35  using iterator_category = std::forward_iterator_tag;
37 
38  all_lookups_iterator() = default;
39  all_lookups_iterator(StoredDeclsMap::iterator It,
40  StoredDeclsMap::iterator End)
41  : It(It), End(End) {}
42 
43  DeclarationName getLookupName() const { return It->first; }
44 
45  reference operator*() const { return It->second.getLookupResult(); }
46  pointer operator->() const { return It->second.getLookupResult(); }
47 
49  // Filter out using directives. They don't belong as results from name
50  // lookup anyways, except as an implementation detail. Users of the API
51  // should not expect to get them (or worse, rely on it).
52  do {
53  ++It;
54  } while (It != End &&
56 
57  return *this;
58  }
59 
61  all_lookups_iterator tmp(*this);
62  ++(*this);
63  return tmp;
64  }
65 
67  return x.It == y.It;
68  }
69 
71  return x.It != y.It;
72  }
73 };
74 
76  DeclContext *Primary = const_cast<DeclContext*>(this)->getPrimaryContext();
77  if (Primary->hasExternalVisibleStorage())
79  if (StoredDeclsMap *Map = Primary->buildLookup())
80  return lookups_range(all_lookups_iterator(Map->begin(), Map->end()),
81  all_lookups_iterator(Map->end(), Map->end()));
82 
83  // Synthesize an empty range. This requires that two default constructed
84  // versions of these iterators form a valid empty range.
86 }
87 
89 DeclContext::noload_lookups(bool PreserveInternalState) const {
90  DeclContext *Primary = const_cast<DeclContext*>(this)->getPrimaryContext();
91  if (!PreserveInternalState)
92  Primary->loadLazyLocalLexicalLookups();
93  if (StoredDeclsMap *Map = Primary->getLookupPtr())
94  return lookups_range(all_lookups_iterator(Map->begin(), Map->end()),
95  all_lookups_iterator(Map->end(), Map->end()));
96 
97  // Synthesize an empty range. This requires that two default constructed
98  // versions of these iterators form a valid empty range.
100 }
101 
102 } // namespace clang
103 
104 #endif // LLVM_CLANG_AST_DECLLOOKUPS_H
Defines the clang::ASTContext interface.
std::forward_iterator_tag iterator_category
Definition: DeclLookups.h:35
friend bool operator!=(all_lookups_iterator x, all_lookups_iterator y)
Definition: DeclLookups.h:70
bool hasExternalVisibleStorage() const
Whether this DeclContext has external storage containing additional declarations that are visible in ...
Definition: DeclBase.h:2346
friend bool operator==(all_lookups_iterator x, all_lookups_iterator y)
Definition: DeclLookups.h:66
lookups_range noload_lookups(bool PreserveInternalState) const
Definition: DeclLookups.h:89
The results of name lookup within a DeclContext.
Definition: DeclBase.h:1195
DeclarationName getLookupName() const
Definition: DeclLookups.h:43
StoredDeclsMap * buildLookup()
Ensure the lookup structure is fully-built and return it.
Definition: DeclBase.cpp:1533
lookups_range lookups() const
Definition: DeclLookups.h:75
all_lookups_iterator & operator++()
Definition: DeclLookups.h:48
virtual void completeVisibleDeclsMap(const DeclContext *DC)
Ensures that the table of all visible declarations inside this context is up to date.
llvm::iterator_range< all_lookups_iterator > lookups_range
Definition: DeclBase.h:2270
StoredDeclsMap * getLookupPtr() const
Retrieve the internal representation of the lookup structure.
Definition: DeclBase.h:2327
all_lookups_iterator - An iterator that provides a view over the results of looking up every possible...
Definition: DeclLookups.h:28
__PTRDIFF_TYPE__ ptrdiff_t
A signed integer type that is the result of subtracting two pointers.
Definition: opencl-c.h:75
Dataflow Directional Tag Classes.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1271
The name of a declaration.
ExternalASTSource * getExternalSource() const
Retrieve a pointer to the external AST source associated with this AST context, if any...
Definition: ASTContext.h:1078
all_lookups_iterator operator++(int)
Definition: DeclLookups.h:60
all_lookups_iterator(StoredDeclsMap::iterator It, StoredDeclsMap::iterator End)
Definition: DeclLookups.h:39
DeclContextLookupResult lookup_result
Definition: DeclBase.h:2223
ASTContext & getParentASTContext() const
Definition: DeclBase.h:1799
DeclContext * getPrimaryContext()
getPrimaryContext - There may be many different declarations of the same entity (including forward de...
Definition: DeclBase.cpp:1158
static DeclarationName getUsingDirectiveName()
Returns the name for all C++ using-directives.