ASTUnit.h revision 1872b3153a388b3a548c9f699cbc348128059be9
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 17eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Index/ASTLocation.h" 1805a07605322dfef2b017781042043a261c5a89cdSebastian Redl#include "clang/Serialization/ASTBitCodes.h" 19914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor#include "clang/Sema/Sema.h" 200a2c5e256abb4dc031c21fe4dc92c4f3afe9947cJohn McCall#include "clang/Sema/CodeCompleteConsumer.h" 216aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor#include "clang/Lex/ModuleLoader.h" 224ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 24eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 25389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h" 2687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2728019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 29a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 30cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 3103013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/Path.h" 32788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 330853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 34f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 35f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 37cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 414db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 45f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregorclass ASTReader; 461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 49d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 55521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 56d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction; 570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 58f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 6048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor/// \brief Allocator for a cached set of global code completions. 6148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregorclass GlobalCodeCompletionAllocator 6248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor : public CodeCompletionAllocator, 6348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor public llvm::RefCountedBase<GlobalCodeCompletionAllocator> 6448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor{ 6548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 6648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor}; 6748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 683c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 706aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ASTUnit : public ModuleLoader { 71788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 72d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics; 73d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<FileManager> FileMgr; 74d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<SourceManager> SourceMgr; 75d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::OwningPtr<HeaderSearch> HeaderInfo; 76d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<TargetInfo> Target; 77d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<Preprocessor> PP; 78d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<ASTContext> Ctx; 79389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 80389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 81389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 82914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 83914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 84914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 87914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 88914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 89914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 90807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 91807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 924f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<CompilerInvocation> Invocation; 93914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 941aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// \brief The set of target features. 951aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// 961aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// FIXME: each time we reparse, we need to restore the set of target 971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// features from this vector, because TargetInfo::CreateTargetInfo() 981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// mangles the target options in place. Yuck! 991aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor std::vector<std::string> TargetFeatures; 1001aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor 1017d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 1027d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 1037d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 1047d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 105c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 106abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 107abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 108e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 109df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 110c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 111c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 112467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief What kind of translation unit this AST represents. 113467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind; 114df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 115213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 116213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 11715727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 11815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis /// \brief Whether the ASTUnit should delete the remapped buffers. 11915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool OwnsRemappedFileBuffers; 120213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 121f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 122f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 123f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 127f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 128f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 12989d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 13068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 13168d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 13268d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 133f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 134f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 135f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 136f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The set of diagnostics produced when creating the preamble. 137686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 138f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 139a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 140a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 141686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 142a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1434cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1444cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1454cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1464cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1474cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1484cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1494cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 150eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 151eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 152eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 153eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 154eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 155eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 156eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 157eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 158eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 159eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 1601872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek 161ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidispublic: 162507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis class PreambleData { 163507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const FileEntry *File; 164507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis std::vector<char> Buffer; 165507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis mutable unsigned NumLines; 166507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 167507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis public: 168507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData() : File(0), NumLines(0) { } 169507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 170507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void assign(const FileEntry *F, const char *begin, const char *end) { 171507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis File = F; 172507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis Buffer.assign(begin, end); 173507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis NumLines = 0; 174507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 175507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 176507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void clear() { Buffer.clear(); File = 0; NumLines = 0; } 177507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 178507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis size_t size() const { return Buffer.size(); } 179507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis bool empty() const { return Buffer.empty(); } 180507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 181507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const char *getBufferStart() const { return &Buffer[0]; } 182507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 183507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned getNumLines() const { 184507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis if (NumLines) 185507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 186507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis countLines(); 187507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 188507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 189507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 190ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange getSourceRange(const SourceManager &SM) const { 191ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID()); 192ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1)); 193ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 194ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 195507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis private: 196507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void countLines() const; 197507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis }; 198507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 199ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis const PreambleData &getPreambleData() const { 200ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return Preamble; 201ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 202ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 203ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidisprivate: 204ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 205175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 206175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 207507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData Preamble; 208175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 209f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 210f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 211f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 212f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 213f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 214f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 215175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 216175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 217175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 218cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 219cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 220cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 221cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 222cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 223cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 224cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 225cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 22628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 22728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 22828233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 22928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 230c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 231671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 232671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 233671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 234671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 235671947b18dba342f9aba022ee992babef325a833Douglas Gregor 236c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 237c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 238d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// This value will be used to restore the state of the \c DiagnosticsEngine 239d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// object when re-using the precompiled preamble. Note that only the 240c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 241c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 242c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 243c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2443c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 245eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2468538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 24789d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 24887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 24987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 25087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 251ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /// \brief Whether we want to include nested macro expansions in the 252dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /// detailed preprocessing record. 253ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions; 2543e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 2553e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor /// \brief The language options used when we load an AST file. 2563e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor LangOptions ASTFileLangOpts; 2573e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 258d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie static void ConfigureDiags(llvm::IntrusiveRefCntPtr<DiagnosticsEngine> &Diags, 2590b53cf834346d78985aaa9e7300445a39c245614Douglas Gregor const char **ArgBegin, const char **ArgEnd, 260e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor ASTUnit &AST, bool CaptureDiagnostics); 261e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 262686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName, 263f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SourceManager &SrcMan, 264686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const SmallVectorImpl<StoredDiagnostic> &Diags, 265686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &Out); 266f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 26787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 26887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 26987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 27087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 27187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 27287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 27387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 27487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 27587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 27687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 27787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 27887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 27987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 28087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 28187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 28287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 28387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 28487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 28587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 28687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 28787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 28887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 28987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 29087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 2911827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 29258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 29358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 29458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 2951827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 2961827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 297f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 298f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 299f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 300f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 301f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 302f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 303f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 304f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 30587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 30687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 307f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 308f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 309f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 310f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 311f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 312f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 31348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 31448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 31548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor getCachedCompletionAllocator() { 31648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor return CachedCompletionAllocator; 31748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor } 31848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 3198fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 3208fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// Creates the allocator if it doesn't already exist. 3218fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3228fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor getCursorCompletionAllocator() { 3238fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor if (!CursorCompletionAllocator.getPtr()) { 3248fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator = new GlobalCodeCompletionAllocator; 3258fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3268fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor return CursorCompletionAllocator; 3278fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3288fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 32987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 330218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor /// \brief Allocator used to store cached code completions. 33148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 33248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor CachedCompletionAllocator; 3338fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 3348fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Allocator used to store code completions for arbitrary cursors. 3358fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator; 337218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor 33887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 33987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 34087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 341f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 342f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 343f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 344f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 3459b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3469b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the file. 347727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3489b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3499b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache. 3509b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CompletionCacheTopLevelHashValue; 351727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 3529b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3539b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the precompiled preamble. 354727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3559b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3569b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache after a rebuild of the precompiled preamble. 3579b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned PreambleTopLevelHashValue; 358ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3599b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief The current hash value for the top-level declaration and macro 3609b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// definition names 3619b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CurrentTopLevelHashValue; 3629b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 363ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 364ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 365ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 366ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 367c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 368c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 36987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 37087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 37187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 37287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 37387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 37431b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 37531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 376bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3773687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3788b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 379abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 380754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 381175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 382f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 383df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 384df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 385175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 386df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 38701b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor const CompilerInvocation &PreambleInvocationIn, 388df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 389df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 390eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 39189d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 392a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// \brief Allows us to assert that ASTUnit is not being used concurrently, 393a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// which is not supported. 394a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// 395a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Clients should create instances of the ConcurrencyCheck class whenever 396a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// using the ASTUnit in a way that isn't intended to be concurrent, which is 397a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// just about any usage. 398a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Becomes a noop in release mode; only useful for debug mode checking. 399a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis class ConcurrencyState { 400a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void *Mutex; // a llvm::sys::MutexImpl in debug; 401a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 402a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis public: 403a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState(); 404a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ~ConcurrencyState(); 405a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 406a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void start(); 407a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void finish(); 408a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis }; 409a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState ConcurrencyCheckValue; 410a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 4110853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 412bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 413a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ASTUnit &Self; 414bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 415bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 416bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 417bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 418bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 419a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.start(); 420bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 421bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 422a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.finish(); 423bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 424bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 425bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 426bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 4270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 4280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 429c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 430c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 431ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 432ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 433ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 434d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine &getDiagnostics() const { return *Diagnostics; } 435d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() { return *Diagnostics; } 4363687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 437405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 438405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 4390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 4404f32786ac45210143654390177105eb749b614e9Ted Kremenek const Preprocessor &getPreprocessor() const { return *PP; } 4414f32786ac45210143654390177105eb749b614e9Ted Kremenek Preprocessor &getPreprocessor() { return *PP; } 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4434f32786ac45210143654390177105eb749b614e9Ted Kremenek const ASTContext &getASTContext() const { return *Ctx; } 4444f32786ac45210143654390177105eb749b614e9Ted Kremenek ASTContext &getASTContext() { return *Ctx; } 4450853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 446abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis void setASTContext(ASTContext *ctx) { Ctx = ctx; } 447abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis 448914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 449914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 450914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 451914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 452914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 453914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 454405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 455405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 456f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 457389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 458389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 45977accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 460b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 461313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 462313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 463313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 4641872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek void addTemporaryFile(const llvm::sys::Path &TempFile); 465313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 4667d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 467f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 46815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 46915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 47015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 471f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 472f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 473f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 474213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 475686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMainFileName() const; 476213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 477eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 478eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 479eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 480f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 481eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 482eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 483eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 484f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 485eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 486eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 487f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 488eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 489eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 490eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 491eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 492eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 493eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 494eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 495eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 496eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 497eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 498eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 499eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 500eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 501eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 502eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 503eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 504eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 505eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 506eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 507eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 508eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 509eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 5108538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 511eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 512f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 513f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 5149b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief Retrieve a reference to the current top-level name hash value. 5159b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// 5169b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// Note: This is used internally by the top-level tracking action 5179b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 518507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 519507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 520507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// 521507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// The difference with SourceManager::getLocation is that this method checks 522507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// whether the requested location points inside the precompiled preamble 523507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// in which case the returned source location will be a "loaded" one. 524507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, 525507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 526507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 527507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:offset pair. 528507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, unsigned Offset) const; 529ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 530ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a loaded location from the preamble, returns 531ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// the corresponding local location of the main file, otherwise it returns 532ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \arg Loc. 533ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationFromPreamble(SourceLocation Loc); 534ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 535ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a local location of the main file but inside the 536ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble chunk, returns the corresponding loaded location from the 537ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble, otherwise it returns \arg Loc. 538ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationToPreamble(SourceLocation Loc); 539ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 540f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInPreambleFileID(SourceLocation Loc); 541f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInMainFileID(SourceLocation Loc); 542f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getStartOfMainFileID(); 543f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getEndOfPreambleFileID(); 544f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 545ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationFromPreamble. 546ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeFromPreamble(SourceRange R) { 547ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationFromPreamble(R.getBegin()), 548ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationFromPreamble(R.getEnd())); 549ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 550ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 551ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationToPreamble. 552ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeToPreamble(SourceRange R) { 553ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationToPreamble(R.getBegin()), 554ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationToPreamble(R.getEnd())); 555ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 556788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 557a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 5583e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef StoredDiagnostic *stored_diag_iterator; 5593e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef const StoredDiagnostic *stored_diag_const_iterator; 5603e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_begin() const { 561405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 562405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 5633e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_begin() { 5643e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin(); 5653e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5663e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_end() const { 5673e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.end(); 5683e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5693e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_end() { 570405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 571405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 572405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 5733e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis 5743e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_afterDriver_begin() { 5753e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size()) 5763e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis NumStoredDiagnosticsFromDriver = 0; 5773e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver; 578a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 579a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 58087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 58187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 58287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 58387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 58487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 58587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 58687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 58787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 58887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 58987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 59087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 59187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 59287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 59387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 594389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 595686775deca8b8685eb90801495880e3abdd844c2Chris Lattner llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 59675dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 597389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 598467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief Determine what kind of translation unit this AST represents. 599467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 600df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 601b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 602b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis FilenameOrMemBuf; 6034db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 6044db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 605b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 606b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 607b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 608b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis static ASTUnit *create(CompilerInvocation *CI, 609d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags); 610b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 6113c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 6120853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6133c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 6140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6155262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6165262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 61731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 6183c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 6193c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 620d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 621389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 6225cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 6234db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 624a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 625a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 626521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6274cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 6284cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 6294cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 6304cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6314cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 6324cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 6334cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6344cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 6354cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 6364cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 6374cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 6384cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 6394cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 640d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 641d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// object, by invoking the optionally provided ASTFrontendAction. 642d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 643d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param CI - The compiler invocation to use; it must have exactly one input 644d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 645d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 646d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Diags - The diagnostics engine to use for reporting errors; its 647d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// lifetime is expected to extend past that of the returned ASTUnit. 648d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 649d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 650d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// transfered. 651abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// 652abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// \param Unit - optionally an already created ASTUnit. Its ownership is not 653abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// transfered. 654d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 655d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 656abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTFrontendAction *Action = 0, 657abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTUnit *Unit = 0); 658d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis 659521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 660521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 661521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 662521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 663f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 664521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 6655262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6665262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 667521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 668521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 669521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 670f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 671d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 672a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 67344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 674df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 675467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 676dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor bool CacheCodeCompletionResults = false, 677ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 678521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6797b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 6807b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 6817b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6827b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 6837b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6847b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 6857b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6865262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6875262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 6887b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 689869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 6907b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 6917b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 6927b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 6937b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 6947b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 695d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 696686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef ResourceFilesPath, 6977b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 698e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 6994db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 700a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 701299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool RemappedFilesKeepOriginalName = true, 702df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 703467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 70499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CacheCodeCompletionResults = false, 705ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 706abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 707abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 708abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 709abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 710abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 711abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 712abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 713abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 7141abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 7151abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 7161abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 7171abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 718cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 719cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 720cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 721cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 722cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 723cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 724cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 725cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 726cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 727cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 728cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 7291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 7302283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 7312283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 732686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void CodeComplete(StringRef File, unsigned Line, unsigned Column, 7331abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 734cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 7351abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 736d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag, LangOptions &LangOpts, 7371abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 738686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 739686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 7407ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 7417ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 7427ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 74339c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /// \returns An indication of whether the save was successful or not. 744686775deca8b8685eb90801495880e3abdd844c2Chris Lattner CXSaveError Save(StringRef File); 745b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 746b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Serialize this translation unit with the given output stream. 747b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// 748b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \returns True if an error occurred, false otherwise. 7498cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner bool serialize(raw_ostream &OS); 7506aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 7516aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor virtual ModuleKey loadModule(SourceLocation ImportLoc, 7526aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor IdentifierInfo &ModuleName, 7536aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor SourceLocation ModuleNameLoc) { 7546aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor // ASTUnit doesn't know how to load modules (not that this matters). 7556aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor return 0; 7566aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor } 7570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 7580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 7600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7610853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 762