1 //===--- ASTUnit.h - ASTUnit utility ----------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // ASTUnit utility class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H
15 #define LLVM_CLANG_FRONTEND_ASTUNIT_H
17 #include "clang-c/Index.h"
18 #include "clang/AST/ASTContext.h"
19 #include "clang/Basic/FileManager.h"
20 #include "clang/Basic/FileSystemOptions.h"
21 #include "clang/Basic/LangOptions.h"
22 #include "clang/Basic/SourceManager.h"
23 #include "clang/Basic/TargetOptions.h"
24 #include "clang/Lex/HeaderSearchOptions.h"
25 #include "clang/Lex/ModuleLoader.h"
26 #include "clang/Lex/PreprocessingRecord.h"
27 #include "clang/Sema/CodeCompleteConsumer.h"
28 #include "clang/Sema/Sema.h"
29 #include "clang/Serialization/ASTBitCodes.h"
30 #include "llvm/ADT/IntrusiveRefCntPtr.h"
31 #include "llvm/ADT/OwningPtr.h"
32 #include "llvm/ADT/SmallVector.h"
33 #include "llvm/ADT/StringMap.h"
34 #include "llvm/Support/Path.h"
38 #include <sys/types.h>
49 class CodeCompleteConsumer;
50 class CompilerInvocation;
51 class CompilerInstance;
53 class DiagnosticsEngine;
60 class ASTFrontendAction;
61 class ASTDeserializationListener;
63 /// \brief Utility class for loading a ASTContext from an AST file.
65 class ASTUnit : public ModuleLoader {
67 IntrusiveRefCntPtr<LangOptions> LangOpts;
68 IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics;
69 IntrusiveRefCntPtr<FileManager> FileMgr;
70 IntrusiveRefCntPtr<SourceManager> SourceMgr;
71 OwningPtr<HeaderSearch> HeaderInfo;
72 IntrusiveRefCntPtr<TargetInfo> Target;
73 IntrusiveRefCntPtr<Preprocessor> PP;
74 IntrusiveRefCntPtr<ASTContext> Ctx;
75 IntrusiveRefCntPtr<TargetOptions> TargetOpts;
76 IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts;
80 OwningPtr<ASTWriterData> WriterData;
82 FileSystemOptions FileSystemOpts;
84 /// \brief The AST consumer that received information about the translation
85 /// unit as it was parsed or loaded.
86 OwningPtr<ASTConsumer> Consumer;
88 /// \brief The semantic analysis object used to type-check the translation
90 OwningPtr<Sema> TheSema;
92 /// Optional owned invocation, just used to make the invocation used in
93 /// LoadFromCommandLine available.
94 IntrusiveRefCntPtr<CompilerInvocation> Invocation;
96 // OnlyLocalDecls - when true, walking this AST should only visit declarations
97 // that come from the AST itself, not from included precompiled headers.
98 // FIXME: This is temporary; eventually, CIndex will always do this.
101 /// \brief Whether to capture any diagnostics produced.
102 bool CaptureDiagnostics;
104 /// \brief Track whether the main file was loaded from an AST or not.
107 /// \brief What kind of translation unit this AST represents.
108 TranslationUnitKind TUKind;
110 /// \brief Whether we should time each operation.
113 /// \brief Whether the ASTUnit should delete the remapped buffers.
114 bool OwnsRemappedFileBuffers;
116 /// Track the top-level decls which appeared in an ASTUnit which was loaded
117 /// from a source file.
119 // FIXME: This is just an optimization hack to avoid deserializing large parts
120 // of a PCH file when using the Index library on an ASTUnit loaded from
121 // source. In the long term we should make the Index library use efficient and
122 // more scalable search mechanisms.
123 std::vector<Decl*> TopLevelDecls;
125 /// \brief Sorted (by file offset) vector of pairs of file offset/Decl.
126 typedef SmallVector<std::pair<unsigned, Decl *>, 64> LocDeclsTy;
127 typedef llvm::DenseMap<FileID, LocDeclsTy *> FileDeclsTy;
129 /// \brief Map from FileID to the file-level declarations that it contains.
130 /// The files and decls are only local (and non-preamble) ones.
131 FileDeclsTy FileDecls;
133 /// The name of the original source file used to generate this ASTUnit.
134 std::string OriginalSourceFile;
136 /// \brief The set of diagnostics produced when creating the preamble.
137 SmallVector<StoredDiagnostic, 4> PreambleDiagnostics;
139 /// \brief The set of diagnostics produced when creating this
140 /// translation unit.
141 SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
143 /// \brief The set of diagnostics produced when failing to parse, e.g. due
144 /// to failure to load the PCH.
145 SmallVector<StoredDiagnostic, 4> FailedParseDiagnostics;
147 /// \brief The number of stored diagnostics that come from the driver
150 /// Diagnostics that come from the driver are retained from one parse to
152 unsigned NumStoredDiagnosticsFromDriver;
154 /// \brief Counter that determines when we want to try building a
155 /// precompiled preamble.
157 /// If zero, we will never build a precompiled preamble. Otherwise,
158 /// it's treated as a counter that decrements each time we reparse
159 /// without the benefit of a precompiled preamble. When it hits 1,
160 /// we'll attempt to rebuild the precompiled header. This way, if
161 /// building the precompiled preamble fails, we won't try again for
162 /// some number of calls.
163 unsigned PreambleRebuildCounter;
167 const FileEntry *File;
168 std::vector<char> Buffer;
169 mutable unsigned NumLines;
172 PreambleData() : File(0), NumLines(0) { }
174 void assign(const FileEntry *F, const char *begin, const char *end) {
176 Buffer.assign(begin, end);
180 void clear() { Buffer.clear(); File = 0; NumLines = 0; }
182 size_t size() const { return Buffer.size(); }
183 bool empty() const { return Buffer.empty(); }
185 const char *getBufferStart() const { return &Buffer[0]; }
187 unsigned getNumLines() const {
194 SourceRange getSourceRange(const SourceManager &SM) const {
195 SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID());
196 return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1));
200 void countLines() const;
203 const PreambleData &getPreambleData() const {
209 /// \brief The contents of the preamble that has been precompiled to
211 PreambleData Preamble;
213 /// \brief Whether the preamble ends at the start of a new line.
215 /// Used to inform the lexer as to whether it's starting at the beginning of
216 /// a line after skipping the preamble.
217 bool PreambleEndsAtStartOfLine;
219 /// \brief The size of the source buffer that we've reserved for the main
220 /// file within the precompiled preamble.
221 unsigned PreambleReservedSize;
223 /// \brief Keeps track of the files that were used when computing the
224 /// preamble, with both their buffer size and their modification time.
226 /// If any of the files have changed from one compile to the next,
227 /// the preamble must be thrown away.
228 llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble;
230 /// \brief When non-NULL, this is the buffer used to store the contents of
231 /// the main file when it has been padded for use with the precompiled
233 llvm::MemoryBuffer *SavedMainFileBuffer;
235 /// \brief When non-NULL, this is the buffer used to store the
236 /// contents of the preamble when it has been padded to build the
237 /// precompiled preamble.
238 llvm::MemoryBuffer *PreambleBuffer;
240 /// \brief The number of warnings that occurred while parsing the preamble.
242 /// This value will be used to restore the state of the \c DiagnosticsEngine
243 /// object when re-using the precompiled preamble. Note that only the
244 /// number of warnings matters, since we will not save the preamble
245 /// when any errors are present.
246 unsigned NumWarningsInPreamble;
248 /// \brief A list of the serialization ID numbers for each of the top-level
249 /// declarations parsed within the precompiled preamble.
250 std::vector<serialization::DeclID> TopLevelDeclsInPreamble;
252 /// \brief Whether we should be caching code-completion results.
253 bool ShouldCacheCodeCompletionResults : 1;
255 /// \brief Whether to include brief documentation within the set of code
256 /// completions cached.
257 bool IncludeBriefCommentsInCodeCompletion : 1;
259 /// \brief True if non-system source files should be treated as volatile
260 /// (likely to change while trying to use them).
261 bool UserFilesAreVolatile : 1;
263 /// \brief The language options used when we load an AST file.
264 LangOptions ASTFileLangOpts;
266 static void ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> &Diags,
267 const char **ArgBegin, const char **ArgEnd,
268 ASTUnit &AST, bool CaptureDiagnostics);
270 void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName,
271 SourceManager &SrcMan,
272 const SmallVectorImpl<StoredDiagnostic> &Diags,
273 SmallVectorImpl<StoredDiagnostic> &Out);
275 void clearFileLevelDecls();
278 /// \brief A cached code-completion result, which may be introduced in one of
279 /// many different contexts.
280 struct CachedCodeCompletionResult {
281 /// \brief The code-completion string corresponding to this completion
283 CodeCompletionString *Completion;
285 /// \brief A bitmask that indicates which code-completion contexts should
286 /// contain this completion result.
288 /// The bits in the bitmask correspond to the values of
289 /// CodeCompleteContext::Kind. To map from a completion context kind to a
290 /// bit, shift 1 by that number of bits. Many completions can occur in
291 /// several different contexts.
292 uint64_t ShowInContexts;
294 /// \brief The priority given to this code-completion result.
297 /// \brief The libclang cursor kind corresponding to this code-completion
301 /// \brief The availability of this code-completion result.
302 CXAvailabilityKind Availability;
304 /// \brief The simplified type class for a non-macro completion result.
305 SimplifiedTypeClass TypeClass;
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.
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.
316 /// \brief Retrieve the mapping from formatted type names to unique type
318 llvm::StringMap<unsigned> &getCachedCompletionTypes() {
319 return CachedCompletionTypes;
322 /// \brief Retrieve the allocator used to cache global code completions.
323 IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
324 getCachedCompletionAllocator() {
325 return CachedCompletionAllocator;
328 CodeCompletionTUInfo &getCodeCompletionTUInfo() {
330 CCTUInfo.reset(new CodeCompletionTUInfo(
331 new GlobalCodeCompletionAllocator));
336 /// \brief Allocator used to store cached code completions.
337 IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
338 CachedCompletionAllocator;
340 OwningPtr<CodeCompletionTUInfo> CCTUInfo;
342 /// \brief The set of cached code-completion results.
343 std::vector<CachedCodeCompletionResult> CachedCompletionResults;
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;
349 /// \brief A string hash of the top-level declaration and macro definition
350 /// names processed the last time that we reparsed the file.
352 /// This hash value is used to determine when we need to refresh the
353 /// global code-completion cache.
354 unsigned CompletionCacheTopLevelHashValue;
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.
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;
363 /// \brief The current hash value for the top-level declaration and macro
365 unsigned CurrentTopLevelHashValue;
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;
371 /// \brief Cache any "global" code-completion results, so that we can avoid
372 /// recomputing them with each completion.
373 void CacheCodeCompletionResults();
375 /// \brief Clear out and deallocate
376 void ClearCachedCompletionResults();
378 ASTUnit(const ASTUnit &) LLVM_DELETED_FUNCTION;
379 void operator=(const ASTUnit &) LLVM_DELETED_FUNCTION;
381 explicit ASTUnit(bool MainFileIsAST);
383 void CleanTemporaryFiles();
384 bool Parse(llvm::MemoryBuffer *OverrideMainBuffer);
386 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
387 ComputePreamble(CompilerInvocation &Invocation,
388 unsigned MaxLines, bool &CreatedBuffer);
390 llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble(
391 const CompilerInvocation &PreambleInvocationIn,
392 bool AllowRebuild = true,
393 unsigned MaxLines = 0);
394 void RealizeTopLevelDeclsFromPreamble();
396 /// \brief Transfers ownership of the objects (like SourceManager) from
397 /// \param CI to this ASTUnit.
398 void transferASTDataFromCompilerInstance(CompilerInstance &CI);
400 /// \brief Allows us to assert that ASTUnit is not being used concurrently,
401 /// which is not supported.
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 {
409 void *Mutex; // a llvm::sys::MutexImpl in debug;
419 ConcurrencyState ConcurrencyCheckValue;
422 class ConcurrencyCheck {
426 explicit ConcurrencyCheck(ASTUnit &Self)
429 Self.ConcurrencyCheckValue.start();
431 ~ConcurrencyCheck() {
432 Self.ConcurrencyCheckValue.finish();
435 friend class ConcurrencyCheck;
439 bool isMainFileAST() const { return MainFileIsAST; }
441 bool isUnsafeToFree() const { return UnsafeToFree; }
442 void setUnsafeToFree(bool Value) { UnsafeToFree = Value; }
444 const DiagnosticsEngine &getDiagnostics() const { return *Diagnostics; }
445 DiagnosticsEngine &getDiagnostics() { return *Diagnostics; }
447 const SourceManager &getSourceManager() const { return *SourceMgr; }
448 SourceManager &getSourceManager() { return *SourceMgr; }
450 const Preprocessor &getPreprocessor() const { return *PP; }
451 Preprocessor &getPreprocessor() { return *PP; }
453 const ASTContext &getASTContext() const { return *Ctx; }
454 ASTContext &getASTContext() { return *Ctx; }
456 void setASTContext(ASTContext *ctx) { Ctx = ctx; }
457 void setPreprocessor(Preprocessor *pp);
459 bool hasSema() const { return TheSema; }
460 Sema &getSema() const {
461 assert(TheSema && "ASTUnit does not have a Sema object!");
465 const FileManager &getFileManager() const { return *FileMgr; }
466 FileManager &getFileManager() { return *FileMgr; }
468 const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; }
470 StringRef getOriginalSourceFileName() {
471 return OriginalSourceFile;
474 ASTDeserializationListener *getDeserializationListener();
476 /// \brief Add a temporary file that the ASTUnit depends on.
478 /// This file will be erased when the ASTUnit is destroyed.
479 void addTemporaryFile(const llvm::sys::Path &TempFile);
481 bool getOnlyLocalDecls() const { return OnlyLocalDecls; }
483 bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; }
484 void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; }
486 StringRef getMainFileName() const;
488 /// \brief If this ASTUnit came from an AST file, returns the filename for it.
489 StringRef getASTFileName() const;
491 typedef std::vector<Decl *>::iterator top_level_iterator;
493 top_level_iterator top_level_begin() {
494 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
495 if (!TopLevelDeclsInPreamble.empty())
496 RealizeTopLevelDeclsFromPreamble();
497 return TopLevelDecls.begin();
500 top_level_iterator top_level_end() {
501 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
502 if (!TopLevelDeclsInPreamble.empty())
503 RealizeTopLevelDeclsFromPreamble();
504 return TopLevelDecls.end();
507 std::size_t top_level_size() const {
508 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
509 return TopLevelDeclsInPreamble.size() + TopLevelDecls.size();
512 bool top_level_empty() const {
513 assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
514 return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty();
517 /// \brief Add a new top-level declaration.
518 void addTopLevelDecl(Decl *D) {
519 TopLevelDecls.push_back(D);
522 /// \brief Add a new local file-level declaration.
523 void addFileLevelDecl(Decl *D);
525 /// \brief Get the decls that are contained in a file in the Offset/Length
526 /// range. \p Length can be 0 to indicate a point at \p Offset instead of
528 void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
529 SmallVectorImpl<Decl *> &Decls);
531 /// \brief Add a new top-level declaration, identified by its ID in
532 /// the precompiled preamble.
533 void addTopLevelDeclFromPreamble(serialization::DeclID D) {
534 TopLevelDeclsInPreamble.push_back(D);
537 /// \brief Retrieve a reference to the current top-level name hash value.
539 /// Note: This is used internally by the top-level tracking action
540 unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; }
542 /// \brief Get the source location for the given file:line:col triplet.
544 /// The difference with SourceManager::getLocation is that this method checks
545 /// whether the requested location points inside the precompiled preamble
546 /// in which case the returned source location will be a "loaded" one.
547 SourceLocation getLocation(const FileEntry *File,
548 unsigned Line, unsigned Col) const;
550 /// \brief Get the source location for the given file:offset pair.
551 SourceLocation getLocation(const FileEntry *File, unsigned Offset) const;
553 /// \brief If \p Loc is a loaded location from the preamble, returns
554 /// the corresponding local location of the main file, otherwise it returns
556 SourceLocation mapLocationFromPreamble(SourceLocation Loc);
558 /// \brief If \p Loc is a local location of the main file but inside the
559 /// preamble chunk, returns the corresponding loaded location from the
560 /// preamble, otherwise it returns \p Loc.
561 SourceLocation mapLocationToPreamble(SourceLocation Loc);
563 bool isInPreambleFileID(SourceLocation Loc);
564 bool isInMainFileID(SourceLocation Loc);
565 SourceLocation getStartOfMainFileID();
566 SourceLocation getEndOfPreambleFileID();
568 /// \see mapLocationFromPreamble.
569 SourceRange mapRangeFromPreamble(SourceRange R) {
570 return SourceRange(mapLocationFromPreamble(R.getBegin()),
571 mapLocationFromPreamble(R.getEnd()));
574 /// \see mapLocationToPreamble.
575 SourceRange mapRangeToPreamble(SourceRange R) {
576 return SourceRange(mapLocationToPreamble(R.getBegin()),
577 mapLocationToPreamble(R.getEnd()));
580 // Retrieve the diagnostics associated with this AST
581 typedef StoredDiagnostic *stored_diag_iterator;
582 typedef const StoredDiagnostic *stored_diag_const_iterator;
583 stored_diag_const_iterator stored_diag_begin() const {
584 return StoredDiagnostics.begin();
586 stored_diag_iterator stored_diag_begin() {
587 return StoredDiagnostics.begin();
589 stored_diag_const_iterator stored_diag_end() const {
590 return StoredDiagnostics.end();
592 stored_diag_iterator stored_diag_end() {
593 return StoredDiagnostics.end();
595 unsigned stored_diag_size() const { return StoredDiagnostics.size(); }
597 stored_diag_iterator stored_diag_afterDriver_begin() {
598 if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size())
599 NumStoredDiagnosticsFromDriver = 0;
600 return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver;
603 typedef std::vector<CachedCodeCompletionResult>::iterator
604 cached_completion_iterator;
606 cached_completion_iterator cached_completion_begin() {
607 return CachedCompletionResults.begin();
610 cached_completion_iterator cached_completion_end() {
611 return CachedCompletionResults.end();
614 unsigned cached_completion_size() const {
615 return CachedCompletionResults.size();
618 /// \brief Returns an iterator range for the local preprocessing entities
619 /// of the local Preprocessor, if this is a parsed source file, or the loaded
620 /// preprocessing entities of the primary module if this is an AST file.
621 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
622 getLocalPreprocessingEntities() const;
624 /// \brief Type for a function iterating over a number of declarations.
625 /// \returns true to continue iteration and false to abort.
626 typedef bool (*DeclVisitorFn)(void *context, const Decl *D);
628 /// \brief Iterate over local declarations (locally parsed if this is a parsed
629 /// source file or the loaded declarations of the primary module if this is an
631 /// \returns true if the iteration was complete or false if it was aborted.
632 bool visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn);
634 /// \brief Get the PCH file if one was included.
635 const FileEntry *getPCHFile();
637 /// \brief Returns true if the ASTUnit was constructed from a serialized
641 llvm::MemoryBuffer *getBufferForFile(StringRef Filename,
642 std::string *ErrorStr = 0);
644 /// \brief Determine what kind of translation unit this AST represents.
645 TranslationUnitKind getTranslationUnitKind() const { return TUKind; }
647 typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *>
649 /// \brief A mapping from a file name to the memory buffer that stores the
650 /// remapped contents of that file.
651 typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile;
653 /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation.
654 static ASTUnit *create(CompilerInvocation *CI,
655 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
656 bool CaptureDiagnostics,
657 bool UserFilesAreVolatile);
659 /// \brief Create a ASTUnit from an AST file.
661 /// \param Filename - The AST file to load.
663 /// \param Diags - The diagnostics engine to use for reporting errors; its
664 /// lifetime is expected to extend past that of the returned ASTUnit.
666 /// \returns - The initialized ASTUnit or null if the AST failed to load.
667 static ASTUnit *LoadFromASTFile(const std::string &Filename,
668 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
669 const FileSystemOptions &FileSystemOpts,
670 bool OnlyLocalDecls = false,
671 RemappedFile *RemappedFiles = 0,
672 unsigned NumRemappedFiles = 0,
673 bool CaptureDiagnostics = false,
674 bool AllowPCHWithCompilerErrors = false,
675 bool UserFilesAreVolatile = false);
678 /// \brief Helper function for \c LoadFromCompilerInvocation() and
679 /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation.
681 /// \param PrecompilePreamble Whether to precompile the preamble of this
682 /// translation unit, to improve the performance of reparsing.
684 /// \returns \c true if a catastrophic failure occurred (which means that the
685 /// \c ASTUnit itself is invalid), or \c false otherwise.
686 bool LoadFromCompilerInvocation(bool PrecompilePreamble);
690 /// \brief Create an ASTUnit from a source file, via a CompilerInvocation
691 /// object, by invoking the optionally provided ASTFrontendAction.
693 /// \param CI - The compiler invocation to use; it must have exactly one input
694 /// source file. The ASTUnit takes ownership of the CompilerInvocation object.
696 /// \param Diags - The diagnostics engine to use for reporting errors; its
697 /// lifetime is expected to extend past that of the returned ASTUnit.
699 /// \param Action - The ASTFrontendAction to invoke. Its ownership is not
702 /// \param Unit - optionally an already created ASTUnit. Its ownership is not
705 /// \param Persistent - if true the returned ASTUnit will be complete.
706 /// false means the caller is only interested in getting info through the
707 /// provided \see Action.
709 /// \param ErrAST - If non-null and parsing failed without any AST to return
710 /// (e.g. because the PCH could not be loaded), this accepts the ASTUnit
711 /// mainly to allow the caller to see the diagnostics.
712 /// This will only receive an ASTUnit if a new one was created. If an already
713 /// created ASTUnit was passed in \p Unit then the caller can check that.
715 static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI,
716 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
717 ASTFrontendAction *Action = 0,
719 bool Persistent = true,
720 StringRef ResourceFilesPath = StringRef(),
721 bool OnlyLocalDecls = false,
722 bool CaptureDiagnostics = false,
723 bool PrecompilePreamble = false,
724 bool CacheCodeCompletionResults = false,
725 bool IncludeBriefCommentsInCodeCompletion = false,
726 bool UserFilesAreVolatile = false,
727 OwningPtr<ASTUnit> *ErrAST = 0);
729 /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a
730 /// CompilerInvocation object.
732 /// \param CI - The compiler invocation to use; it must have exactly one input
733 /// source file. The ASTUnit takes ownership of the CompilerInvocation object.
735 /// \param Diags - The diagnostics engine to use for reporting errors; its
736 /// lifetime is expected to extend past that of the returned ASTUnit.
738 // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we
739 // shouldn't need to specify them at construction time.
740 static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI,
741 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
742 bool OnlyLocalDecls = false,
743 bool CaptureDiagnostics = false,
744 bool PrecompilePreamble = false,
745 TranslationUnitKind TUKind = TU_Complete,
746 bool CacheCodeCompletionResults = false,
747 bool IncludeBriefCommentsInCodeCompletion = false,
748 bool UserFilesAreVolatile = false);
750 /// LoadFromCommandLine - Create an ASTUnit from a vector of command line
751 /// arguments, which must specify exactly one source file.
753 /// \param ArgBegin - The beginning of the argument vector.
755 /// \param ArgEnd - The end of the argument vector.
757 /// \param Diags - The diagnostics engine to use for reporting errors; its
758 /// lifetime is expected to extend past that of the returned ASTUnit.
760 /// \param ResourceFilesPath - The path to the compiler resource files.
762 /// \param ErrAST - If non-null and parsing failed without any AST to return
763 /// (e.g. because the PCH could not be loaded), this accepts the ASTUnit
764 /// mainly to allow the caller to see the diagnostics.
766 // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we
767 // shouldn't need to specify them at construction time.
768 static ASTUnit *LoadFromCommandLine(const char **ArgBegin,
770 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
771 StringRef ResourceFilesPath,
772 bool OnlyLocalDecls = false,
773 bool CaptureDiagnostics = false,
774 RemappedFile *RemappedFiles = 0,
775 unsigned NumRemappedFiles = 0,
776 bool RemappedFilesKeepOriginalName = true,
777 bool PrecompilePreamble = false,
778 TranslationUnitKind TUKind = TU_Complete,
779 bool CacheCodeCompletionResults = false,
780 bool IncludeBriefCommentsInCodeCompletion = false,
781 bool AllowPCHWithCompilerErrors = false,
782 bool SkipFunctionBodies = false,
783 bool UserFilesAreVolatile = false,
784 bool ForSerialization = false,
785 OwningPtr<ASTUnit> *ErrAST = 0);
787 /// \brief Reparse the source files using the same command-line options that
788 /// were originally used to produce this translation unit.
790 /// \returns True if a failure occurred that causes the ASTUnit not to
791 /// contain any translation-unit information, false otherwise.
792 bool Reparse(RemappedFile *RemappedFiles = 0,
793 unsigned NumRemappedFiles = 0);
795 /// \brief Perform code completion at the given file, line, and
796 /// column within this translation unit.
798 /// \param File The file in which code completion will occur.
800 /// \param Line The line at which code completion will occur.
802 /// \param Column The column at which code completion will occur.
804 /// \param IncludeMacros Whether to include macros in the code-completion
807 /// \param IncludeCodePatterns Whether to include code patterns (such as a
808 /// for loop) in the code-completion results.
810 /// \param IncludeBriefComments Whether to include brief documentation within
811 /// the set of code completions returned.
813 /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and
814 /// OwnedBuffers parameters are all disgusting hacks. They will go away.
815 void CodeComplete(StringRef File, unsigned Line, unsigned Column,
816 RemappedFile *RemappedFiles, unsigned NumRemappedFiles,
817 bool IncludeMacros, bool IncludeCodePatterns,
818 bool IncludeBriefComments,
819 CodeCompleteConsumer &Consumer,
820 DiagnosticsEngine &Diag, LangOptions &LangOpts,
821 SourceManager &SourceMgr, FileManager &FileMgr,
822 SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
823 SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers);
825 /// \brief Save this translation unit to a file with the given name.
827 /// \returns true if there was a file error or false if the save was
829 bool Save(StringRef File);
831 /// \brief Serialize this translation unit with the given output stream.
833 /// \returns True if an error occurred, false otherwise.
834 bool serialize(raw_ostream &OS);
836 virtual ModuleLoadResult loadModule(SourceLocation ImportLoc,
838 Module::NameVisibilityKind Visibility,
839 bool IsInclusionDirective) {
840 // ASTUnit doesn't know how to load modules (not that this matters).
841 return ModuleLoadResult();
844 virtual void makeModuleVisible(Module *Mod,
845 Module::NameVisibilityKind Visibility,
846 SourceLocation ImportLoc,