ASTUnit.h revision f5586f6b311c98e1022a8fe0609053849b70d323
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" 18eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Frontend/PCHBitCodes.h" 19914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor#include "clang/Sema/Sema.h" 204ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 22eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 2387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2428019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 250853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 26a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 27cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 28313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 29385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor#include "llvm/Support/Timer.h" 30788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 310853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 32f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 33f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 344db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 35cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 42521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 431abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 46521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 49521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 530853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 54f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5544c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// \brief Utility class for loading a ASTContext from a PCH file. 570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 59788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 60788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 61788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 62788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 6328019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 64405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 65405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 660853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 670853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 680853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 704ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 71914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 72914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 73914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 74914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 75914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 76914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 77914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 78914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 79807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 80807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 81807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 82914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 837d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 847d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 857d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 867d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 87c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 88abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 89abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 90abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 91df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 92c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 93c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 94df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 95df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool CompleteTranslationUnit; 96df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 97f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 98f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 99f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 100f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 101f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 102f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 103f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 104f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 105f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 10668d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 10768d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 10868d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 109f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 110f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 111f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 112a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 113a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 114405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 115a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 116313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 117313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 118313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 119bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 120788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 121788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 122788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 123788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 124788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 125788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 126788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 127788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 128788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 129bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 130bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 131bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 132bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 133bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 134bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 135bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 136bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 137bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 138175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 139eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 140eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 141eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 142eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 143eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 144eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 145eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 146eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 147eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 148eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 149eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor 150175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 151385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 152175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 153175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 154175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 155175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 156175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 157f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 158f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 159f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 160f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 161f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 162f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 163175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 164175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 165175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 166cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 167cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 168cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 169cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 170cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 171cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 172cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 173cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 17428233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 17528233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 17628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 17728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 178c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 179c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 180c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 181c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value will be used to restore the state of the \c Diagnostic object 182c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when re-using the precompiled preamble. Note that only the 183c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 184c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 185c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 186c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 187c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of diagnostics that were stored when parsing 188c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// the precompiled preamble. 189c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 190c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value is used to determine how many of the stored 191c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// diagnostics should be retained when reparsing in the presence of 192c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// a precompiled preamble. 193c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumStoredDiagnosticsInPreamble; 194c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 195385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The group of timers associated with this translation unit. 196cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::OwningPtr<llvm::TimerGroup> TimerGroup; 197eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 198eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief A list of the PCH ID numbers for each of the top-level 199eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 200eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::vector<pch::DeclID> TopLevelDeclsInPreamble; 201eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 20287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 20387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \defgroup CodeCompleteCaching Code-completion caching 20487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 20587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \{ 20687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 20787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 20887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 20987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 21087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 21187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 21287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 21387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 21487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 21587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 21687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 21787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 21887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 21987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 22087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 22187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 22287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 22387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 22487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 22587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 22687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 22787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 22887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 22987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 23087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 23187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 23287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 23387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 23487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 2351827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 2361827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 2371827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 238f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 239f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 240f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 241f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 242f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 243f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 244f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 245f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 24687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 24787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 248f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 249f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 250f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 251f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 252f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 253f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 25487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 25587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 25687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 25787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 258f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 259f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 260f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 261f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 262c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 263c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 26487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 26587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 26687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 26787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 26887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 26987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 27087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \} 27187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 27287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 273385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The timers we've created from the various parses, reparses, etc. 274385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// involved in this translation unit. 275385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::vector<llvm::Timer *> Timers; 276385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor 27731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 27831b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 279bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 2803687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 2818b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 282abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 283754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 284175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 285f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 286df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 287df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 288175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 289df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 290df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 291df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 292eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 293eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 2940853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 295bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 296bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 297bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 298bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 299bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 300bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 301bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 302bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 303bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 304bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 305bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 306bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 307bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 308bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 309bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 310bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 311bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 312bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3130853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 3140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 315c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 316c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 3173687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 3183687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 3193687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 320405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 321405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 3220853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3230853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 3240853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 3251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3260853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 3270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 3280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 329914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 330914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 331914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 332914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 333914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 334914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 335405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 336405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 337f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 33877accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 339e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 340b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 341313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 342313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 343313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 344313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 345313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 346313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 347313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 3487d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 349f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 350eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Retrieve the maximum PCH level of declarations that a 351eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// traversal of the translation unit should consider. 352eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor unsigned getMaxPCHLevel() const; 353eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 354f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 355f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 356f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 357eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 358eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 359eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 360f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 361eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 362eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 363eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 364f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 365eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 366eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 367f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 368eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 369eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 370eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 371eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 372eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 373eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 374eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 375eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 376eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 377eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 378eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 379eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 380eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 381eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 382eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 383eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 384eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 385eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 386eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 387eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 388eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 389eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 390eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDeclFromPreamble(pch::DeclID D) { 391eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 392f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 393f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 394788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 395788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 396788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 397788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 398788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 399788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 400a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 401405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 402405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 403405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 404405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 405405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 406405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 407405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 408405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 409405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 410405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 411405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 412a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 413a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 41487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 41587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 41687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 41787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 41887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 41987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 42087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 42187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 42287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 42387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 42487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 42587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 42687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 42787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 42887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 429df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 430df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// 431df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// If false, this AST is only a partial translation unit, e.g., one 432df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// that might still be used as a precompiled header or preamble. 433df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool isCompleteTranslationUnit() const { return CompleteTranslationUnit; } 434df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 4354db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 4364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 4374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 4384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 4390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 4400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 44131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 4420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 4435262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4445262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 44531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 44631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 4470853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 44828019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 4495cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 4504db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 451a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 452a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 453521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 454521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 455521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 456521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 457521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 458f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 459521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 4605262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4615262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 462521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 463521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 464521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 465f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 46628019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 467a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 46844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 469df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 47087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 47187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CacheCodeCompletionResults = false); 472521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 4737b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 4747b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 4757b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 4767b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 4777b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 4787b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 4797b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 4805262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4815262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 4827b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 483869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 4847b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 4857b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 4867b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 4877b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 4887b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 48928019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 490869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 4917b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 4924db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 493a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 49444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 495df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 49687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 49787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CacheCodeCompletionResults = false); 498abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 499abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 500abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 501abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 502abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 503abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 504abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 505abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 5061abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 5071abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 5081abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 5091abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 510cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 511cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 512cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 513cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 514cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 515cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 516cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 517cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 518cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 519cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 520cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 5211abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 5221abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, and 5231abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// StoredDiagnostics parameters are all disgusting hacks. They will 5241abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// go away. 5251abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor void CodeComplete(llvm::StringRef File, unsigned Line, unsigned Column, 5261abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 527cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 5281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 5291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor Diagnostic &Diag, LangOptions &LangOpts, 5301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 5311abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics); 5327ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 5337ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 5347ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 5357ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \returns True if an error occurred, false otherwise. 5367ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor bool Save(llvm::StringRef File); 5370853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 5380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 5400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 542