ASTUnit.h revision 28019772db70d4547be05a042eb950bc910f134f
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; 48f96b524306ccfa623235d375deee79637bd38f29Steve Naroff 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 73f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track whether the main file was loaded from an AST or not. 74c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 75c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 76f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 77f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 78f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 79f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 80f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 81f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 82f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 83f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 84f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 8568d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 8668d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 8768d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 88f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 89f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 90f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 91a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 92a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 93405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 94a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 95313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 96313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 97313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 98bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 99788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 100788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 101788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 102788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 103788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 104788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 105788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 106788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 107788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 108bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 109bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 110bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 111bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 112bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 113bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 114bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 115bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 116bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 117313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 11831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 11931b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 120bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1213687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 1228b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 1230853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 124bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 125bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 126bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 127bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 128bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 129bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 130bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 131bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 132bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 133bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 134bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 135bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 136bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 137bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 138bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 139bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 140bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 141bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 1430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 144c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 145c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 1463687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 1473687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 1483687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 149405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 150405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 1510853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 1520853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 1530853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 1541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1550853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 1560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 1570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 158405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 159405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 160f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 16177accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 162e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 163b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 164313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 165313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 166313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 167313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 168313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 169313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 170313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 1717d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 172f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 173f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 174f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 175f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 176f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> &getTopLevelDecls() { 177f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 178f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 179f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 180f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar const std::vector<Decl*> &getTopLevelDecls() const { 181f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 182f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 183f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 184f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 185788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 186788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 187788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 188788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 189788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 190788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 191a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 192405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 193405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 194405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 195405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 196405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 197405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 198405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 199405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 200405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 201405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 202405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 203a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 204a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2054db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 2064db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 2074db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 2084db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 2090853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 2100853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 21131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 2120853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 2135262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2145262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 21531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 21631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 2170853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 21828019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 2195cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 2204db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 221a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 222a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 223521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 224521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 225521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 226521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 227521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 228f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 229521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 2305262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2315262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 232521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 233521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 234521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 235f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 23628019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 237a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 23894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor bool CaptureDiagnostics = false); 239521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 2407b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 2417b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 2427b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2437b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 2447b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2457b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 2467b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2475262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2485262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 2497b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 250869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 2517b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 2527b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 2537b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 2547b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 2557b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 25628019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 257869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 2587b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 2594db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 260a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 26194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor bool CaptureDiagnostics = false); 2620853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 2630853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2640853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 2650853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2660853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 267