ASTUnit.h revision 3e3cd93b2fd9644e970c389e715c13883faf68b6
1//===--- ASTUnit.h - ASTUnit utility ----------------------------*- 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// ASTUnit utility class. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H 15#define LLVM_CLANG_FRONTEND_ASTUNIT_H 16 17#include "clang/Index/ASTLocation.h" 18#include "clang/Serialization/ASTBitCodes.h" 19#include "clang/Sema/Sema.h" 20#include "clang/Sema/CodeCompleteConsumer.h" 21#include "clang/Lex/ModuleLoader.h" 22#include "clang/Lex/PreprocessingRecord.h" 23#include "clang/Basic/SourceManager.h" 24#include "clang/Basic/FileManager.h" 25#include "clang/Basic/FileSystemOptions.h" 26#include "clang-c/Index.h" 27#include "llvm/ADT/IntrusiveRefCntPtr.h" 28#include "llvm/ADT/OwningPtr.h" 29#include "llvm/ADT/SmallVector.h" 30#include "llvm/ADT/StringMap.h" 31#include "llvm/Support/Path.h" 32#include <map> 33#include <string> 34#include <vector> 35#include <cassert> 36#include <utility> 37#include <sys/types.h> 38 39namespace llvm { 40 class MemoryBuffer; 41} 42 43namespace clang { 44class ASTContext; 45class ASTReader; 46class CodeCompleteConsumer; 47class CompilerInvocation; 48class Decl; 49class Diagnostic; 50class FileEntry; 51class FileManager; 52class HeaderSearch; 53class Preprocessor; 54class SourceManager; 55class TargetInfo; 56class ASTFrontendAction; 57 58using namespace idx; 59 60/// \brief Allocator for a cached set of global code completions. 61class GlobalCodeCompletionAllocator 62 : public CodeCompletionAllocator, 63 public llvm::RefCountedBase<GlobalCodeCompletionAllocator> 64{ 65 66}; 67 68/// \brief Utility class for loading a ASTContext from an AST file. 69/// 70class ASTUnit : public ModuleLoader { 71public: 72 typedef std::map<FileID, std::vector<PreprocessedEntity *> > 73 PreprocessedEntitiesByFileMap; 74 75private: 76 llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 77 llvm::IntrusiveRefCntPtr<FileManager> FileMgr; 78 llvm::IntrusiveRefCntPtr<SourceManager> SourceMgr; 79 llvm::OwningPtr<HeaderSearch> HeaderInfo; 80 llvm::IntrusiveRefCntPtr<TargetInfo> Target; 81 llvm::IntrusiveRefCntPtr<Preprocessor> PP; 82 llvm::IntrusiveRefCntPtr<ASTContext> Ctx; 83 84 FileSystemOptions FileSystemOpts; 85 86 /// \brief The AST consumer that received information about the translation 87 /// unit as it was parsed or loaded. 88 llvm::OwningPtr<ASTConsumer> Consumer; 89 90 /// \brief The semantic analysis object used to type-check the translation 91 /// unit. 92 llvm::OwningPtr<Sema> TheSema; 93 94 /// Optional owned invocation, just used to make the invocation used in 95 /// LoadFromCommandLine available. 96 llvm::IntrusiveRefCntPtr<CompilerInvocation> Invocation; 97 98 /// \brief The set of target features. 99 /// 100 /// FIXME: each time we reparse, we need to restore the set of target 101 /// features from this vector, because TargetInfo::CreateTargetInfo() 102 /// mangles the target options in place. Yuck! 103 std::vector<std::string> TargetFeatures; 104 105 // OnlyLocalDecls - when true, walking this AST should only visit declarations 106 // that come from the AST itself, not from included precompiled headers. 107 // FIXME: This is temporary; eventually, CIndex will always do this. 108 bool OnlyLocalDecls; 109 110 /// \brief Whether to capture any diagnostics produced. 111 bool CaptureDiagnostics; 112 113 /// \brief Track whether the main file was loaded from an AST or not. 114 bool MainFileIsAST; 115 116 /// \brief What kind of translation unit this AST represents. 117 TranslationUnitKind TUKind; 118 119 /// \brief Whether we should time each operation. 120 bool WantTiming; 121 122 /// \brief Whether the ASTUnit should delete the remapped buffers. 123 bool OwnsRemappedFileBuffers; 124 125 /// Track the top-level decls which appeared in an ASTUnit which was loaded 126 /// from a source file. 127 // 128 // FIXME: This is just an optimization hack to avoid deserializing large parts 129 // of a PCH file when using the Index library on an ASTUnit loaded from 130 // source. In the long term we should make the Index library use efficient and 131 // more scalable search mechanisms. 132 std::vector<Decl*> TopLevelDecls; 133 134 /// \brief The list of preprocessed entities which appeared when the ASTUnit 135 /// was loaded. 136 /// 137 /// FIXME: This is just an optimization hack to avoid deserializing large 138 /// parts of a PCH file while performing a walk or search. In the long term, 139 /// we should provide more scalable search mechanisms. 140 std::vector<PreprocessedEntity *> PreprocessedEntities; 141 142 /// The name of the original source file used to generate this ASTUnit. 143 std::string OriginalSourceFile; 144 145 // Critical optimization when using clang_getCursor(). 146 ASTLocation LastLoc; 147 148 /// \brief The set of diagnostics produced when creating the preamble. 149 SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 150 151 /// \brief The set of diagnostics produced when creating this 152 /// translation unit. 153 SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 154 155 /// \brief The number of stored diagnostics that come from the driver 156 /// itself. 157 /// 158 /// Diagnostics that come from the driver are retained from one parse to 159 /// the next. 160 unsigned NumStoredDiagnosticsFromDriver; 161 162 /// \brief Temporary files that should be removed when the ASTUnit is 163 /// destroyed. 164 SmallVector<llvm::sys::Path, 4> TemporaryFiles; 165 166 /// \brief A mapping from file IDs to the set of preprocessed entities 167 /// stored in that file. 168 /// 169 /// FIXME: This is just an optimization hack to avoid searching through 170 /// many preprocessed entities during cursor traversal in the CIndex library. 171 /// Ideally, we would just be able to perform a binary search within the 172 /// list of preprocessed entities. 173 PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 174 175 /// \brief Simple hack to allow us to assert that ASTUnit is not being 176 /// used concurrently, which is not supported. 177 /// 178 /// Clients should create instances of the ConcurrencyCheck class whenever 179 /// using the ASTUnit in a way that isn't intended to be concurrent, which is 180 /// just about any usage. 181 unsigned int ConcurrencyCheckValue; 182 static const unsigned int CheckLocked = 28573289; 183 static const unsigned int CheckUnlocked = 9803453; 184 185 /// \brief Counter that determines when we want to try building a 186 /// precompiled preamble. 187 /// 188 /// If zero, we will never build a precompiled preamble. Otherwise, 189 /// it's treated as a counter that decrements each time we reparse 190 /// without the benefit of a precompiled preamble. When it hits 1, 191 /// we'll attempt to rebuild the precompiled header. This way, if 192 /// building the precompiled preamble fails, we won't try again for 193 /// some number of calls. 194 unsigned PreambleRebuildCounter; 195 196 /// \brief The file in which the precompiled preamble is stored. 197 std::string PreambleFile; 198 199 /// \brief The contents of the preamble that has been precompiled to 200 /// \c PreambleFile. 201 std::vector<char> Preamble; 202 203 /// \brief Whether the preamble ends at the start of a new line. 204 /// 205 /// Used to inform the lexer as to whether it's starting at the beginning of 206 /// a line after skipping the preamble. 207 bool PreambleEndsAtStartOfLine; 208 209 /// \brief The size of the source buffer that we've reserved for the main 210 /// file within the precompiled preamble. 211 unsigned PreambleReservedSize; 212 213 /// \brief Keeps track of the files that were used when computing the 214 /// preamble, with both their buffer size and their modification time. 215 /// 216 /// If any of the files have changed from one compile to the next, 217 /// the preamble must be thrown away. 218 llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 219 220 /// \brief When non-NULL, this is the buffer used to store the contents of 221 /// the main file when it has been padded for use with the precompiled 222 /// preamble. 223 llvm::MemoryBuffer *SavedMainFileBuffer; 224 225 /// \brief When non-NULL, this is the buffer used to store the 226 /// contents of the preamble when it has been padded to build the 227 /// precompiled preamble. 228 llvm::MemoryBuffer *PreambleBuffer; 229 230 /// \brief The number of warnings that occurred while parsing the preamble. 231 /// 232 /// This value will be used to restore the state of the \c Diagnostic object 233 /// when re-using the precompiled preamble. Note that only the 234 /// number of warnings matters, since we will not save the preamble 235 /// when any errors are present. 236 unsigned NumWarningsInPreamble; 237 238 /// \brief A list of the serialization ID numbers for each of the top-level 239 /// declarations parsed within the precompiled preamble. 240 std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 241 242 /// \brief A list of the offsets into the precompiled preamble which 243 /// correspond to preprocessed entities. 244 std::vector<uint64_t> PreprocessedEntitiesInPreamble; 245 246 /// \brief Whether we should be caching code-completion results. 247 bool ShouldCacheCodeCompletionResults; 248 249 /// \brief Whether we want to include nested macro expansions in the 250 /// detailed preprocessing record. 251 bool NestedMacroExpansions; 252 253 /// \brief The language options used when we load an AST file. 254 LangOptions ASTFileLangOpts; 255 256 static void ConfigureDiags(llvm::IntrusiveRefCntPtr<Diagnostic> &Diags, 257 const char **ArgBegin, const char **ArgEnd, 258 ASTUnit &AST, bool CaptureDiagnostics); 259 260 void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName, 261 SourceManager &SrcMan, 262 const SmallVectorImpl<StoredDiagnostic> &Diags, 263 SmallVectorImpl<StoredDiagnostic> &Out); 264 265public: 266 /// \brief A cached code-completion result, which may be introduced in one of 267 /// many different contexts. 268 struct CachedCodeCompletionResult { 269 /// \brief The code-completion string corresponding to this completion 270 /// result. 271 CodeCompletionString *Completion; 272 273 /// \brief A bitmask that indicates which code-completion contexts should 274 /// contain this completion result. 275 /// 276 /// The bits in the bitmask correspond to the values of 277 /// CodeCompleteContext::Kind. To map from a completion context kind to a 278 /// bit, subtract one from the completion context kind and shift 1 by that 279 /// number of bits. Many completions can occur in several different 280 /// contexts. 281 unsigned ShowInContexts; 282 283 /// \brief The priority given to this code-completion result. 284 unsigned Priority; 285 286 /// \brief The libclang cursor kind corresponding to this code-completion 287 /// result. 288 CXCursorKind Kind; 289 290 /// \brief The availability of this code-completion result. 291 CXAvailabilityKind Availability; 292 293 /// \brief The simplified type class for a non-macro completion result. 294 SimplifiedTypeClass TypeClass; 295 296 /// \brief The type of a non-macro completion result, stored as a unique 297 /// integer used by the string map of cached completion types. 298 /// 299 /// This value will be zero if the type is not known, or a unique value 300 /// determined by the formatted type string. Se \c CachedCompletionTypes 301 /// for more information. 302 unsigned Type; 303 }; 304 305 /// \brief Retrieve the mapping from formatted type names to unique type 306 /// identifiers. 307 llvm::StringMap<unsigned> &getCachedCompletionTypes() { 308 return CachedCompletionTypes; 309 } 310 311 /// \brief Retrieve the allocator used to cache global code completions. 312 llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 313 getCachedCompletionAllocator() { 314 return CachedCompletionAllocator; 315 } 316 317 /// \brief Retrieve the allocator used to cache global code completions. 318 /// Creates the allocator if it doesn't already exist. 319 llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 320 getCursorCompletionAllocator() { 321 if (!CursorCompletionAllocator.getPtr()) { 322 CursorCompletionAllocator = new GlobalCodeCompletionAllocator; 323 } 324 return CursorCompletionAllocator; 325 } 326 327private: 328 /// \brief Allocator used to store cached code completions. 329 llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 330 CachedCompletionAllocator; 331 332 /// \brief Allocator used to store code completions for arbitrary cursors. 333 llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 334 CursorCompletionAllocator; 335 336 /// \brief The set of cached code-completion results. 337 std::vector<CachedCodeCompletionResult> CachedCompletionResults; 338 339 /// \brief A mapping from the formatted type name to a unique number for that 340 /// type, which is used for type equality comparisons. 341 llvm::StringMap<unsigned> CachedCompletionTypes; 342 343 /// \brief A string hash of the top-level declaration and macro definition 344 /// names processed the last time that we reparsed the file. 345 /// 346 /// This hash value is used to determine when we need to refresh the 347 /// global code-completion cache. 348 unsigned CompletionCacheTopLevelHashValue; 349 350 /// \brief A string hash of the top-level declaration and macro definition 351 /// names processed the last time that we reparsed the precompiled preamble. 352 /// 353 /// This hash value is used to determine when we need to refresh the 354 /// global code-completion cache after a rebuild of the precompiled preamble. 355 unsigned PreambleTopLevelHashValue; 356 357 /// \brief The current hash value for the top-level declaration and macro 358 /// definition names 359 unsigned CurrentTopLevelHashValue; 360 361 /// \brief Bit used by CIndex to mark when a translation unit may be in an 362 /// inconsistent state, and is not safe to free. 363 unsigned UnsafeToFree : 1; 364 365 /// \brief Cache any "global" code-completion results, so that we can avoid 366 /// recomputing them with each completion. 367 void CacheCodeCompletionResults(); 368 369 /// \brief Clear out and deallocate 370 void ClearCachedCompletionResults(); 371 372 ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 373 ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 374 375 explicit ASTUnit(bool MainFileIsAST); 376 377 void CleanTemporaryFiles(); 378 bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 379 380 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 381 ComputePreamble(CompilerInvocation &Invocation, 382 unsigned MaxLines, bool &CreatedBuffer); 383 384 llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 385 const CompilerInvocation &PreambleInvocationIn, 386 bool AllowRebuild = true, 387 unsigned MaxLines = 0); 388 void RealizeTopLevelDeclsFromPreamble(); 389 void RealizePreprocessedEntitiesFromPreamble(); 390 391public: 392 class ConcurrencyCheck { 393 volatile ASTUnit &Self; 394 395 public: 396 explicit ConcurrencyCheck(ASTUnit &Self) 397 : Self(Self) 398 { 399 assert(Self.ConcurrencyCheckValue == CheckUnlocked && 400 "Concurrent access to ASTUnit!"); 401 Self.ConcurrencyCheckValue = CheckLocked; 402 } 403 404 ~ConcurrencyCheck() { 405 Self.ConcurrencyCheckValue = CheckUnlocked; 406 } 407 }; 408 friend class ConcurrencyCheck; 409 410 ~ASTUnit(); 411 412 bool isMainFileAST() const { return MainFileIsAST; } 413 414 bool isUnsafeToFree() const { return UnsafeToFree; } 415 void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 416 417 const Diagnostic &getDiagnostics() const { return *Diagnostics; } 418 Diagnostic &getDiagnostics() { return *Diagnostics; } 419 420 const SourceManager &getSourceManager() const { return *SourceMgr; } 421 SourceManager &getSourceManager() { return *SourceMgr; } 422 423 const Preprocessor &getPreprocessor() const { return *PP; } 424 Preprocessor &getPreprocessor() { return *PP; } 425 426 const ASTContext &getASTContext() const { return *Ctx; } 427 ASTContext &getASTContext() { return *Ctx; } 428 429 bool hasSema() const { return TheSema; } 430 Sema &getSema() const { 431 assert(TheSema && "ASTUnit does not have a Sema object!"); 432 return *TheSema; 433 } 434 435 const FileManager &getFileManager() const { return *FileMgr; } 436 FileManager &getFileManager() { return *FileMgr; } 437 438 const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 439 440 const std::string &getOriginalSourceFileName(); 441 442 /// \brief Add a temporary file that the ASTUnit depends on. 443 /// 444 /// This file will be erased when the ASTUnit is destroyed. 445 void addTemporaryFile(const llvm::sys::Path &TempFile) { 446 TemporaryFiles.push_back(TempFile); 447 } 448 449 bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 450 451 bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 452 void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 453 454 /// \brief Retrieve the maximum PCH level of declarations that a 455 /// traversal of the translation unit should consider. 456 unsigned getMaxPCHLevel() const; 457 458 void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 459 ASTLocation getLastASTLocation() const { return LastLoc; } 460 461 462 StringRef getMainFileName() const; 463 464 typedef std::vector<Decl *>::iterator top_level_iterator; 465 466 top_level_iterator top_level_begin() { 467 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 468 if (!TopLevelDeclsInPreamble.empty()) 469 RealizeTopLevelDeclsFromPreamble(); 470 return TopLevelDecls.begin(); 471 } 472 473 top_level_iterator top_level_end() { 474 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 475 if (!TopLevelDeclsInPreamble.empty()) 476 RealizeTopLevelDeclsFromPreamble(); 477 return TopLevelDecls.end(); 478 } 479 480 std::size_t top_level_size() const { 481 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 482 return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 483 } 484 485 bool top_level_empty() const { 486 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 487 return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 488 } 489 490 /// \brief Add a new top-level declaration. 491 void addTopLevelDecl(Decl *D) { 492 TopLevelDecls.push_back(D); 493 } 494 495 /// \brief Add a new top-level declaration, identified by its ID in 496 /// the precompiled preamble. 497 void addTopLevelDeclFromPreamble(serialization::DeclID D) { 498 TopLevelDeclsInPreamble.push_back(D); 499 } 500 501 /// \brief Retrieve a reference to the current top-level name hash value. 502 /// 503 /// Note: This is used internally by the top-level tracking action 504 unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 505 506 typedef std::vector<PreprocessedEntity *>::iterator pp_entity_iterator; 507 508 pp_entity_iterator pp_entity_begin(); 509 pp_entity_iterator pp_entity_end(); 510 511 /// \brief Add a new preprocessed entity that's stored at the given offset 512 /// in the precompiled preamble. 513 void addPreprocessedEntityFromPreamble(uint64_t Offset) { 514 PreprocessedEntitiesInPreamble.push_back(Offset); 515 } 516 517 /// \brief Retrieve the mapping from File IDs to the preprocessed entities 518 /// within that file. 519 PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 520 return PreprocessedEntitiesByFile; 521 } 522 523 // Retrieve the diagnostics associated with this AST 524 typedef const StoredDiagnostic *stored_diag_iterator; 525 stored_diag_iterator stored_diag_begin() const { 526 return StoredDiagnostics.begin(); 527 } 528 stored_diag_iterator stored_diag_end() const { 529 return StoredDiagnostics.end(); 530 } 531 unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 532 533 SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 534 return StoredDiagnostics; 535 } 536 537 typedef std::vector<CachedCodeCompletionResult>::iterator 538 cached_completion_iterator; 539 540 cached_completion_iterator cached_completion_begin() { 541 return CachedCompletionResults.begin(); 542 } 543 544 cached_completion_iterator cached_completion_end() { 545 return CachedCompletionResults.end(); 546 } 547 548 unsigned cached_completion_size() const { 549 return CachedCompletionResults.size(); 550 } 551 552 llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 553 std::string *ErrorStr = 0); 554 555 /// \brief Determine what kind of translation unit this AST represents. 556 TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 557 558 typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 559 FilenameOrMemBuf; 560 /// \brief A mapping from a file name to the memory buffer that stores the 561 /// remapped contents of that file. 562 typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 563 564 /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 565 static ASTUnit *create(CompilerInvocation *CI, 566 llvm::IntrusiveRefCntPtr<Diagnostic> Diags); 567 568 /// \brief Create a ASTUnit from an AST file. 569 /// 570 /// \param Filename - The AST file to load. 571 /// 572 /// \param Diags - The diagnostics engine to use for reporting errors; its 573 /// lifetime is expected to extend past that of the returned ASTUnit. 574 /// 575 /// \returns - The initialized ASTUnit or null if the AST failed to load. 576 static ASTUnit *LoadFromASTFile(const std::string &Filename, 577 llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 578 const FileSystemOptions &FileSystemOpts, 579 bool OnlyLocalDecls = false, 580 RemappedFile *RemappedFiles = 0, 581 unsigned NumRemappedFiles = 0, 582 bool CaptureDiagnostics = false); 583 584private: 585 /// \brief Helper function for \c LoadFromCompilerInvocation() and 586 /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 587 /// 588 /// \param PrecompilePreamble Whether to precompile the preamble of this 589 /// translation unit, to improve the performance of reparsing. 590 /// 591 /// \returns \c true if a catastrophic failure occurred (which means that the 592 /// \c ASTUnit itself is invalid), or \c false otherwise. 593 bool LoadFromCompilerInvocation(bool PrecompilePreamble); 594 595public: 596 597 /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 598 /// object, by invoking the optionally provided ASTFrontendAction. 599 /// 600 /// \param CI - The compiler invocation to use; it must have exactly one input 601 /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 602 /// 603 /// \param Diags - The diagnostics engine to use for reporting errors; its 604 /// lifetime is expected to extend past that of the returned ASTUnit. 605 /// 606 /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 607 /// transfered. 608 static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 609 llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 610 ASTFrontendAction *Action = 0); 611 612 /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 613 /// CompilerInvocation object. 614 /// 615 /// \param CI - The compiler invocation to use; it must have exactly one input 616 /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 617 /// 618 /// \param Diags - The diagnostics engine to use for reporting errors; its 619 /// lifetime is expected to extend past that of the returned ASTUnit. 620 // 621 // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 622 // shouldn't need to specify them at construction time. 623 static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 624 llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 625 bool OnlyLocalDecls = false, 626 bool CaptureDiagnostics = false, 627 bool PrecompilePreamble = false, 628 TranslationUnitKind TUKind = TU_Complete, 629 bool CacheCodeCompletionResults = false, 630 bool NestedMacroExpansions = true); 631 632 /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 633 /// arguments, which must specify exactly one source file. 634 /// 635 /// \param ArgBegin - The beginning of the argument vector. 636 /// 637 /// \param ArgEnd - The end of the argument vector. 638 /// 639 /// \param Diags - The diagnostics engine to use for reporting errors; its 640 /// lifetime is expected to extend past that of the returned ASTUnit. 641 /// 642 /// \param ResourceFilesPath - The path to the compiler resource files. 643 // 644 // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 645 // shouldn't need to specify them at construction time. 646 static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 647 const char **ArgEnd, 648 llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 649 StringRef ResourceFilesPath, 650 bool OnlyLocalDecls = false, 651 bool CaptureDiagnostics = false, 652 RemappedFile *RemappedFiles = 0, 653 unsigned NumRemappedFiles = 0, 654 bool RemappedFilesKeepOriginalName = true, 655 bool PrecompilePreamble = false, 656 TranslationUnitKind TUKind = TU_Complete, 657 bool CacheCodeCompletionResults = false, 658 bool NestedMacroExpansions = true); 659 660 /// \brief Reparse the source files using the same command-line options that 661 /// were originally used to produce this translation unit. 662 /// 663 /// \returns True if a failure occurred that causes the ASTUnit not to 664 /// contain any translation-unit information, false otherwise. 665 bool Reparse(RemappedFile *RemappedFiles = 0, 666 unsigned NumRemappedFiles = 0); 667 668 /// \brief Perform code completion at the given file, line, and 669 /// column within this translation unit. 670 /// 671 /// \param File The file in which code completion will occur. 672 /// 673 /// \param Line The line at which code completion will occur. 674 /// 675 /// \param Column The column at which code completion will occur. 676 /// 677 /// \param IncludeMacros Whether to include macros in the code-completion 678 /// results. 679 /// 680 /// \param IncludeCodePatterns Whether to include code patterns (such as a 681 /// for loop) in the code-completion results. 682 /// 683 /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 684 /// OwnedBuffers parameters are all disgusting hacks. They will go away. 685 void CodeComplete(StringRef File, unsigned Line, unsigned Column, 686 RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 687 bool IncludeMacros, bool IncludeCodePatterns, 688 CodeCompleteConsumer &Consumer, 689 Diagnostic &Diag, LangOptions &LangOpts, 690 SourceManager &SourceMgr, FileManager &FileMgr, 691 SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 692 SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 693 694 /// \brief Save this translation unit to a file with the given name. 695 /// 696 /// \returns An indication of whether the save was successful or not. 697 CXSaveError Save(StringRef File); 698 699 /// \brief Serialize this translation unit with the given output stream. 700 /// 701 /// \returns True if an error occurred, false otherwise. 702 bool serialize(raw_ostream &OS); 703 704 virtual ModuleKey loadModule(SourceLocation ImportLoc, 705 IdentifierInfo &ModuleName, 706 SourceLocation ModuleNameLoc) { 707 // ASTUnit doesn't know how to load modules (not that this matters). 708 return 0; 709 } 710}; 711 712} // namespace clang 713 714#endif 715