1 //===--- MultiplexExternalSemaSource.h - External Sema Interface-*- 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 ExternalSemaSource interface, dispatching to all clients 11 // 12 //===----------------------------------------------------------------------===// 13 #ifndef LLVM_CLANG_SEMA_MULTIPLEXEXTERNALSEMASOURCE_H 14 #define LLVM_CLANG_SEMA_MULTIPLEXEXTERNALSEMASOURCE_H 15 16 #include "clang/Sema/ExternalSemaSource.h" 17 #include "clang/Sema/Weak.h" 18 #include "llvm/ADT/SmallVector.h" 19 #include <utility> 20 21 namespace clang { 22 23 class CXXConstructorDecl; 24 class CXXRecordDecl; 25 class DeclaratorDecl; 26 struct ExternalVTableUse; 27 class LookupResult; 28 class NamespaceDecl; 29 class Scope; 30 class Sema; 31 class TypedefNameDecl; 32 class ValueDecl; 33 class VarDecl; 34 35 36 /// \brief An abstract interface that should be implemented by 37 /// external AST sources that also provide information for semantic 38 /// analysis. 39 class MultiplexExternalSemaSource : public ExternalSemaSource { 40 41 private: 42 SmallVector<ExternalSemaSource *, 2> Sources; // doesn't own them. 43 44 public: 45 46 ///\brief Constructs a new multiplexing external sema source and appends the 47 /// given element to it. 48 /// 49 ///\param[in] s1 - A non-null (old) ExternalSemaSource. 50 ///\param[in] s2 - A non-null (new) ExternalSemaSource. 51 /// 52 MultiplexExternalSemaSource(ExternalSemaSource& s1, ExternalSemaSource& s2); 53 54 ~MultiplexExternalSemaSource() override; 55 56 ///\brief Appends new source to the source list. 57 /// 58 ///\param[in] source - An ExternalSemaSource. 59 /// 60 void addSource(ExternalSemaSource &source); 61 62 //===--------------------------------------------------------------------===// 63 // ExternalASTSource. 64 //===--------------------------------------------------------------------===// 65 66 /// \brief Resolve a declaration ID into a declaration, potentially 67 /// building a new declaration. 68 Decl *GetExternalDecl(uint32_t ID) override; 69 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; 73 74 /// \brief Resolve a selector ID into a selector. 75 Selector GetExternalSelector(uint32_t ID) override; 76 77 /// \brief Returns the number of selectors known to the external AST 78 /// source. 79 uint32_t GetNumExternalSelectors() override; 80 81 /// \brief Resolve the offset of a statement in the decl stream into 82 /// a statement. 83 Stmt *GetExternalDeclStmt(uint64_t Offset) override; 84 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; 88 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; 92 93 ExtKind hasExternalDefinitions(const Decl *D) override; 94 95 /// \brief Find all declarations with the given name in the 96 /// given context. 97 bool FindExternalVisibleDeclsByName(const DeclContext *DC, 98 DeclarationName Name) override; 99 100 /// \brief Ensures that the table of all visible declarations inside this 101 /// context is up to date. 102 void completeVisibleDeclsMap(const DeclContext *DC) override; 103 104 /// \brief Finds all declarations lexically contained within the given 105 /// DeclContext, after applying an optional filter predicate. 106 /// 107 /// \param IsKindWeWant a predicate function that returns true if the passed 108 /// declaration kind is one we are looking for. 109 void 110 FindExternalLexicalDecls(const DeclContext *DC, 111 llvm::function_ref<bool(Decl::Kind)> IsKindWeWant, 112 SmallVectorImpl<Decl *> &Result) override; 113 114 /// \brief Get the decls that are contained in a file in the Offset/Length 115 /// range. \p Length can be 0 to indicate a point at \p Offset instead of 116 /// a range. 117 void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length, 118 SmallVectorImpl<Decl *> &Decls) override; 119 120 /// \brief Gives the external AST source an opportunity to complete 121 /// an incomplete type. 122 void CompleteType(TagDecl *Tag) override; 123 124 /// \brief Gives the external AST source an opportunity to complete an 125 /// incomplete Objective-C class. 126 /// 127 /// This routine will only be invoked if the "externally completed" bit is 128 /// set on the ObjCInterfaceDecl via the function 129 /// \c ObjCInterfaceDecl::setExternallyCompleted(). 130 void CompleteType(ObjCInterfaceDecl *Class) override; 131 132 /// \brief Loads comment ranges. 133 void ReadComments() override; 134 135 /// \brief Notify ExternalASTSource that we started deserialization of 136 /// a decl or type so until FinishedDeserializing is called there may be 137 /// decls that are initializing. Must be paired with FinishedDeserializing. 138 void StartedDeserializing() override; 139 140 /// \brief Notify ExternalASTSource that we finished the deserialization of 141 /// a decl or type. Must be paired with StartedDeserializing. 142 void FinishedDeserializing() override; 143 144 /// \brief Function that will be invoked when we begin parsing a new 145 /// translation unit involving this external AST source. 146 void StartTranslationUnit(ASTConsumer *Consumer) override; 147 148 /// \brief Print any statistics that have been gathered regarding 149 /// the external AST source. 150 void PrintStats() override; 151 152 153 /// \brief Perform layout on the given record. 154 /// 155 /// This routine allows the external AST source to provide an specific 156 /// layout for a record, overriding the layout that would normally be 157 /// constructed. It is intended for clients who receive specific layout 158 /// details rather than source code (such as LLDB). The client is expected 159 /// to fill in the field offsets, base offsets, virtual base offsets, and 160 /// complete object size. 161 /// 162 /// \param Record The record whose layout is being requested. 163 /// 164 /// \param Size The final size of the record, in bits. 165 /// 166 /// \param Alignment The final alignment of the record, in bits. 167 /// 168 /// \param FieldOffsets The offset of each of the fields within the record, 169 /// expressed in bits. All of the fields must be provided with offsets. 170 /// 171 /// \param BaseOffsets The offset of each of the direct, non-virtual base 172 /// classes. If any bases are not given offsets, the bases will be laid 173 /// out according to the ABI. 174 /// 175 /// \param VirtualBaseOffsets The offset of each of the virtual base classes 176 /// (either direct or not). If any bases are not given offsets, the bases will 177 /// be laid out according to the ABI. 178 /// 179 /// \returns true if the record layout was provided, false otherwise. 180 bool 181 layoutRecordType(const RecordDecl *Record, 182 uint64_t &Size, uint64_t &Alignment, 183 llvm::DenseMap<const FieldDecl *, uint64_t> &FieldOffsets, 184 llvm::DenseMap<const CXXRecordDecl *, CharUnits> &BaseOffsets, 185 llvm::DenseMap<const CXXRecordDecl *, 186 CharUnits> &VirtualBaseOffsets) override; 187 188 /// Return the amount of memory used by memory buffers, breaking down 189 /// by heap-backed versus mmap'ed memory. 190 void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override; 191 192 //===--------------------------------------------------------------------===// 193 // ExternalSemaSource. 194 //===--------------------------------------------------------------------===// 195 196 /// \brief Initialize the semantic source with the Sema instance 197 /// being used to perform semantic analysis on the abstract syntax 198 /// tree. 199 void InitializeSema(Sema &S) override; 200 201 /// \brief Inform the semantic consumer that Sema is no longer available. 202 void ForgetSema() override; 203 204 /// \brief Load the contents of the global method pool for a given 205 /// selector. 206 void ReadMethodPool(Selector Sel) override; 207 208 /// Load the contents of the global method pool for a given 209 /// selector if necessary. 210 void updateOutOfDateSelector(Selector Sel) override; 211 212 /// \brief Load the set of namespaces that are known to the external source, 213 /// which will be used during typo correction. 214 void 215 ReadKnownNamespaces(SmallVectorImpl<NamespaceDecl*> &Namespaces) override; 216 217 /// \brief Load the set of used but not defined functions or variables with 218 /// internal linkage, or used but not defined inline functions. 219 void ReadUndefinedButUsed( 220 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override; 221 222 void ReadMismatchingDeleteExpressions(llvm::MapVector< 223 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> & 224 Exprs) override; 225 226 /// \brief Do last resort, unqualified lookup on a LookupResult that 227 /// Sema cannot find. 228 /// 229 /// \param R a LookupResult that is being recovered. 230 /// 231 /// \param S the Scope of the identifier occurrence. 232 /// 233 /// \return true to tell Sema to recover using the LookupResult. 234 bool LookupUnqualified(LookupResult &R, Scope *S) override; 235 236 /// \brief Read the set of tentative definitions known to the external Sema 237 /// source. 238 /// 239 /// The external source should append its own tentative definitions to the 240 /// given vector of tentative definitions. Note that this routine may be 241 /// invoked multiple times; the external source should take care not to 242 /// introduce the same declarations repeatedly. 243 void ReadTentativeDefinitions(SmallVectorImpl<VarDecl*> &Defs) override; 244 245 /// \brief Read the set of unused file-scope declarations known to the 246 /// external Sema source. 247 /// 248 /// The external source should append its own unused, filed-scope to the 249 /// given vector of declarations. Note that this routine may be 250 /// invoked multiple times; the external source should take care not to 251 /// introduce the same declarations repeatedly. 252 void ReadUnusedFileScopedDecls( 253 SmallVectorImpl<const DeclaratorDecl*> &Decls) override; 254 255 /// \brief Read the set of delegating constructors known to the 256 /// external Sema source. 257 /// 258 /// The external source should append its own delegating constructors to the 259 /// given vector of declarations. Note that this routine may be 260 /// invoked multiple times; the external source should take care not to 261 /// introduce the same declarations repeatedly. 262 void ReadDelegatingConstructors( 263 SmallVectorImpl<CXXConstructorDecl*> &Decls) override; 264 265 /// \brief Read the set of ext_vector type declarations known to the 266 /// external Sema source. 267 /// 268 /// The external source should append its own ext_vector type declarations to 269 /// the given vector of declarations. Note that this routine may be 270 /// invoked multiple times; the external source should take care not to 271 /// introduce the same declarations repeatedly. 272 void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl*> &Decls) override; 273 274 /// \brief Read the set of potentially unused typedefs known to the source. 275 /// 276 /// The external source should append its own potentially unused local 277 /// typedefs to the given vector of declarations. Note that this routine may 278 /// be invoked multiple times; the external source should take care not to 279 /// introduce the same declarations repeatedly. 280 void ReadUnusedLocalTypedefNameCandidates( 281 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) override; 282 283 /// \brief Read the set of referenced selectors known to the 284 /// external Sema source. 285 /// 286 /// The external source should append its own referenced selectors to the 287 /// given vector of selectors. Note that this routine 288 /// may be invoked multiple times; the external source should take care not 289 /// to introduce the same selectors repeatedly. 290 void ReadReferencedSelectors(SmallVectorImpl<std::pair<Selector, 291 SourceLocation> > &Sels) override; 292 293 /// \brief Read the set of weak, undeclared identifiers known to the 294 /// external Sema source. 295 /// 296 /// The external source should append its own weak, undeclared identifiers to 297 /// the given vector. Note that this routine may be invoked multiple times; 298 /// the external source should take care not to introduce the same identifiers 299 /// repeatedly. 300 void ReadWeakUndeclaredIdentifiers( 301 SmallVectorImpl<std::pair<IdentifierInfo*, WeakInfo> > &WI) override; 302 303 /// \brief Read the set of used vtables known to the external Sema source. 304 /// 305 /// The external source should append its own used vtables to the given 306 /// vector. Note that this routine may be invoked multiple times; the external 307 /// source should take care not to introduce the same vtables repeatedly. 308 void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override; 309 310 /// \brief Read the set of pending instantiations known to the external 311 /// Sema source. 312 /// 313 /// The external source should append its own pending instantiations to the 314 /// given vector. Note that this routine may be invoked multiple times; the 315 /// external source should take care not to introduce the same instantiations 316 /// repeatedly. 317 void ReadPendingInstantiations( 318 SmallVectorImpl<std::pair<ValueDecl*, SourceLocation> >& Pending) override; 319 320 /// \brief Read the set of late parsed template functions for this source. 321 /// 322 /// The external source should insert its own late parsed template functions 323 /// into the map. Note that this routine may be invoked multiple times; the 324 /// external source should take care not to introduce the same map entries 325 /// repeatedly. 326 void ReadLateParsedTemplates( 327 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>> 328 &LPTMap) override; 329 330 /// \copydoc ExternalSemaSource::CorrectTypo 331 /// \note Returns the first nonempty correction. 332 TypoCorrection CorrectTypo(const DeclarationNameInfo &Typo, 333 int LookupKind, Scope *S, CXXScopeSpec *SS, 334 CorrectionCandidateCallback &CCC, 335 DeclContext *MemberContext, 336 bool EnteringContext, 337 const ObjCObjectPointerType *OPT) override; 338 339 /// \brief Produces a diagnostic note if one of the attached sources 340 /// contains a complete definition for \p T. Queries the sources in list 341 /// order until the first one claims that a diagnostic was produced. 342 /// 343 /// \param Loc the location at which a complete type was required but not 344 /// provided 345 /// 346 /// \param T the \c QualType that should have been complete at \p Loc 347 /// 348 /// \return true if a diagnostic was produced, false otherwise. 349 bool MaybeDiagnoseMissingCompleteType(SourceLocation Loc, 350 QualType T) override; 351 352 // isa/cast/dyn_cast support 353 static bool classof(const MultiplexExternalSemaSource*) { return true; } 354 //static bool classof(const ExternalSemaSource*) { return true; } 355 }; 356 357 } // end namespace clang 358 359 #endif 360
