1 //===--- MultiplexExternalSemaSource.h - External Sema Interface-*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines ExternalSemaSource interface, dispatching to all clients
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_CLANG_SEMA_MULTIPLEXEXTERNALSEMASOURCE_H
14 #define LLVM_CLANG_SEMA_MULTIPLEXEXTERNALSEMASOURCE_H
16 #include "clang/Sema/ExternalSemaSource.h"
17 #include "clang/Sema/Weak.h"
18 #include "llvm/ADT/SmallVector.h"
23 class CXXConstructorDecl;
26 struct ExternalVTableUse;
31 class TypedefNameDecl;
36 /// \brief An abstract interface that should be implemented by
37 /// external AST sources that also provide information for semantic
39 class MultiplexExternalSemaSource : public ExternalSemaSource {
42 SmallVector<ExternalSemaSource *, 2> Sources; // doesn't own them.
46 ///\brief Constructs a new multiplexing external sema source and appends the
47 /// given element to it.
49 ///\param[in] s1 - A non-null (old) ExternalSemaSource.
50 ///\param[in] s2 - A non-null (new) ExternalSemaSource.
52 MultiplexExternalSemaSource(ExternalSemaSource& s1, ExternalSemaSource& s2);
54 ~MultiplexExternalSemaSource() override;
56 ///\brief Appends new source to the source list.
58 ///\param[in] source - An ExternalSemaSource.
60 void addSource(ExternalSemaSource &source);
62 //===--------------------------------------------------------------------===//
64 //===--------------------------------------------------------------------===//
66 /// \brief Resolve a declaration ID into a declaration, potentially
67 /// building a new declaration.
68 Decl *GetExternalDecl(uint32_t ID) override;
70 /// \brief Complete the redeclaration chain if it's been extended since the
71 /// previous generation of the AST source.
72 void CompleteRedeclChain(const Decl *D) override;
74 /// \brief Resolve a selector ID into a selector.
75 Selector GetExternalSelector(uint32_t ID) override;
77 /// \brief Returns the number of selectors known to the external AST
79 uint32_t GetNumExternalSelectors() override;
81 /// \brief Resolve the offset of a statement in the decl stream into
83 Stmt *GetExternalDeclStmt(uint64_t Offset) override;
85 /// \brief Resolve the offset of a set of C++ base specifiers in the decl
86 /// stream into an array of specifiers.
87 CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
89 /// \brief Resolve a handle to a list of ctor initializers into the list of
90 /// initializers themselves.
91 CXXCtorInitializer **GetExternalCXXCtorInitializers(uint64_t Offset) override;
93 /// \brief Find all declarations with the given name in the
95 bool FindExternalVisibleDeclsByName(const DeclContext *DC,
96 DeclarationName Name) override;
98 /// \brief Ensures that the table of all visible declarations inside this
99 /// context is up to date.
100 void completeVisibleDeclsMap(const DeclContext *DC) override;
102 /// \brief Finds all declarations lexically contained within the given
103 /// DeclContext, after applying an optional filter predicate.
105 /// \param IsKindWeWant a predicate function that returns true if the passed
106 /// declaration kind is one we are looking for.
108 FindExternalLexicalDecls(const DeclContext *DC,
109 llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
110 SmallVectorImpl<Decl *> &Result) override;
112 /// \brief Get the decls that are contained in a file in the Offset/Length
113 /// range. \p Length can be 0 to indicate a point at \p Offset instead of
115 void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length,
116 SmallVectorImpl<Decl *> &Decls) override;
118 /// \brief Gives the external AST source an opportunity to complete
119 /// an incomplete type.
120 void CompleteType(TagDecl *Tag) override;
122 /// \brief Gives the external AST source an opportunity to complete an
123 /// incomplete Objective-C class.
125 /// This routine will only be invoked if the "externally completed" bit is
126 /// set on the ObjCInterfaceDecl via the function
127 /// \c ObjCInterfaceDecl::setExternallyCompleted().
128 void CompleteType(ObjCInterfaceDecl *Class) override;
130 /// \brief Loads comment ranges.
131 void ReadComments() override;
133 /// \brief Notify ExternalASTSource that we started deserialization of
134 /// a decl or type so until FinishedDeserializing is called there may be
135 /// decls that are initializing. Must be paired with FinishedDeserializing.
136 void StartedDeserializing() override;
138 /// \brief Notify ExternalASTSource that we finished the deserialization of
139 /// a decl or type. Must be paired with StartedDeserializing.
140 void FinishedDeserializing() override;
142 /// \brief Function that will be invoked when we begin parsing a new
143 /// translation unit involving this external AST source.
144 void StartTranslationUnit(ASTConsumer *Consumer) override;
146 /// \brief Print any statistics that have been gathered regarding
147 /// the external AST source.
148 void PrintStats() override;
151 /// \brief Perform layout on the given record.
153 /// This routine allows the external AST source to provide an specific
154 /// layout for a record, overriding the layout that would normally be
155 /// constructed. It is intended for clients who receive specific layout
156 /// details rather than source code (such as LLDB). The client is expected
157 /// to fill in the field offsets, base offsets, virtual base offsets, and
158 /// complete object size.
160 /// \param Record The record whose layout is being requested.
162 /// \param Size The final size of the record, in bits.
164 /// \param Alignment The final alignment of the record, in bits.
166 /// \param FieldOffsets The offset of each of the fields within the record,
167 /// expressed in bits. All of the fields must be provided with offsets.
169 /// \param BaseOffsets The offset of each of the direct, non-virtual base
170 /// classes. If any bases are not given offsets, the bases will be laid
171 /// out according to the ABI.
173 /// \param VirtualBaseOffsets The offset of each of the virtual base classes
174 /// (either direct or not). If any bases are not given offsets, the bases will
175 /// be laid out according to the ABI.
177 /// \returns true if the record layout was provided, false otherwise.
179 layoutRecordType(const RecordDecl *Record,
180 uint64_t &Size, uint64_t &Alignment,
181 llvm::DenseMap<const FieldDecl *, uint64_t> &FieldOffsets,
182 llvm::DenseMap<const CXXRecordDecl *, CharUnits> &BaseOffsets,
183 llvm::DenseMap<const CXXRecordDecl *,
184 CharUnits> &VirtualBaseOffsets) override;
186 /// Return the amount of memory used by memory buffers, breaking down
187 /// by heap-backed versus mmap'ed memory.
188 void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
190 //===--------------------------------------------------------------------===//
191 // ExternalSemaSource.
192 //===--------------------------------------------------------------------===//
194 /// \brief Initialize the semantic source with the Sema instance
195 /// being used to perform semantic analysis on the abstract syntax
197 void InitializeSema(Sema &S) override;
199 /// \brief Inform the semantic consumer that Sema is no longer available.
200 void ForgetSema() override;
202 /// \brief Load the contents of the global method pool for a given
204 void ReadMethodPool(Selector Sel) override;
206 /// Load the contents of the global method pool for a given
207 /// selector if necessary.
208 void updateOutOfDateSelector(Selector Sel) override;
210 /// \brief Load the set of namespaces that are known to the external source,
211 /// which will be used during typo correction.
213 ReadKnownNamespaces(SmallVectorImpl<NamespaceDecl*> &Namespaces) override;
215 /// \brief Load the set of used but not defined functions or variables with
216 /// internal linkage, or used but not defined inline functions.
217 void ReadUndefinedButUsed(
218 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override;
220 void ReadMismatchingDeleteExpressions(llvm::MapVector<
221 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
224 /// \brief Do last resort, unqualified lookup on a LookupResult that
225 /// Sema cannot find.
227 /// \param R a LookupResult that is being recovered.
229 /// \param S the Scope of the identifier occurrence.
231 /// \return true to tell Sema to recover using the LookupResult.
232 bool LookupUnqualified(LookupResult &R, Scope *S) override;
234 /// \brief Read the set of tentative definitions known to the external Sema
237 /// The external source should append its own tentative definitions to the
238 /// given vector of tentative definitions. Note that this routine may be
239 /// invoked multiple times; the external source should take care not to
240 /// introduce the same declarations repeatedly.
241 void ReadTentativeDefinitions(SmallVectorImpl<VarDecl*> &Defs) override;
243 /// \brief Read the set of unused file-scope declarations known to the
244 /// external Sema source.
246 /// The external source should append its own unused, filed-scope to the
247 /// given vector of declarations. Note that this routine may be
248 /// invoked multiple times; the external source should take care not to
249 /// introduce the same declarations repeatedly.
250 void ReadUnusedFileScopedDecls(
251 SmallVectorImpl<const DeclaratorDecl*> &Decls) override;
253 /// \brief Read the set of delegating constructors known to the
254 /// external Sema source.
256 /// The external source should append its own delegating constructors to the
257 /// given vector of declarations. Note that this routine may be
258 /// invoked multiple times; the external source should take care not to
259 /// introduce the same declarations repeatedly.
260 void ReadDelegatingConstructors(
261 SmallVectorImpl<CXXConstructorDecl*> &Decls) override;
263 /// \brief Read the set of ext_vector type declarations known to the
264 /// external Sema source.
266 /// The external source should append its own ext_vector type declarations to
267 /// the given vector of declarations. Note that this routine may be
268 /// invoked multiple times; the external source should take care not to
269 /// introduce the same declarations repeatedly.
270 void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl*> &Decls) override;
272 /// \brief Read the set of potentially unused typedefs known to the source.
274 /// The external source should append its own potentially unused local
275 /// typedefs to the given vector of declarations. Note that this routine may
276 /// be invoked multiple times; the external source should take care not to
277 /// introduce the same declarations repeatedly.
278 void ReadUnusedLocalTypedefNameCandidates(
279 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) override;
281 /// \brief Read the set of referenced selectors known to the
282 /// external Sema source.
284 /// The external source should append its own referenced selectors to the
285 /// given vector of selectors. Note that this routine
286 /// may be invoked multiple times; the external source should take care not
287 /// to introduce the same selectors repeatedly.
288 void ReadReferencedSelectors(SmallVectorImpl<std::pair<Selector,
289 SourceLocation> > &Sels) override;
291 /// \brief Read the set of weak, undeclared identifiers known to the
292 /// external Sema source.
294 /// The external source should append its own weak, undeclared identifiers to
295 /// the given vector. Note that this routine may be invoked multiple times;
296 /// the external source should take care not to introduce the same identifiers
298 void ReadWeakUndeclaredIdentifiers(
299 SmallVectorImpl<std::pair<IdentifierInfo*, WeakInfo> > &WI) override;
301 /// \brief Read the set of used vtables known to the external Sema source.
303 /// The external source should append its own used vtables to the given
304 /// vector. Note that this routine may be invoked multiple times; the external
305 /// source should take care not to introduce the same vtables repeatedly.
306 void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override;
308 /// \brief Read the set of pending instantiations known to the external
311 /// The external source should append its own pending instantiations to the
312 /// given vector. Note that this routine may be invoked multiple times; the
313 /// external source should take care not to introduce the same instantiations
315 void ReadPendingInstantiations(
316 SmallVectorImpl<std::pair<ValueDecl*, SourceLocation> >& Pending) override;
318 /// \brief Read the set of late parsed template functions for this source.
320 /// The external source should insert its own late parsed template functions
321 /// into the map. Note that this routine may be invoked multiple times; the
322 /// external source should take care not to introduce the same map entries
324 void ReadLateParsedTemplates(
325 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
328 /// \copydoc ExternalSemaSource::CorrectTypo
329 /// \note Returns the first nonempty correction.
330 TypoCorrection CorrectTypo(const DeclarationNameInfo &Typo,
331 int LookupKind, Scope *S, CXXScopeSpec *SS,
332 CorrectionCandidateCallback &CCC,
333 DeclContext *MemberContext,
334 bool EnteringContext,
335 const ObjCObjectPointerType *OPT) override;
337 /// \brief Produces a diagnostic note if one of the attached sources
338 /// contains a complete definition for \p T. Queries the sources in list
339 /// order until the first one claims that a diagnostic was produced.
341 /// \param Loc the location at which a complete type was required but not
344 /// \param T the \c QualType that should have been complete at \p Loc
346 /// \return true if a diagnostic was produced, false otherwise.
347 bool MaybeDiagnoseMissingCompleteType(SourceLocation Loc,
348 QualType T) override;
350 // isa/cast/dyn_cast support
351 static bool classof(const MultiplexExternalSemaSource*) { return true; }
352 //static bool classof(const ExternalSemaSource*) { return true; }
355 } // end namespace clang