ASTUnit.h revision 405634b215f19eec7183bd8005e34aa5a02f64a1
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" 190853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 2036c4464ba6cfc2a63dc67c493ef2f5ab2aea09ccSteve Naroff#include "clang/Basic/FileManager.h" 21f96b524306ccfa623235d375deee79637bd38f29Steve Naroff#include "clang/Index/ASTLocation.h" 22a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 23313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 24788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 250853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 26f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 27f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 284db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 294db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 304db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 314db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 324db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 330853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 340853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 35521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 36521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 37521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 38521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 39521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 40521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 41521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 42521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 450853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 46f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 47f96b524306ccfa623235d375deee79637bd38f29Steve Naroff 480853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// \brief Utility class for loading a ASTContext from a PCH file. 490853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 51788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 52788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 53788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 54788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 55405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<Diagnostic> DiagEngine; 56405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 57405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 610853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 624ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 63807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 64807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 65807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 66807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar 677d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 687d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 697d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 707d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 71c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 72f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track whether the main file was loaded from an AST or not. 73c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 74c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 75f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 76f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 77f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 78f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 79f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 80f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 81f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 82f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 83f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 8468d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 8568d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 8668d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 87f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 88f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 89f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 90a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 91a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 92405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 93a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 94313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 95313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 96313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 97bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 98788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 99788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 100788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 101788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 102788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 103788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 104788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 105788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 106788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 107bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 108bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 109bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 110bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 111bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 112bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 113bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 114bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 115bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 116313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 11731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 11831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 119bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1200853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 121bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 122bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 123bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 124bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 125bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 126bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 127bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 128bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 129bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 130bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 131bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 132bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 133bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 134bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 135bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 136bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 137bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 138bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 139f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor ASTUnit(Diagnostic &Diag, bool MainFileIsAST); 1400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 1410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 142c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 143c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 144405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 145405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 1460853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 1470853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 1480853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 1491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 1510853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 1520853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 153405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 154405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 155f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 15677accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 157e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 158b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 159313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 160313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 161313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 162313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 163313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 164313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 165313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 1667d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 167f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 168f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 169f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 170f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 171f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> &getTopLevelDecls() { 172f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 173f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 174f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 175f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar const std::vector<Decl*> &getTopLevelDecls() const { 176f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 177f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar return TopLevelDecls; 178f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 179f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 180788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 181788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 182788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 183788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 184788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 185788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 186a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 187405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 188405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 189405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 190405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 191405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 192405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 193405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 194405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 195405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 196405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 197405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 198a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 199a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 2004db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 2014db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 2024db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 2034db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 2040853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 2050853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 20631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 2070853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 2085262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2095262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 21031b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 21131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 2120853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 2135262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar Diagnostic &Diags, 2145cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 2154db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 216a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 217a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 218521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 219521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 220521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 221521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 222521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 223f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 224521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 2255262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2265262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 227521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 228521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 229521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 230f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 231521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar Diagnostic &Diags, 232a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 23394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor bool CaptureDiagnostics = false); 234521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 2357b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 2367b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 2377b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2387b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 2397b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2407b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 2417b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 2425262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 2435262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 2447b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 245869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 2467b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 2477b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 2487b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 2497b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 2507b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 2517b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar Diagnostic &Diags, 252869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 2537b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 2544db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 255a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 25694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor bool CaptureDiagnostics = false); 2570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 2580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 2600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2610853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 262