ASTUnit.h revision 467dc88512b4ba4bb16e274ea3771dc1415d31da
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" 214ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 23eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 24389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h" 2587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2628019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 28a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 29cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 3003013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/Path.h" 31788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 320853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 33f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 34f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 354db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 36cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 44f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregorclass ASTReader; 451abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 46521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 49521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 55d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction; 560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 57f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 5948601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor/// \brief Allocator for a cached set of global code completions. 6048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregorclass GlobalCodeCompletionAllocator 6148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor : public CodeCompletionAllocator, 6248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor public llvm::RefCountedBase<GlobalCodeCompletionAllocator> 6348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor{ 6448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 6548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor}; 6648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 673c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 680853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 70788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 71788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 72788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 73bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor 74788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 7528019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 764f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<FileManager> FileMgr; 774f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<SourceManager> SourceMgr; 780853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 794f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<TargetInfo> Target; 804f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<Preprocessor> PP; 814f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<ASTContext> Ctx; 82389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 83389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 84389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 87914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 88914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 89914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 90914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 91914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 92914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 93807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 94807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 954f32786ac45210143654390177105eb749b614e9Ted Kremenek llvm::IntrusiveRefCntPtr<CompilerInvocation> Invocation; 96914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// \brief The set of target features. 981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// 991aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// FIXME: each time we reparse, we need to restore the set of target 1001aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// features from this vector, because TargetInfo::CreateTargetInfo() 1011aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor /// mangles the target options in place. Yuck! 1021aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor std::vector<std::string> TargetFeatures; 1031aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor 1047d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 1057d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 1067d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 1077d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 108c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 109abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 110abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 111e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 112df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 113c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 114c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 115467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief What kind of translation unit this AST represents. 116467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind; 117df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 118213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 119213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 12015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 12115727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis /// \brief Whether the ASTUnit should delete the remapped buffers. 12215727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool OwnsRemappedFileBuffers; 123213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 127f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 128f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 129f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 130f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 131f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 132f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 13389d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// \brief The list of preprocessed entities which appeared when the ASTUnit 13489d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// was loaded. 13589d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// 13689d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// FIXME: This is just an optimization hack to avoid deserializing large 13789d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// parts of a PCH file while performing a walk or search. In the long term, 13889d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// we should provide more scalable search mechanisms. 13989d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor std::vector<PreprocessedEntity *> PreprocessedEntities; 14089d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 14168d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 14268d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 14368d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 144f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 145f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 146f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 147f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The set of diagnostics produced when creating the preamble. 148686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> PreambleDiagnostics; 149f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 150a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 151a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 152686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 153a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1574cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1584cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1594cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1604cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 161313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 162313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 163686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<llvm::sys::Path, 4> TemporaryFiles; 164bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 165788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 166788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 167788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 168788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 169788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 170788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 171788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 172788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 173788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 174bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 175bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 176bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 177bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 178bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 179bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 180bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 181bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 182bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 183175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 184eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 185eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 186eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 187eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 188eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 189eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 190eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 191eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 192eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 193eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 194eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor 195175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 196385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 197175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 198175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 199175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 200175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 201175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 202f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 203f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 204f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 205f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 206f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 207f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 208175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 209175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 210175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 211cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 212cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 213cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 214cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 215cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 216cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 217cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 218cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 21928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 22028233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 22128233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 22228233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 223c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 224671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 225671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 226671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 227671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 228671947b18dba342f9aba022ee992babef325a833Douglas Gregor 229c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 230c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 231c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value will be used to restore the state of the \c Diagnostic object 232c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when re-using the precompiled preamble. Note that only the 233c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 234c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 235c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 236c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2373c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 238eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2398538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 240eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 24189d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// \brief A list of the offsets into the precompiled preamble which 24289d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// correspond to preprocessed entities. 24389d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor std::vector<uint64_t> PreprocessedEntitiesInPreamble; 24489d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 24587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 24687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 24787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 248ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth /// \brief Whether we want to include nested macro expansions in the 249dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor /// detailed preprocessing record. 250ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions; 251dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor 252e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor static void ConfigureDiags(llvm::IntrusiveRefCntPtr<Diagnostic> &Diags, 2530b53cf834346d78985aaa9e7300445a39c245614Douglas Gregor const char **ArgBegin, const char **ArgEnd, 254e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor ASTUnit &AST, bool CaptureDiagnostics); 255e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 256686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName, 257f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SourceManager &SrcMan, 258686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const SmallVectorImpl<StoredDiagnostic> &Diags, 259686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &Out); 260f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 26187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 26287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 26387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 26487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 26587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 26687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 26787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 26887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 26987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 27087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 27187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 27287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 27387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 27487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 27587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 27687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 27787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 27887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 27987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 28087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 28187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 28287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 28387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 28487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 2851827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 28658ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 28758ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 28858ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 2891827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 2901827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 291f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 292f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 293f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 294f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 295f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 296f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 297f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 298f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 301f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 302f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 303f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 304f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 305f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 306f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 30748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 30848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 30948601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor getCachedCompletionAllocator() { 31048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor return CachedCompletionAllocator; 31148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor } 31248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor 3138fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Retrieve the allocator used to cache global code completions. 3148fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// Creates the allocator if it doesn't already exist. 3158fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3168fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor getCursorCompletionAllocator() { 3178fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor if (!CursorCompletionAllocator.getPtr()) { 3188fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator = new GlobalCodeCompletionAllocator; 3198fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3208fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor return CursorCompletionAllocator; 3218fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor } 3228fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 32387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 324218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor /// \brief Allocator used to store cached code completions. 32548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 32648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor CachedCompletionAllocator; 3278fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor 3288fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor /// \brief Allocator used to store code completions for arbitrary cursors. 3298fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator> 3308fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor CursorCompletionAllocator; 331218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor 33287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 33387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 33487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 335f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 336f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 337f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 338f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 3399b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3409b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the file. 341727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3429b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3439b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache. 3449b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CompletionCacheTopLevelHashValue; 345727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 3469b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief A string hash of the top-level declaration and macro definition 3479b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// names processed the last time that we reparsed the precompiled preamble. 348727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 3499b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// This hash value is used to determine when we need to refresh the 3509b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// global code-completion cache after a rebuild of the precompiled preamble. 3519b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned PreambleTopLevelHashValue; 352ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3539b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief The current hash value for the top-level declaration and macro 3549b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// definition names 3559b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned CurrentTopLevelHashValue; 3569b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 357ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 358ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 359ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 360ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 361c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 362c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 36387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 36487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 36587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 36687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 36787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 36831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 36931b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 370bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3713687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3728b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 373abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 374754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 375175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 376f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 377df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 378df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 379175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 380df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 38101b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor const CompilerInvocation &PreambleInvocationIn, 382df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 383df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 384eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 38589d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor void RealizePreprocessedEntitiesFromPreamble(); 38689d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 3870853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 388bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 389bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 390bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 391bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 392bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 393bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 394bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 395bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 396bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 397bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 398bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 399bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 400bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 401bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 402bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 403bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 404bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 405bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 4060853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 4070853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 408c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 409c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 410ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 411ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 412ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 4133687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 4143687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 4153687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 416405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 417405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 4180853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 4194f32786ac45210143654390177105eb749b614e9Ted Kremenek const Preprocessor &getPreprocessor() const { return *PP; } 4204f32786ac45210143654390177105eb749b614e9Ted Kremenek Preprocessor &getPreprocessor() { return *PP; } 4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4224f32786ac45210143654390177105eb749b614e9Ted Kremenek const ASTContext &getASTContext() const { return *Ctx; } 4234f32786ac45210143654390177105eb749b614e9Ted Kremenek ASTContext &getASTContext() { return *Ctx; } 4240853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 425914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 426914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 427914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 428914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 429914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 430914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 431405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 432405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 433f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 434389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 435389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 43677accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 437b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 438313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 439313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 440313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 441313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 442313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 443313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 444313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 4457d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 446f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 44715727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; } 44815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; } 44915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis 450eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Retrieve the maximum PCH level of declarations that a 451eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// traversal of the translation unit should consider. 452eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor unsigned getMaxPCHLevel() const; 453eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 454f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 455f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 456f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 457213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 458686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMainFileName() const; 459213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 460eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 461eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 462eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 463f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 464eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 465eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 466eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 467f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 468eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 469eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 470f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 471eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 472eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 473eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 474eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 475eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 476eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 477eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 478eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 479eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 480eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 481eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 482eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 483eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 484eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 485eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 486eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 487eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 488eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 489eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 490eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 491eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 492eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 4938538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 494eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 495f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 496f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 4979b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// \brief Retrieve a reference to the current top-level name hash value. 4989b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// 4999b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor /// Note: This is used internally by the top-level tracking action 5009b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; } 5019b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor 50289d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor typedef std::vector<PreprocessedEntity *>::iterator pp_entity_iterator; 50389d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 50489d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor pp_entity_iterator pp_entity_begin(); 50589d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor pp_entity_iterator pp_entity_end(); 50689d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 50789d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// \brief Add a new preprocessed entity that's stored at the given offset 50889d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor /// in the precompiled preamble. 50989d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor void addPreprocessedEntityFromPreamble(uint64_t Offset) { 51089d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor PreprocessedEntitiesInPreamble.push_back(Offset); 51189d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor } 51289d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor 513788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 514788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 515788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 516788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 517788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 518788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 519a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 520405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 521405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 522405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 523405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 524405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 525405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 526405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 527405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 528405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 529686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 530405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 531a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 532a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 53387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 53487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 53587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 53687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 53787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 53887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 53987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 54087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 54187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 54287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 54387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 54487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 54587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 54687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 547389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 548686775deca8b8685eb90801495880e3abdd844c2Chris Lattner llvm::MemoryBuffer *getBufferForFile(StringRef Filename, 54975dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 550389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 551467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor /// \brief Determine what kind of translation unit this AST represents. 552467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind getTranslationUnitKind() const { return TUKind; } 553df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 554b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *> 555b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis FilenameOrMemBuf; 5564db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 5574db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 558b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile; 559b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 560b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation. 561b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis static ASTUnit *create(CompilerInvocation *CI, 562b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis llvm::IntrusiveRefCntPtr<Diagnostic> Diags); 563b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 5643c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 5650853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 5663c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 5670853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 5685262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 5695262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 57031b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 5713c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 5723c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 57328019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 574389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 5755cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 5764db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 577a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 578a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 579521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 5804cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 5814cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 5824cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 5834cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 5844cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 5854cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 5864cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 5874cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 5884cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 5894cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 5904cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 5914cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 5924cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 593d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \brief Create an ASTUnit from a source file, via a CompilerInvocation 594d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// object, by invoking the optionally provided ASTFrontendAction. 595d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 596d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param CI - The compiler invocation to use; it must have exactly one input 597d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 598d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 599d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Diags - The diagnostics engine to use for reporting errors; its 600d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// lifetime is expected to extend past that of the returned ASTUnit. 601d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// 602d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// \param Action - The ASTFrontendAction to invoke. Its ownership is not 603d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis /// transfered. 604d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI, 605d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 606d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis ASTFrontendAction *Action = 0); 607d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis 608521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 609521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 610521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 611521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 612f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 613521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 6145262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6155262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 616521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 617521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 618521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 619f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 62028019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 621a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 62244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 623df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 624467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 625dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor bool CacheCodeCompletionResults = false, 626ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 627521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 6287b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 6297b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 6307b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6317b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 6327b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6337b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 6347b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 6355262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 6365262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 6377b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 638869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 6397b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 6407b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 6417b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 6427b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 6437b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 64428019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 645686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef ResourceFilesPath, 6467b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 647e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 6484db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 649a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 650299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool RemappedFilesKeepOriginalName = true, 651df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 652467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor TranslationUnitKind TUKind = TU_Complete, 65399ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CacheCodeCompletionResults = false, 65499ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CXXPrecompilePreamble = false, 655dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor bool CXXChainedPCH = false, 656ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth bool NestedMacroExpansions = true); 657abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 658abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 659abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 660abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 661abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 662abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 663abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 664abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 6651abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 6661abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 6671abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 6681abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 669cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 670cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 671cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 672cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 673cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 674cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 675cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 676cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 677cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 678cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 679cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 6801abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 6812283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 6822283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 683686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void CodeComplete(StringRef File, unsigned Line, unsigned Column, 6841abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 685cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 6861abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 6871abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor Diagnostic &Diag, LangOptions &LangOpts, 6881abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 689686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 690686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 6917ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 6927ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 6937ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 69439c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor /// \returns An indication of whether the save was successful or not. 695686775deca8b8685eb90801495880e3abdd844c2Chris Lattner CXSaveError Save(StringRef File); 696b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis 697b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \brief Serialize this translation unit with the given output stream. 698b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// 699b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis /// \returns True if an error occurred, false otherwise. 7008cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner bool serialize(raw_ostream &OS); 7010853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 7020853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7030853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 7040853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 7050853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 706