ASTUnit.h revision c93dc7889644293e318e19d82830ea2acc45b678
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" 23d3b74d9ca4f239a7a90ad193378c494306c57352Ted Kremenek#include "clang/Basic/LangOptions.h" 2431b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 25eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 26389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h" 2787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2828019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 290853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 30a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 31cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 3203013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/Path.h" 33788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 340853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 35f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 36f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 38cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 414db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 424db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 440853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 46f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregorclass ASTReader; 471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 49521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 50d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 55521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 56521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 57d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction; 580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 59f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 6044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 6148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor/// \brief Allocator for a cached set of global code completions. 6248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregorclass GlobalCodeCompletionAllocator 6348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor : public CodeCompletionAllocator, 64c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith public RefCountedBase<GlobalCodeCompletionAllocator> 6548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor{ 6648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 6748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor}; 6848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 693c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 700853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 716aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ASTUnit : public ModuleLoader { 72788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 73c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<LangOptions> LangOpts; 74c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics; 75c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<FileManager> FileMgr; 76c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<SourceManager> SourceMgr; 77c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith OwningPtr<HeaderSearch> HeaderInfo; 78c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<TargetInfo> Target; 79c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<Preprocessor> PP; 80c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<ASTContext> Ctx; 8162ba9f61af6177992d8cd2e3306257e1213b1bd3Argyrios Kyrtzidis ASTReader *Reader; 82389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 83389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 84389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 876f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ASTConsumer> Consumer; 88914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 89914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 90914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 916f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Sema> TheSema; 92914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 93807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 94807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 95c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<CompilerInvocation> Invocation; 96914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// \brief The set of target features. 981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// 991aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// FIXME: each time we reparse, we need to restore the set of target 1001aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// features from this vector, because TargetInfo::CreateTargetInfo() 1011aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// mangles the target options in place. Yuck! 1021aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor std::vector<std::string> TargetFeatures; 1031aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor 1047d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 1057d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 1067d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 1077d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 108c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 109abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 110abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 111e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 112df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 113c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 114c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 115467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief What kind of translation unit this AST represents. 116467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind; 117df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 118213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 119213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 12015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 12115727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis /// \brief Whether the ASTUnit should delete the remapped buffers. 12215727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool OwnsRemappedFileBuffers; 123213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 127f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 128f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 129f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 130f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 131f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 132332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 133332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Sorted (by file offset) vector of pairs of file offset/Decl. 134332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef SmallVector<std::pair<unsigned, Decl *>, 64> LocDeclsTy; 135332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef llvm::DenseMap<FileID, LocDeclsTy *> FileDeclsTy; 136332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 137332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Map from FileID to the file-level declarations that it contains. 138332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// The files and decls are only local (and non-preamble) ones. 139332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis FileDeclsTy FileDecls; 14089d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 14168d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 14268d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 14368d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 144f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 145f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 146f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 147f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The set of diagnostics produced when creating the preamble. 148686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 149f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 150a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 151a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 152686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 153a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1574cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1584cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1594cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1604cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 161eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 162eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 163eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 164eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 165eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 166eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 167eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 168eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 169eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 170eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 1711872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek 172ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidispublic: 173507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis class PreambleData { 174507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const FileEntry *File; 175507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis std::vector<char> Buffer; 176507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis mutable unsigned NumLines; 177507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 178507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis public: 179507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData() : File(0), NumLines(0) { } 180507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 181507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void assign(const FileEntry *F, const char *begin, const char *end) { 182507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis File = F; 183507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis Buffer.assign(begin, end); 184507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis NumLines = 0; 185507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 186507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 187507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void clear() { Buffer.clear(); File = 0; NumLines = 0; } 188507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 189507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis size_t size() const { return Buffer.size(); } 190507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis bool empty() const { return Buffer.empty(); } 191507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 192507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const char *getBufferStart() const { return &Buffer[0]; } 193507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 194507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned getNumLines() const { 195507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis if (NumLines) 196507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 197507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis countLines(); 198507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 199507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 200507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 201ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange getSourceRange(const SourceManager &SM) const { 202ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID()); 203ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1)); 204ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 205ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 206507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis private: 207507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void countLines() const; 208507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis }; 209507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 210ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis const PreambleData &getPreambleData() const { 211ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return Preamble; 212ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 213ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 214ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidisprivate: 215ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 216175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 217175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 218507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData Preamble; 219175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 220f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 221f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 222f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 223f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 224f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 225f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 226175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 227175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 228175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 229cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 230cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 231cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 232cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 233cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 234cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 235cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 236cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 23728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 23828233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 23928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 24028233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 241c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 242671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 243671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 244671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 245671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 246671947b18dba342f9aba022ee992babef325a833Douglas Gregor 247c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 248c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 249d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// This value will be used to restore the state of the \c DiagnosticsEngine 250d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// object when re-using the precompiled preamble. Note that only the 251c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 252c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 253c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 254c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2553c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 256eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2578538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 25889d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 25987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 26087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 26187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 262ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /// \brief Whether we want to include nested macro expansions in the 263dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /// detailed preprocessing record. 264ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions; 2653e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 2663e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor /// \brief The language options used when we load an AST file. 2673e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor LangOptions ASTFileLangOpts; 2683e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 269c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith static void ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> &Diags, 2700b53cf834346d78985aaa9e7300445a39c245614Douglas Gregor const char **ArgBegin, const char **ArgEnd, 271e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor ASTUnit &AST, bool CaptureDiagnostics); 272e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 273686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName, 274f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SourceManager &SrcMan, 275686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const SmallVectorImpl<StoredDiagnostic> &Diags, 276686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &Out); 277f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 278332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis void clearFileLevelDecls(); 279332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 28087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 28187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 28287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 28387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 28487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 28587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 28687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 28787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 28887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 28987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 29087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 29187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 29287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 29387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 29487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 29587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 29687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 29787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 30187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 30287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 30387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 3041827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 30558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 30658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 30758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 3081827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 3091827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 310f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 311f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 312f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 313f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 314f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 315f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 316f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 317f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 31887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 31987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 320f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 321f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 322f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 323f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 324f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 325f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 32648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 327c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 32848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor getCachedCompletionAllocator() { 32948601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor return CachedCompletionAllocator; 33048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor } 33148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 3328fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 3338fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// Creates the allocator if it doesn't already exist. 334c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3358fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor getCursorCompletionAllocator() { 3368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor if (!CursorCompletionAllocator.getPtr()) { 3378fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator = new GlobalCodeCompletionAllocator; 3388fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3398fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor return CursorCompletionAllocator; 3408fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3418fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 34287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 343218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor /// \brief Allocator used to store cached code completions. 344c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 34548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor CachedCompletionAllocator; 3468fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 3478fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Allocator used to store code completions for arbitrary cursors. 348c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3498fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator; 350218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor 35187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 35287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 35387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 354f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 355f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 356f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 357f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 3589b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3599b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the file. 360727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3619b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3629b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache. 3639b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CompletionCacheTopLevelHashValue; 364727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 3659b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3669b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the precompiled preamble. 367727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3689b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3699b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache after a rebuild of the precompiled preamble. 3709b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned PreambleTopLevelHashValue; 371ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3729b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief The current hash value for the top-level declaration and macro 3739b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// definition names 3749b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CurrentTopLevelHashValue; 3759b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 376ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 377ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 378ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 379ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 380c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 381c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 38287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 38387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 38487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 38587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 38687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 38731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 38831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 389bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3903687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3918b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 392abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 393754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 394175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 395f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 396df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 397df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 398175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 399df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 40001b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor const CompilerInvocation &PreambleInvocationIn, 401df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 402df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 403eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 40489d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 405a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// \brief Allows us to assert that ASTUnit is not being used concurrently, 406a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// which is not supported. 407a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// 408a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Clients should create instances of the ConcurrencyCheck class whenever 409a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// using the ASTUnit in a way that isn't intended to be concurrent, which is 410a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// just about any usage. 411a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Becomes a noop in release mode; only useful for debug mode checking. 412a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis class ConcurrencyState { 413a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void *Mutex; // a llvm::sys::MutexImpl in debug; 414a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 415a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis public: 416a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState(); 417a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ~ConcurrencyState(); 418a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 419a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void start(); 420a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void finish(); 421a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis }; 422a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState ConcurrencyCheckValue; 423a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 4240853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 425bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 426a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ASTUnit &Self; 427bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 428bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 429bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 430bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 431bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 432a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.start(); 433bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 434bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 435a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.finish(); 436bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 437bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 438bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 439bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 4400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 4410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 442c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 443c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 444ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 445ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 446ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 447d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine &getDiagnostics() const { return *Diagnostics; } 448d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() { return *Diagnostics; } 4493687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 450405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 451405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 4520853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 4534f32786ac45210143654390177105eb749b614e9Ted Kremenek const Preprocessor &getPreprocessor() const { return *PP; } 4544f32786ac45210143654390177105eb749b614e9Ted Kremenek Preprocessor &getPreprocessor() { return *PP; } 4551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4564f32786ac45210143654390177105eb749b614e9Ted Kremenek const ASTContext &getASTContext() const { return *Ctx; } 4574f32786ac45210143654390177105eb749b614e9Ted Kremenek ASTContext &getASTContext() { return *Ctx; } 4580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 459abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis void setASTContext(ASTContext *ctx) { Ctx = ctx; } 4607fe90f3bfa6bd7f779ecfd4ba201a296a3a1c8cbArgyrios Kyrtzidis void setPreprocessor(Preprocessor *pp); 461abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis 462914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 463914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 464914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 465914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 466914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 467914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 468405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 469405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 470f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 471389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 472389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 47377accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 474b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 475313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 476313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 477313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 4781872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek void addTemporaryFile(const llvm::sys::Path &TempFile); 479313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 4807d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 481f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 48215727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 48315727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 48415727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 485f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 486f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 487f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 488213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 489686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMainFileName() const; 490213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 491eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 492eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 493eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 494f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 495eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 496eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 497eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 498f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 499eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 500eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 501f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 502eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 503eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 504eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 505eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 506eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 507eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 508eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 509eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 510eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 511eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 512eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 513eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 514eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 515eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 516eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 517eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 518eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 519eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 520eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 521eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 522332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Add a new local file-level declaration. 523332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis void addFileLevelDecl(Decl *D); 524332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 525dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis /// \brief Get the decls that are contained in a file in the Offset/Length 526dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis /// range. \arg Length can be 0 to indicate a point at \arg Offset instead of 527dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis /// a range. 528dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length, 529dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis SmallVectorImpl<Decl *> &Decls); 530dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis 531eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 532eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 5338538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 534eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 535f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 536f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 5379b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief Retrieve a reference to the current top-level name hash value. 5389b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// 5399b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// Note: This is used internally by the top-level tracking action 5409b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 541507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 542507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 543507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// 544507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// The difference with SourceManager::getLocation is that this method checks 545507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// whether the requested location points inside the precompiled preamble 546507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// in which case the returned source location will be a "loaded" one. 547507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, 548507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 549507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 550507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:offset pair. 551507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, unsigned Offset) const; 552ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 553ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a loaded location from the preamble, returns 554ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// the corresponding local location of the main file, otherwise it returns 555ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \arg Loc. 556ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationFromPreamble(SourceLocation Loc); 557ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 558ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a local location of the main file but inside the 559ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble chunk, returns the corresponding loaded location from the 560ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble, otherwise it returns \arg Loc. 561ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationToPreamble(SourceLocation Loc); 562ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 563f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInPreambleFileID(SourceLocation Loc); 564f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInMainFileID(SourceLocation Loc); 565f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getStartOfMainFileID(); 566f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getEndOfPreambleFileID(); 567f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 568ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationFromPreamble. 569ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeFromPreamble(SourceRange R) { 570ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationFromPreamble(R.getBegin()), 571ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationFromPreamble(R.getEnd())); 572ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 573ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 574ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationToPreamble. 575ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeToPreamble(SourceRange R) { 576ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationToPreamble(R.getBegin()), 577ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationToPreamble(R.getEnd())); 578ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 579788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 580a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 5813e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef StoredDiagnostic *stored_diag_iterator; 5823e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef const StoredDiagnostic *stored_diag_const_iterator; 5833e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_begin() const { 584405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 585405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 5863e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_begin() { 5873e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin(); 5883e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5893e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_end() const { 5903e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.end(); 5913e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5923e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_end() { 593405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 594405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 595405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 5963e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis 5973e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_afterDriver_begin() { 5983e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size()) 5993e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis NumStoredDiagnosticsFromDriver = 0; 6003e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver; 601a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 602a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 60387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 60487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 60587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 60687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 60787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 60887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 60987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 61087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 61187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 61287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 61387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 61487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 61587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 61687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 617389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 618686775deca8b8685eb90801495880e3abdd844c2Chris Lattner llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 61975dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 620389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 621467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief Determine what kind of translation unit this AST represents. 622467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 623df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 624b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 625b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis FilenameOrMemBuf; 6264db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 6274db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 628b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 629b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 630b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 631b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis static ASTUnit *create(CompilerInvocation *CI, 632c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 633991bf49f68e8caeb900dd9738712b861073363d9Argyrios Kyrtzidis bool CaptureDiagnostics = false); 634b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 6353c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 6360853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6373c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 6380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6395262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6405262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 64131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 6423c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 6433c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 644c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 645389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 6465cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 6474db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 648a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 649a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 650521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6514cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 6524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 6534cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 6544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 6564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 6574cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6584cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 6594cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 6604cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 6614cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 6624cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 6634cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 664d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 665d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// object, by invoking the optionally provided ASTFrontendAction. 666d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 667d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param CI - The compiler invocation to use; it must have exactly one input 668d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 669d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 670d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Diags - The diagnostics engine to use for reporting errors; its 671d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// lifetime is expected to extend past that of the returned ASTUnit. 672d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 673d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 674d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// transfered. 675abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// 676abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// \param Unit - optionally an already created ASTUnit. Its ownership is not 677abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// transfered. 6786f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// 6796f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// \param Persistent - if true the returned ASTUnit will be complete. 6806f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// false means the caller is only interested in getting info through the 6816f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// provided \see Action. 682d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 683c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 684abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTFrontendAction *Action = 0, 6856f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis ASTUnit *Unit = 0, 6866f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool Persistent = true, 6876f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis StringRef ResourceFilesPath = StringRef(), 6886f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool OnlyLocalDecls = false, 6896f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool CaptureDiagnostics = false, 6906f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool PrecompilePreamble = false, 6916f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool CacheCodeCompletionResults = false); 692d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis 693521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 694521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 695521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 696521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 697f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 698521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 6995262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 7005262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 701521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 702521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 703521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 704f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 705c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 706a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 70744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 708df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 709467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 710dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor bool CacheCodeCompletionResults = false, 711ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 712521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 7137b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 7147b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 7157b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7167b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 7177b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7187b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 7197b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7205262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 7215262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 7227b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 723869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 7247b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 7257b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 7267b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 7277b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 7287b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 729c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 730686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef ResourceFilesPath, 7317b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 732e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 7334db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 734a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 735299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool RemappedFilesKeepOriginalName = true, 736df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 737467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 73899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CacheCodeCompletionResults = false, 739ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 740abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 741abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 742abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 743abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 744abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 745abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 746abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 747abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 7481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 7491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 7501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 7511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 752cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 753cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 754cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 755cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 756cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 757cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 758cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 759cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 760cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 761cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 762cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 7631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 7642283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 7652283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 766686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void CodeComplete(StringRef File, unsigned Line, unsigned Column, 7671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 768cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 7691abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 770d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag, LangOptions &LangOpts, 7711abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 772686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 773686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 7747ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 7757ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 7767ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 77739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /// \returns An indication of whether the save was successful or not. 778686775deca8b8685eb90801495880e3abdd844c2Chris Lattner CXSaveError Save(StringRef File); 779b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 780b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Serialize this translation unit with the given output stream. 781b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// 782b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \returns True if an error occurred, false otherwise. 7838cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner bool serialize(raw_ostream &OS); 7846aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 7855e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor virtual Module *loadModule(SourceLocation ImportLoc, ModuleIdPath Path, 78693ebfa6139bbca4d446c7343e3afc8e5ec777484Douglas Gregor Module::NameVisibilityKind Visibility, 78793ebfa6139bbca4d446c7343e3afc8e5ec777484Douglas Gregor bool IsInclusionDirective) { 7886aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor // ASTUnit doesn't know how to load modules (not that this matters). 7896aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor return 0; 7906aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor } 7910853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 7920853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7930853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 7940853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7950853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 796