ASTUnit.h revision 62ba9f61af6177992d8cd2e3306257e1213b1bd3
14b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===--- ASTUnit.h - ASTUnit utility ----------------------------*- C++ -*-===// 24b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 34b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 44b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 54b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 64b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 74b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 84b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 94b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 104b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// ASTUnit utility class. 114b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 124b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 134b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis 140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H 150853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#define LLVM_CLANG_FRONTEND_ASTUNIT_H 160853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 17eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Index/ASTLocation.h" 1805a07605322dfef2b017781042043a261c5a89cdSebastian Redl#include "clang/Serialization/ASTBitCodes.h" 19914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor#include "clang/Sema/Sema.h" 200a2c5e256abb4dc031c21fe4dc92c4f3afe9947cJohn McCall#include "clang/Sema/CodeCompleteConsumer.h" 216aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor#include "clang/Lex/ModuleLoader.h" 224ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 24eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 25389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h" 2687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2728019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 29a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 30cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 3103013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/Path.h" 32788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 330853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 34f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 35f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 37cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 414db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 45f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregorclass ASTReader; 461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 49d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 55521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 56d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction; 570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 58f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 6048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor/// \brief Allocator for a cached set of global code completions. 6148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregorclass GlobalCodeCompletionAllocator 6248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor : public CodeCompletionAllocator, 6348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor public llvm::RefCountedBase<GlobalCodeCompletionAllocator> 6448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor{ 6548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 6648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor}; 6748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 683c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 706aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ASTUnit : public ModuleLoader { 71788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 72d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics; 73d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<FileManager> FileMgr; 74d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<SourceManager> SourceMgr; 75d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::OwningPtr<HeaderSearch> HeaderInfo; 76d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<TargetInfo> Target; 77d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<Preprocessor> PP; 78d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<ASTContext> Ctx; 7962ba9f61af6177992d8cd2e3306257e1213b1bd3Argyrios Kyrtzidis ASTReader *Reader; 80389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 81389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 82389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 83914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 84914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 87914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 88914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 89914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 90914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 91807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 92807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 934f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<CompilerInvocation> Invocation; 94914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 951aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// \brief The set of target features. 961aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// 971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// FIXME: each time we reparse, we need to restore the set of target 981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// features from this vector, because TargetInfo::CreateTargetInfo() 991aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// mangles the target options in place. Yuck! 1001aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor std::vector<std::string> TargetFeatures; 1011aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor 1027d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 1037d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 1047d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 1057d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 106c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 107abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 108abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 109e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 110df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 111c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 112c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 113467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief What kind of translation unit this AST represents. 114467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind; 115df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 116213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 117213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 11815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 11915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis /// \brief Whether the ASTUnit should delete the remapped buffers. 12015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool OwnsRemappedFileBuffers; 121213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 122f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 123f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 127f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 128f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 129f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 130332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 131332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Sorted (by file offset) vector of pairs of file offset/Decl. 132332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef SmallVector<std::pair<unsigned, Decl *>, 64> LocDeclsTy; 133332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis typedef llvm::DenseMap<FileID, LocDeclsTy *> FileDeclsTy; 134332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 135332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Map from FileID to the file-level declarations that it contains. 136332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// The files and decls are only local (and non-preamble) ones. 137332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis FileDeclsTy FileDecls; 13889d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 13968d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 14068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 14168d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 142f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 143f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 144f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 145f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The set of diagnostics produced when creating the preamble. 146686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 147f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 148a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 149a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 150686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 151a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1534cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1574cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1584cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 159eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 160eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 161eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 162eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 163eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 164eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 165eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 166eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 167eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 168eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 1691872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek 170ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidispublic: 171507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis class PreambleData { 172507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const FileEntry *File; 173507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis std::vector<char> Buffer; 174507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis mutable unsigned NumLines; 175507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 176507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis public: 177507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData() : File(0), NumLines(0) { } 178507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 179507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void assign(const FileEntry *F, const char *begin, const char *end) { 180507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis File = F; 181507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis Buffer.assign(begin, end); 182507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis NumLines = 0; 183507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 184507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 185507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void clear() { Buffer.clear(); File = 0; NumLines = 0; } 186507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 187507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis size_t size() const { return Buffer.size(); } 188507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis bool empty() const { return Buffer.empty(); } 189507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 190507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis const char *getBufferStart() const { return &Buffer[0]; } 191507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 192507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned getNumLines() const { 193507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis if (NumLines) 194507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 195507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis countLines(); 196507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis return NumLines; 197507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis } 198507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 199ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange getSourceRange(const SourceManager &SM) const { 200ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID()); 201ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1)); 202ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 203ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 204507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis private: 205507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void countLines() const; 206507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis }; 207507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 208ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis const PreambleData &getPreambleData() const { 209ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return Preamble; 210ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 211ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 212ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidisprivate: 213ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 214175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 215175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 216507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleData Preamble; 217175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 218f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 219f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 220f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 221f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 222f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 223f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 224175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 225175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 226175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 227cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 228cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 229cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 230cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 231cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 232cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 233cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 234cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 23528233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 23628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 23728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 23828233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 239c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 240671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 241671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 242671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 243671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 244671947b18dba342f9aba022ee992babef325a833Douglas Gregor 245c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 246c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 247d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// This value will be used to restore the state of the \c DiagnosticsEngine 248d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// object when re-using the precompiled preamble. Note that only the 249c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 250c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 251c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 252c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2533c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 254eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2558538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 25689d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 25787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 25887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 25987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 260ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /// \brief Whether we want to include nested macro expansions in the 261dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /// detailed preprocessing record. 262ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions; 2633e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 2643e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor /// \brief The language options used when we load an AST file. 2653e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor LangOptions ASTFileLangOpts; 2663e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor 267d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie static void ConfigureDiags(llvm::IntrusiveRefCntPtr<DiagnosticsEngine> &Diags, 2680b53cf834346d78985aaa9e7300445a39c245614Douglas Gregor const char **ArgBegin, const char **ArgEnd, 269e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor ASTUnit &AST, bool CaptureDiagnostics); 270e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 271686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName, 272f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SourceManager &SrcMan, 273686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const SmallVectorImpl<StoredDiagnostic> &Diags, 274686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &Out); 275f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 276332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis void clearFileLevelDecls(); 277332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 27887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 27987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 28087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 28187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 28287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 28387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 28487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 28587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 28687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 28787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 28887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 28987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 29087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 29187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 29287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 29387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 29487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 29587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 29787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 30187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 3021827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 30358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 30458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 30558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 3061827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 3071827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 308f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 309f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 310f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 311f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 312f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 313f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 314f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 315f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 31687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 31787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 318f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 319f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 320f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 321f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 322f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 323f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 32448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 32548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 32648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor getCachedCompletionAllocator() { 32748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor return CachedCompletionAllocator; 32848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor } 32948601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 3308fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 3318fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// Creates the allocator if it doesn't already exist. 3328fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3338fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor getCursorCompletionAllocator() { 3348fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor if (!CursorCompletionAllocator.getPtr()) { 3358fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator = new GlobalCodeCompletionAllocator; 3368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3378fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor return CursorCompletionAllocator; 3388fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3398fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 34087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 341218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor /// \brief Allocator used to store cached code completions. 34248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 34348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor CachedCompletionAllocator; 3448fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 3458fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Allocator used to store code completions for arbitrary cursors. 3468fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3478fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator; 348218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor 34987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 35087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 35187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 352f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 353f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 354f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 355f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 3569b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3579b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the file. 358727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3599b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3609b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache. 3619b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CompletionCacheTopLevelHashValue; 362727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 3639b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3649b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the precompiled preamble. 365727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3669b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3679b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache after a rebuild of the precompiled preamble. 3689b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned PreambleTopLevelHashValue; 369ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3709b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief The current hash value for the top-level declaration and macro 3719b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// definition names 3729b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CurrentTopLevelHashValue; 3739b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 374ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 375ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 376ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 377ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 378c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 379c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 38087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 38187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 38287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 38387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 38487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 38531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 38631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 387bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3883687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3898b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 390abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 391754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 392175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 393f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 394df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 395df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 396175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 397df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 39801b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor const CompilerInvocation &PreambleInvocationIn, 399df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 400df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 401eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 40289d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 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 { 411a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void *Mutex; // a llvm::sys::MutexImpl in debug; 412a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 413a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis public: 414a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState(); 415a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ~ConcurrencyState(); 416a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 417a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void start(); 418a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis void finish(); 419a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis }; 420a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ConcurrencyState ConcurrencyCheckValue; 421a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis 4220853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 423bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 424a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis ASTUnit &Self; 425bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 426bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 427bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 428bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 429bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 430a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.start(); 431bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 432bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 433a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis Self.ConcurrencyCheckValue.finish(); 434bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 435bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 436bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 437bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 4380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 4390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 440c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 441c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 442ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 443ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 444ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 445d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine &getDiagnostics() const { return *Diagnostics; } 446d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() { return *Diagnostics; } 4473687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 448405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 449405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 4500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 4514f32786ac45210143654390177105eb749b614e9Ted Kremenek const Preprocessor &getPreprocessor() const { return *PP; } 4524f32786ac45210143654390177105eb749b614e9Ted Kremenek Preprocessor &getPreprocessor() { return *PP; } 4531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4544f32786ac45210143654390177105eb749b614e9Ted Kremenek const ASTContext &getASTContext() const { return *Ctx; } 4554f32786ac45210143654390177105eb749b614e9Ted Kremenek ASTContext &getASTContext() { return *Ctx; } 4560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 457abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis void setASTContext(ASTContext *ctx) { Ctx = ctx; } 458abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis 459914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 460914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 461914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 462914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 463914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 464914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 465405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 466405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 467f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 468389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 469389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 47077accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 471b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 472313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 473313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 474313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 4751872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek void addTemporaryFile(const llvm::sys::Path &TempFile); 476313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 4777d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 478f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 47915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 48015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 48115727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 482f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 483f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 484f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 485213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 486686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMainFileName() const; 487213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 488eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 489eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 490eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 491f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 492eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 493eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 494eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 495f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 496eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 497eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 498f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 499eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 500eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 501eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 502eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 503eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 504eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 505eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 506eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 507eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 508eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 509eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 510eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 511eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 512eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 513eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 514eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 515eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 516eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 517eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 518eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 519332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis /// \brief Add a new local file-level declaration. 520332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis void addFileLevelDecl(Decl *D); 521332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis 522eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 523eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 5248538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 525eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 526f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 527f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 5289b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief Retrieve a reference to the current top-level name hash value. 5299b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// 5309b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// Note: This is used internally by the top-level tracking action 5319b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 532507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 533507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 534507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// 535507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// The difference with SourceManager::getLocation is that this method checks 536507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// whether the requested location points inside the precompiled preamble 537507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// in which case the returned source location will be a "loaded" one. 538507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, 539507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 540507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 541507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the source location for the given file:offset pair. 542507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getLocation(const FileEntry *File, unsigned Offset) const; 543ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 544ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a loaded location from the preamble, returns 545ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// the corresponding local location of the main file, otherwise it returns 546ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \arg Loc. 547ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationFromPreamble(SourceLocation Loc); 548ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 549ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief If \arg Loc is a local location of the main file but inside the 550ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble chunk, returns the corresponding loaded location from the 551ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// preamble, otherwise it returns \arg Loc. 552ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceLocation mapLocationToPreamble(SourceLocation Loc); 553ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 554f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInPreambleFileID(SourceLocation Loc); 555f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool isInMainFileID(SourceLocation Loc); 556f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getStartOfMainFileID(); 557f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getEndOfPreambleFileID(); 558f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 559ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationFromPreamble. 560ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeFromPreamble(SourceRange R) { 561ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationFromPreamble(R.getBegin()), 562ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationFromPreamble(R.getEnd())); 563ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 564ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis 565ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis /// \brief \see mapLocationToPreamble. 566ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis SourceRange mapRangeToPreamble(SourceRange R) { 567ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis return SourceRange(mapLocationToPreamble(R.getBegin()), 568ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis mapLocationToPreamble(R.getEnd())); 569ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis } 570788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 571a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 5723e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef StoredDiagnostic *stored_diag_iterator; 5733e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis typedef const StoredDiagnostic *stored_diag_const_iterator; 5743e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_begin() const { 575405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 576405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 5773e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_begin() { 5783e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin(); 5793e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5803e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_const_iterator stored_diag_end() const { 5813e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.end(); 5823e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis } 5833e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_end() { 584405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 585405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 586405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 5873e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis 5883e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis stored_diag_iterator stored_diag_afterDriver_begin() { 5893e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size()) 5903e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis NumStoredDiagnosticsFromDriver = 0; 5913e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver; 592a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 593a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 59487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 59587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 59687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 59787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 59887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 59987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 60087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 60187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 60287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 60387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 60487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 60587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 60687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 60787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 608389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 609686775deca8b8685eb90801495880e3abdd844c2Chris Lattner llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 61075dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 611389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 612467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief Determine what kind of translation unit this AST represents. 613467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 614df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 615b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 616b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis FilenameOrMemBuf; 6174db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 6184db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 619b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 620b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 621b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 622b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis static ASTUnit *create(CompilerInvocation *CI, 623d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags); 624b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 6253c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 6260853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6273c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 6280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 6295262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6305262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 63131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 6323c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 6333c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 634d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 635389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 6365cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 6374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 638a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 639a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 640521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6414cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 6424cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 6434cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 6444cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6454cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 6464cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 6474cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 6484cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 6494cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 6504cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 6514cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 6524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 6534cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 654d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 655d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// object, by invoking the optionally provided ASTFrontendAction. 656d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 657d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param CI - The compiler invocation to use; it must have exactly one input 658d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 659d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 660d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Diags - The diagnostics engine to use for reporting errors; its 661d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// lifetime is expected to extend past that of the returned ASTUnit. 662d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 663d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 664d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// transfered. 665abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// 666abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// \param Unit - optionally an already created ASTUnit. Its ownership is not 667abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis /// transfered. 668d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 669d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 670abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTFrontendAction *Action = 0, 671abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis ASTUnit *Unit = 0); 672d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis 673521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 674521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 675521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 676521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 677f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 678521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 6795262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6805262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 681521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 682521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 683521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 684f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 685d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 686a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 68744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 688df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 689467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 690dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor bool CacheCodeCompletionResults = false, 691ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 692521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6937b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 6947b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 6957b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6967b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 6977b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6987b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 6997b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 7005262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 7015262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 7027b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 703869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 7047b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 7057b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 7067b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 7077b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 7087b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 709d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags, 710686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef ResourceFilesPath, 7117b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 712e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 7134db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 714a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 715299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool RemappedFilesKeepOriginalName = true, 716df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 717467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 71899ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CacheCodeCompletionResults = false, 719ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 720abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 721abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 722abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 723abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 724abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 725abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 726abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 727abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 7281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 7291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 7301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 7311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 732cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 733cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 734cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 735cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 736cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 737cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 738cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 739cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 740cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 741cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 742cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 7431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 7442283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 7452283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 746686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void CodeComplete(StringRef File, unsigned Line, unsigned Column, 7471abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 748cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 7491abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 750d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag, LangOptions &LangOpts, 7511abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 752686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 753686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 7547ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 7557ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 7567ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 75739c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /// \returns An indication of whether the save was successful or not. 758686775deca8b8685eb90801495880e3abdd844c2Chris Lattner CXSaveError Save(StringRef File); 759b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 760b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Serialize this translation unit with the given output stream. 761b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// 762b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \returns True if an error occurred, false otherwise. 7638cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner bool serialize(raw_ostream &OS); 7646aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 7656aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor virtual ModuleKey loadModule(SourceLocation ImportLoc, 7666aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor IdentifierInfo &ModuleName, 7676aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor SourceLocation ModuleNameLoc) { 7686aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor // ASTUnit doesn't know how to load modules (not that this matters). 7696aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor return 0; 7706aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor } 7710853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 7720853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7730853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 7740853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7750853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 776