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