ASTUnit.h revision 754f3490c5b0f5d83361f001bc87944f23644abb
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" 25788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 260853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 27f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 28f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 294db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 304db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 314db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 324db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 334db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 340853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 350853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 36521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 37521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 38521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 39521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 40521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 41521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 42521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 460853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 47f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 4844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 490853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// \brief Utility class for loading a ASTContext from a PCH file. 500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 510853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 52788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 53788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 54788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 55788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 5628019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 57405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 58405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 610853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 620853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 634ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 64807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 65807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 66807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 67807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar 687d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 697d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 707d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 717d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 72c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 73abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 74abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 75abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 76f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track whether the main file was loaded from an AST or not. 77c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 78c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 79f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 80f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 81f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 82f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 83f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 84f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 85f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 86f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 87f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 8868d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 8968d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 9068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 91f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 92f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 93f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 94a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 95a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 96405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 97a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 98313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 99313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 100313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 101bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 102788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 103788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 104788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 105788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 106788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 107788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 108788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 109788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 110788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 111bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 112bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 113bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 114bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 115bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 116bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 117bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 118bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 119bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 120175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 121175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 122175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor llvm::sys::Path PreambleFile; 123175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 124175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 125175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 126175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 127175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 128175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 129175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 130175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 131313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 13231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 13331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 134bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1353687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 1368b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 137abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 138754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 139175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 140175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::pair<llvm::MemoryBuffer *, unsigned> ComputePreamble( 141175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor CompilerInvocation &Invocation, 142175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor bool &CreatedBuffer); 143175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 144754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor llvm::MemoryBuffer *BuildPrecompiledPreamble(); 145abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 1460853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 147bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 148bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 149bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 150bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 151bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 152bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 153bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 154bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 155bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 156bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 157bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 158bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 159bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 160bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 161bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 162bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 163bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 164bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1650853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 1660853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 167c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 168c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 1693687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 1703687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 1713687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 172405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 173405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 1740853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 1750853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 1760853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1780853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 1790853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 1800853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 181405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 182405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 183f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 18477accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 185e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 186b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 187313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 188313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 189313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 190313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 191313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 192313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 193313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 1947d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 195f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 196f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 197f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 198f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 199f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> &getTopLevelDecls() { 200f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 201f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 202f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 203f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar const std::vector<Decl*> &getTopLevelDecls() const { 204f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 205f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 206f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 207f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 208788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 209788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 210788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 211788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 212788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 213788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 214a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 215405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 216405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 217405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 218405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 219405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 220405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 221405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 222405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 223405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 224405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 225405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 226a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 227a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2284db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 2294db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 2304db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 2314db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 2320853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 2330853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 23431b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 2350853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 2365262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2375262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 23831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 23931b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 2400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 24128019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 2425cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 2434db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 244a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 245a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 246521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 247521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 248521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 249521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 250521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 251f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 252521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 2535262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2545262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 255521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 256521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 257521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 258f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 25928019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 260a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 26144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 26244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 263521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 2647b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 2657b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 2667b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2677b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 2687b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2697b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 2707b55668db7618334cc40011d3c1e128524d89462Daniel 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. 2737b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 274869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 2757b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 2767b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 2777b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 2787b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 2797b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 28028019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 281869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 2827b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 2834db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 284a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 28544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 28644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 287abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 288abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 289abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 290abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 291abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 292abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 293abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 294abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 2950853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 2960853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2970853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 2980853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2990853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 300