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