ASTUnit.h revision 900ab95e12bb7483971640a91075699eec391804
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 1705a07605322dfef2b017781042043a261c5a89cdSebastian Redl#include "clang/Serialization/ASTBitCodes.h" 18914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor#include "clang/Sema/Sema.h" 190a2c5e256abb4dc031c21fe4dc92c4f3afe9947cJohn McCall#include "clang/Sema/CodeCompleteConsumer.h" 206aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor#include "clang/Lex/ModuleLoader.h" 214ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 22478851c3ed6bd784e7377dffd8e57b200c1b9ba9Benjamin Kramer#include "clang/AST/ASTContext.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; 49e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidisclass CompilerInstance; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 51d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 55521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 56521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 57521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 58d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction; 59900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidisclass ASTDeserializationListener; 600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 613c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 620853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 636aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ASTUnit : public ModuleLoader { 64788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 65c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<LangOptions> LangOpts; 66c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics; 67c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<FileManager> FileMgr; 68c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<SourceManager> SourceMgr; 69c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith OwningPtr<HeaderSearch> HeaderInfo; 70c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<TargetInfo> Target; 71c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<Preprocessor> PP; 72c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<ASTContext> Ctx; 7362ba9f61af6177992d8cd2e3306257e1213b1bd3Argyrios Kyrtzidis ASTReader *Reader; 74389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 75900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis struct ASTWriterData; 76900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis OwningPtr<ASTWriterData> WriterData; 77900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis 78389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 79389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 80914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 81914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 826f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ASTConsumer> Consumer; 83914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 84914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 866f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Sema> TheSema; 87914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 88807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 89807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 90c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<CompilerInvocation> Invocation; 91914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 921aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// \brief The set of target features. 931aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// 941aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// FIXME: each time we reparse, we need to restore the set of target 951aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// features from this vector, because TargetInfo::CreateTargetInfo() 961aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// mangles the target options in place. Yuck! 971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor std::vector<std::string> TargetFeatures; 981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor 997d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 1007d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 1017d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 1027d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 103c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 104abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 105abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 106e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 107df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 108c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 109c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 110467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief What kind of translation unit this AST represents. 111467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind; 112df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 113213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 114213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 11515727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 11615727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis /// \brief Whether the ASTUnit should delete the remapped buffers. 11715727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool OwnsRemappedFileBuffers; 118213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 119f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 120f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 121f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 122f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 123f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 127332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 128332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Sorted (by file offset) vector of pairs of file offset/Decl. 129332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef SmallVector<std::pair<unsigned, Decl *>, 64> LocDeclsTy; 130332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef llvm::DenseMap<FileID, LocDeclsTy *> FileDeclsTy; 131332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 132332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Map from FileID to the file-level declarations that it contains. 133332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// The files and decls are only local (and non-preamble) ones. 134332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis FileDeclsTy FileDecls; 13589d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 13668d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 13768d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 13868d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 139f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The set of diagnostics produced when creating the preamble. 140686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 141f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 142a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 143a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 144686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 145a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 146e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// \brief The set of diagnostics produced when failing to parse, e.g. due 147e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// to failure to load the PCH. 148e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis SmallVector<StoredDiagnostic, 4> FailedParseDiagnostics; 149e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis 1504cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1514cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1534cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 157eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 158eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 159eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 160eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 161eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 162eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 163eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 164eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 165eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 166eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 1671872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek 168ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidispublic: 169507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis class PreambleData { 170507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const FileEntry *File; 171507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis std::vector<char> Buffer; 172507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis mutable unsigned NumLines; 173507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 174507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis public: 175507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData() : File(0), NumLines(0) { } 176507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 177507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void assign(const FileEntry *F, const char *begin, const char *end) { 178507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis File = F; 179507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis Buffer.assign(begin, end); 180507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis NumLines = 0; 181507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 182507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 183507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void clear() { Buffer.clear(); File = 0; NumLines = 0; } 184507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 185507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis size_t size() const { return Buffer.size(); } 186507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis bool empty() const { return Buffer.empty(); } 187507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 188507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const char *getBufferStart() const { return &Buffer[0]; } 189507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 190507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned getNumLines() const { 191507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis if (NumLines) 192507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 193507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis countLines(); 194507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 195507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 196507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 197ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange getSourceRange(const SourceManager &SM) const { 198ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID()); 199ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1)); 200ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 201ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 202507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis private: 203507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void countLines() const; 204507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis }; 205507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 206ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis const PreambleData &getPreambleData() const { 207ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return Preamble; 208ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 209ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 210ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidisprivate: 211ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 212175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 213175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 214507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData Preamble; 215175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 216f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 217f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 218f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 219f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 220f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 221f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 222175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 223175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 224175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 225cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 226cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 227cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 228cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 229cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 230cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 231cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 232cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 23328233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 23428233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 23528233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 23628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 237c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 238671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 239671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 240671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 241671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 242671947b18dba342f9aba022ee992babef325a833Douglas Gregor 243c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 244c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 245d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// This value will be used to restore the state of the \c DiagnosticsEngine 246d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// object when re-using the precompiled preamble. Note that only the 247c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 248c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 249c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 250c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2513c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 252eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2538538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 25489d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 25587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 256d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool ShouldCacheCodeCompletionResults : 1; 257d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko 258d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /// \brief Whether to include brief documentation within the set of code 259d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /// completions cached. 260d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool IncludeBriefCommentsInCodeCompletion : 1; 261ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis 262ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// \brief True if non-system source files should be treated as volatile 263ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// (likely to change while trying to use them). 264ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile : 1; 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 /// 291026b3588b9916f3fcb20ad2f02ca5472cbbdc5d7Richard Smith /// The bits in the bitmask correspond to the values of 292026b3588b9916f3fcb20ad2f02ca5472cbbdc5d7Richard Smith /// CodeCompleteContext::Kind. To map from a completion context kind to a 293026b3588b9916f3fcb20ad2f02ca5472cbbdc5d7Richard Smith /// bit, shift 1 by that number of bits. Many completions can occur in 294026b3588b9916f3fcb20ad2f02ca5472cbbdc5d7Richard Smith /// several different contexts. 295026b3588b9916f3fcb20ad2f02ca5472cbbdc5d7Richard Smith uint64_t ShowInContexts; 29687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 30187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 30287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 3031827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 30458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 30558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 30658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 3071827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 3081827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 309f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 310f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 311f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 312f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 313f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 314f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 315f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 316f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 31787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 31887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 319f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 320f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 321f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 322f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 323f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 324f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 32548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 326c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 32748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor getCachedCompletionAllocator() { 32848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor return CachedCompletionAllocator; 32948601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor } 33028a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis 33128a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis CodeCompletionTUInfo &getCodeCompletionTUInfo() { 33228a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis if (!CCTUInfo) 33328a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis CCTUInfo.reset(new CodeCompletionTUInfo( 33428a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis new GlobalCodeCompletionAllocator)); 33528a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis return *CCTUInfo; 3368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 33728a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis 33887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 339218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor /// \brief Allocator used to store cached code completions. 340c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 34148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor CachedCompletionAllocator; 3428fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 34328a83f57003469fb615ad27dd34bcf5b0a10da8cArgyrios Kyrtzidis OwningPtr<CodeCompletionTUInfo> CCTUInfo; 344218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor 34587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 34687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 34787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 348f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 349f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 350f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 351f5586f6b311c98e1022a8fe0609053849b70d323Douglas 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 file. 354727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3559b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3569b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache. 3579b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CompletionCacheTopLevelHashValue; 358727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 3599b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3609b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the precompiled preamble. 361727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3629b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3639b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache after a rebuild of the precompiled preamble. 3649b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned PreambleTopLevelHashValue; 365ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3669b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief The current hash value for the top-level declaration and macro 3679b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// definition names 3689b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CurrentTopLevelHashValue; 3699b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 370ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 371ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 372ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 373ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 374c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 375c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 37687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 37787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 37887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 37987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 38087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 381f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko ASTUnit(const ASTUnit &) LLVM_DELETED_FUNCTION; 382f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko void operator=(const ASTUnit &) LLVM_DELETED_FUNCTION; 383bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3843687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3858b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 386abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 387754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 388175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 389f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 390df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 391df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 392175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 393df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 39401b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor const CompilerInvocation &PreambleInvocationIn, 395df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 396df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 397eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 398e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis 399e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// \brief Transfers ownership of the objects (like SourceManager) from 400e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// \param CI to this ASTUnit. 401e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis void transferASTDataFromCompilerInstance(CompilerInstance &CI); 402e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis 403a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// \brief Allows us to assert that ASTUnit is not being used concurrently, 404a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// which is not supported. 405a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// 406a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Clients should create instances of the ConcurrencyCheck class whenever 407a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// using the ASTUnit in a way that isn't intended to be concurrent, which is 408a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// just about any usage. 409a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis /// Becomes a noop in release mode; only useful for debug mode checking. 410a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis class ConcurrencyState { 411d3cb28bef1e1d397b35126029465f2b7e8e8dc1fBenjamin Kramer#ifndef NDEBUG 412a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void *Mutex; // a llvm::sys::MutexImpl in debug; 413d3cb28bef1e1d397b35126029465f2b7e8e8dc1fBenjamin Kramer#endif 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 475900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis ASTDeserializationListener *getDeserializationListener(); 476900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis 477313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 478313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 479313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 4801872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek void addTemporaryFile(const llvm::sys::Path &TempFile); 481313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 4827d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 483f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 48415727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 48515727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 48615727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 487686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMainFileName() const; 488213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 489eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 490eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 491eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 492f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 493eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 494eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 495eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 496f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 497eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 498eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 499f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 500eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 501eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 502eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 503eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 504eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 505eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 506eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 507eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 508eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 509eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 510eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 511eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 512eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 513eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 514eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 515eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 516eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 517eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 518eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 519eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 520332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Add a new local file-level declaration. 521332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis void addFileLevelDecl(Decl *D); 522332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 523dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis /// \brief Get the decls that are contained in a file in the Offset/Length 5241824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// range. \p Length can be 0 to indicate a point at \p Offset instead of 525dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis /// a range. 526dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length, 527dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis SmallVectorImpl<Decl *> &Decls); 528dfb332d0081c6641d1dbae6a2aeff757c99cc740Argyrios Kyrtzidis 529eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 530eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 5318538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 532eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 533f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 534f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 5359b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief Retrieve a reference to the current top-level name hash value. 5369b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// 5379b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// Note: This is used internally by the top-level tracking action 5389b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 539507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 540507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 541507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// 542507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// The difference with SourceManager::getLocation is that this method checks 543507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// whether the requested location points inside the precompiled preamble 544507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// in which case the returned source location will be a "loaded" one. 545507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, 546507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 547507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 548507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:offset pair. 549507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, unsigned Offset) const; 550ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 5511824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// \brief If \p Loc is a loaded location from the preamble, returns 552ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// the corresponding local location of the main file, otherwise it returns 5531824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// \p Loc. 554ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationFromPreamble(SourceLocation Loc); 555ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 5561824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// \brief If \p Loc is a local location of the main file but inside the 557ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble chunk, returns the corresponding loaded location from the 5581824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// preamble, otherwise it returns \p Loc. 559ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationToPreamble(SourceLocation Loc); 560ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 561f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInPreambleFileID(SourceLocation Loc); 562f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInMainFileID(SourceLocation Loc); 563f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getStartOfMainFileID(); 564f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getEndOfPreambleFileID(); 565f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 566e23fb90712233bdfa04387e48b54a7168e23cb3eDmitri Gribenko /// \see mapLocationFromPreamble. 567ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeFromPreamble(SourceRange R) { 568ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationFromPreamble(R.getBegin()), 569ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationFromPreamble(R.getEnd())); 570ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 571ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 572e23fb90712233bdfa04387e48b54a7168e23cb3eDmitri Gribenko /// \see mapLocationToPreamble. 573ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeToPreamble(SourceRange R) { 574ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationToPreamble(R.getBegin()), 575ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationToPreamble(R.getEnd())); 576ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 577788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 578a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 5793e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef StoredDiagnostic *stored_diag_iterator; 5803e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef const StoredDiagnostic *stored_diag_const_iterator; 5813e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_begin() const { 582405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 583405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 5843e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_begin() { 5853e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin(); 5863e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5873e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_end() const { 5883e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.end(); 5893e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5903e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_end() { 591405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 592405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 593405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 5943e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis 5953e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_afterDriver_begin() { 5963e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size()) 5973e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis NumStoredDiagnosticsFromDriver = 0; 5983e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver; 599a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 600a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 60187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 60287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 60387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 60487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 60587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 60687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 60787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 60887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 60987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 61087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 61187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 61287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 61387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 61487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 615389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 616632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis /// \brief Returns an iterator range for the local preprocessing entities 617632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis /// of the local Preprocessor, if this is a parsed source file, or the loaded 618632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis /// preprocessing entities of the primary module if this is an AST file. 619632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator> 620632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis getLocalPreprocessingEntities() const; 621632dcc92f60ab7f806a89c5bca3a0951763a9219Argyrios Kyrtzidis 6222093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// \brief Type for a function iterating over a number of declarations. 6232093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// \returns true to continue iteration and false to abort. 62495c579cae01118eadd311d445ff7f491d0011fb0Argyrios Kyrtzidis typedef bool (*DeclVisitorFn)(void *context, const Decl *D); 6252093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis 6262093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// \brief Iterate over local declarations (locally parsed if this is a parsed 6272093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// source file or the loaded declarations of the primary module if this is an 6282093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// AST file). 6292093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis /// \returns true if the iteration was complete or false if it was aborted. 63095c579cae01118eadd311d445ff7f491d0011fb0Argyrios Kyrtzidis bool visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn); 6312093e0bc4e436b1b2791d5423fb3274dd37231b8Argyrios Kyrtzidis 6323da76bfbd24b2747ceb72d1918bbbe3123dac841Argyrios Kyrtzidis /// \brief Get the PCH file if one was included. 6333da76bfbd24b2747ceb72d1918bbbe3123dac841Argyrios Kyrtzidis const FileEntry *getPCHFile(); 6343da76bfbd24b2747ceb72d1918bbbe3123dac841Argyrios Kyrtzidis 63562288edde26ff4af9fc079c979a0e1bdc577ce9dArgyrios Kyrtzidis /// \brief Returns true if the ASTUnit was constructed from a serialized 63662288edde26ff4af9fc079c979a0e1bdc577ce9dArgyrios Kyrtzidis /// module file. 63762288edde26ff4af9fc079c979a0e1bdc577ce9dArgyrios Kyrtzidis bool isModuleFile(); 63862288edde26ff4af9fc079c979a0e1bdc577ce9dArgyrios Kyrtzidis 639686775deca8b8685eb90801495880e3abdd844c2Chris Lattner llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 64075dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 641389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 642467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief Determine what kind of translation unit this AST represents. 643467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 644df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 645b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 646b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis FilenameOrMemBuf; 6474db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 6484db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 649b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 650b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 651b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 652b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis static ASTUnit *create(CompilerInvocation *CI, 653c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 654ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool CaptureDiagnostics, 655ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile); 656b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 6573c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 6580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6593c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 6600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6615262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6625262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 66331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 6643c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 6653c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 666c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 667389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 6685cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 6694db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 670a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 671bef35c91b594f66216f4aab303b71a6c5ab7abcfArgyrios Kyrtzidis bool CaptureDiagnostics = false, 672ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool AllowPCHWithCompilerErrors = false, 673ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile = false); 674521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6754cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 6764cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 6774cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 6784cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6794cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 6804cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 6814cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6824cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 6834cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 6844cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 6854cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 6864cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 6874cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 688d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 689d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// object, by invoking the optionally provided ASTFrontendAction. 690d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 691d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param CI - The compiler invocation to use; it must have exactly one input 692d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 693d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 694d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Diags - The diagnostics engine to use for reporting errors; its 695d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// lifetime is expected to extend past that of the returned ASTUnit. 696d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 697d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 698d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// transfered. 699abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// 700abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// \param Unit - optionally an already created ASTUnit. Its ownership is not 701abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// transfered. 7026f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// 7036f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// \param Persistent - if true the returned ASTUnit will be complete. 7046f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// false means the caller is only interested in getting info through the 7056f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis /// provided \see Action. 706e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// 707e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// \param ErrAST - If non-null and parsing failed without any AST to return 708e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// (e.g. because the PCH could not be loaded), this accepts the ASTUnit 709e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// mainly to allow the caller to see the diagnostics. 710e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// This will only receive an ASTUnit if a new one was created. If an already 71170517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// created ASTUnit was passed in \p Unit then the caller can check that. 712e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// 713d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 714c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 715abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTFrontendAction *Action = 0, 7166f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis ASTUnit *Unit = 0, 7176f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool Persistent = true, 7186f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis StringRef ResourceFilesPath = StringRef(), 7196f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool OnlyLocalDecls = false, 7206f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool CaptureDiagnostics = false, 7216f3ce979a7748fd117e6473d6272b16d643b6262Argyrios Kyrtzidis bool PrecompilePreamble = false, 722e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis bool CacheCodeCompletionResults = false, 723d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool IncludeBriefCommentsInCodeCompletion = false, 724ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile = false, 725e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis OwningPtr<ASTUnit> *ErrAST = 0); 726d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis 727521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 728521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 729521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 730521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 731f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 732521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 7335262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 7345262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 735521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 736521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 737521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 738f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 739c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 740a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 74144c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 742df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 743467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 744d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool CacheCodeCompletionResults = false, 745ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool IncludeBriefCommentsInCodeCompletion = false, 746ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile = false); 747521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 7487b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 7497b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 7507b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7517b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 7527b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7537b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 7547b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7555262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 7565262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 7577b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 758869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 759e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// 760e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// \param ErrAST - If non-null and parsing failed without any AST to return 761e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// (e.g. because the PCH could not be loaded), this accepts the ASTUnit 762e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// mainly to allow the caller to see the diagnostics. 763e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis /// 7647b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 7657b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 7667b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 7677b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 768c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 769686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef ResourceFilesPath, 7707b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 771e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 7724db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 773a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 774299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool RemappedFilesKeepOriginalName = true, 775df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 776467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 777bef35c91b594f66216f4aab303b71a6c5ab7abcfArgyrios Kyrtzidis bool CacheCodeCompletionResults = false, 778d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool IncludeBriefCommentsInCodeCompletion = false, 779e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis bool AllowPCHWithCompilerErrors = false, 7806a91d385618ea4d28236c496f540a26877c95525Erik Verbruggen bool SkipFunctionBodies = false, 781ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile = false, 782900ab95e12bb7483971640a91075699eec391804Argyrios Kyrtzidis bool ForSerialization = false, 783e722ed6f5464232e23be52f4976312ef526fae99Argyrios Kyrtzidis OwningPtr<ASTUnit> *ErrAST = 0); 784abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 785abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 786abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 787abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 788abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 789abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 790abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 791abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 7921abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 7931abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 7941abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 7951abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 796cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 797cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 798cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 799cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 800cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 801cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 802cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 803cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 804cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 805cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 806cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 8071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 808d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /// \param IncludeBriefComments Whether to include brief documentation within 809d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /// the set of code completions returned. 810d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko /// 8112283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 8122283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 813686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void CodeComplete(StringRef File, unsigned Line, unsigned Column, 8141abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 815cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 816d99ef536b241071b6f4c01db6525dc03242ac30bDmitri Gribenko bool IncludeBriefComments, 8171abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 818d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag, LangOptions &LangOpts, 8191abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 820686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 821686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 8227ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 8237ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 8247ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 825e6d22027bc22d3767a2acdc80299c76b91159867Argyrios Kyrtzidis /// \returns true if there was a file error or false if the save was 826e6d22027bc22d3767a2acdc80299c76b91159867Argyrios Kyrtzidis /// successful. 827e6d22027bc22d3767a2acdc80299c76b91159867Argyrios Kyrtzidis bool Save(StringRef File); 828b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 829b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Serialize this translation unit with the given output stream. 830b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// 831b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \returns True if an error occurred, false otherwise. 8328cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner bool serialize(raw_ostream &OS); 8336aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 8345e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor virtual Module *loadModule(SourceLocation ImportLoc, ModuleIdPath Path, 83593ebfa6139bbca4d446c7343e3afc8e5ec777484Douglas Gregor Module::NameVisibilityKind Visibility, 83693ebfa6139bbca4d446c7343e3afc8e5ec777484Douglas Gregor bool IsInclusionDirective) { 8376aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor // ASTUnit doesn't know how to load modules (not that this matters). 8386aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor return 0; 8396aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor } 8400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 8410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 8420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 8430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 8440853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 845