ASTUnit.h revision 385103b79c5338a2be5da0ca70652400bc267371
14b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===--- ASTUnit.h - ASTUnit utility ----------------------------*- C++ -*-===// 24b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 34b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 44b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 54b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 64b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 74b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 84b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 94b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 104b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// ASTUnit utility class. 114b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 124b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 134b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis 140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H 150853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#define LLVM_CLANG_FRONTEND_ASTUNIT_H 160853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 174ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 1831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 1928019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 200853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 2136c4464ba6cfc2a63dc67c493ef2f5ab2aea09ccSteve Naroff#include "clang/Basic/FileManager.h" 22f96b524306ccfa623235d375deee79637bd38f29Steve Naroff#include "clang/Index/ASTLocation.h" 23a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 24313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 25385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor#include "llvm/Support/Timer.h" 26788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 28f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 29f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 304db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 314db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 324db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 334db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 344db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 350853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 360853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 37521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 38521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 39521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 40521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 41521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 42521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 46521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 470853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 48f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 4944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// \brief Utility class for loading a ASTContext from a PCH file. 510853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 520853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 53788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 54788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 55788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 56788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 5728019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 58405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 59405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 610853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 620853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 630853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 644ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 65807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 66807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 67807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 68807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar 697d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 707d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 717d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 727d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 73c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 74abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 75abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 76abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 77f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track whether the main file was loaded from an AST or not. 78c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 79c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 80f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 81f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 82f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 83f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 84f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 85f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 86f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 87f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 88f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 8968d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 9068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 9168d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 92f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 93f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 94f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 95a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 96a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 97405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 98a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 99313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 100313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 101313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 102bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 103788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 104788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 105788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 106788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 107788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 108788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 109788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 110788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 111788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 112bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 113bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 114bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 115bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 116bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 117bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 118bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 119bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 120bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 121175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 122175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 123385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 124175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 125175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 126175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 127175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 128175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 129f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 130f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 131f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 132f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 133f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 134f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 135175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 136175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 137175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 138313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 13928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 14028233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 14128233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 14228233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 14328233428da1ebec20c893d6297ae3191318940ddDouglas Gregor 144385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The group of timers associated with this translation unit. 145385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor llvm::OwningPtr<llvm::TimerGroup> TimerGroup; 146385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor 147385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The timers we've created from the various parses, reparses, etc. 148385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// involved in this translation unit. 149385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::vector<llvm::Timer *> Timers; 150385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor 15131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 15231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 153bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1543687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 1558b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 156abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 157754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 158175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 159f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 160f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, bool &CreatedBuffer); 161175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 162754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor llvm::MemoryBuffer *BuildPrecompiledPreamble(); 163abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 1640853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 165bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 166bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 167bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 168bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 169bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 170bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 171bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 172bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 173bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 174bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 175bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 176bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 177bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 178bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 179bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 180bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 181bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 182bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1830853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 1840853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 185c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 186c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 1873687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 1883687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 1893687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 190405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 191405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 1920853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 1930853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 1940853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1960853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 1970853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 1980853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 199405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 200405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 201f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 20277accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 203e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 204b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 205313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 206313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 207313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 208313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 209313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 210313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 211313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 2127d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 213f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 214f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 215f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 216f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 217f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> &getTopLevelDecls() { 218f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 219f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 220f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 221f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar const std::vector<Decl*> &getTopLevelDecls() const { 222f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 223f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 224f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 225f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 226788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 227788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 228788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 229788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 230788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 231788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 232a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 233405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 234405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 235405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 236405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 237405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 238405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 239405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 240405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 241405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 242405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 243405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 244a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 245a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2464db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 2474db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 2484db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 2494db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 2500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 2510853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 25231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 2530853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 2545262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2555262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 25631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 25731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 2580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 25928019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 2605cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 2614db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 262a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 263a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 264521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 265521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 266521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 267521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 268521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 269f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 270521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 2715262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2725262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 273521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 274521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 275521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 276f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 27728019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 278a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 27944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 28044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 281521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 2827b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 2837b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 2847b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2857b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 2867b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2877b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 2887b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2895262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2905262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 2917b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 292869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 2937b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 2947b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 2957b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 2967b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 2977b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 29828019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 299869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 3007b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 3014db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 302a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 30344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 30444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 305abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 306abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 307abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 308abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 309abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 310abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 311abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 312abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 3130853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 3140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3150853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 3160853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3170853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 318