ASTUnit.h revision 0a2c5e256abb4dc031c21fe4dc92c4f3afe9947c
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" 2487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2528019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 260853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 27a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 28cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 29313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 30385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor#include "llvm/Support/Timer.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; 441abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer; 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 46521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 49521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 540853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 55f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 573c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file. 580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 60788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 61788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 62788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 63bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor 64788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 6528019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 66405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 67405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 680853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 700853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 710853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 724ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 73914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 74914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 75914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 76914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 77914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 78914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 79914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 80914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 81807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 82807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 83807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 84914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 857d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 867d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 877d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 887d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 89c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 90abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 91abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 92abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 93df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 94c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 95c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 96df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 97df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool CompleteTranslationUnit; 98df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 99f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 100f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 101f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 102f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 103f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 104f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 105f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 106f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 107f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 10868d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 10968d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 11068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 111f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 112f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 113f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 114a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 115a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 116405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 117a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 118313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 119313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 120313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 121bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 122788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 123788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 124788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 125788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 126788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 127788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 128788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 129788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 130788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 131bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 132bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 133bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 134bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 135bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 136bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 137bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 138bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 139bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 140175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 141eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 142eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 143eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 144eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 145eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 146eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 147eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 148eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 149eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 150eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 151eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor 152175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 153385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 154175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 155175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 156175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 157175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 158175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 159f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 160f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 161f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 162f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 163f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 164f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 165175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 166175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 167175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 168cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 169cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 170cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 171cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 172cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 173cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 174cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 175cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 17628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 17728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 17828233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 17928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 180c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 181671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 182671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 183671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 184671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 185671947b18dba342f9aba022ee992babef325a833Douglas Gregor 186c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 187c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 188c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value will be used to restore the state of the \c Diagnostic object 189c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when re-using the precompiled preamble. Note that only the 190c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 191c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 192c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 193c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 194c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of diagnostics that were stored when parsing 195c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// the precompiled preamble. 196c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 197c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value is used to determine how many of the stored 198c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// diagnostics should be retained when reparsing in the presence of 199c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// a precompiled preamble. 200c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumStoredDiagnosticsInPreamble; 201c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 202385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The group of timers associated with this translation unit. 203cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::OwningPtr<llvm::TimerGroup> TimerGroup; 204eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 2053c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 206eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2078538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 208eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 20987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 21087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \defgroup CodeCompleteCaching Code-completion caching 21187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 21287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \{ 21387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 21487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 21587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 21687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 21787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 21887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 21987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 22087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 22187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 22287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 22387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 22487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 22587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 22687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 22787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 22887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 22987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 23087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 23187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 23287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 23387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 23487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 23587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 23687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 23787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 23887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 23987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 24087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 24187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 2421827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 24358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 24458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 24558ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 2461827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 2471827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 248f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 249f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 250f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 251f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 252f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 253f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 254f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 255f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 25687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 25787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 258f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 259f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 260f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 261f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 262f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 263f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 26487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 26587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 26687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 26787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 268f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 269f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 270f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 271f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 272727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// \brief The number of top-level declarations present the last time we 273727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// cached code-completion results. 274727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 275727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// The value is used to help detect when we should repopulate the global 276727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// completion cache. 277727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor unsigned NumTopLevelDeclsAtLastCompletionCache; 278727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 279727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// \brief The number of reparses left until we'll consider updating the 280727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// code-completion cache. 281727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 282727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// This is meant to avoid thrashing during reparsing, by not allowing the 283727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// code-completion cache to be updated on every reparse. 284727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor unsigned CacheCodeCompletionCoolDown; 285ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 286ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 287ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 288ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 289ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 290c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 291c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 29287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 29387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 29587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 29687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 29787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \} 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 301385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The timers we've created from the various parses, reparses, etc. 302385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// involved in this translation unit. 303385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::vector<llvm::Timer *> Timers; 304385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor 30531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 30631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 307bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3083687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3098b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 310abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 311754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 312175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 313f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 314df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 315df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 316175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 317df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 3182283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor CompilerInvocation PreambleInvocation, 319df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 320df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 321eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 322eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 3230853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 324bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 325bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 326bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 327bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 328bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 329bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 330bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 331bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 332bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 333bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 334bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 335bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 336bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 337bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 338bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 339bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 340bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 341bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 3430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 344c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 345c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 346ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 347ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 348ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3493687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 3503687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 3513687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 352405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 353405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 3540853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3550853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 3560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 3571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 3590853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 3600853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 361914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 362914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 363914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 364914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 365914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 366914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 367405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 368405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 369f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 37077accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 3713c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl const std::string &getASTFileName(); 372b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 373313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 374313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 375313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 376313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 377313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 378313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 379313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 3807d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 381f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 382eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Retrieve the maximum PCH level of declarations that a 383eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// traversal of the translation unit should consider. 384eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor unsigned getMaxPCHLevel() const; 385eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 386f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 387f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 388f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 389eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 390eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 391eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 392f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 393eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 394eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 395eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 396f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 397eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 398eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 399f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 400eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 401eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 402eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 403eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 404eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 405eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 406eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 407eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 408eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 409eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 410eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 411eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 412eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 413eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 414eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 415eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 416eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 417eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 418eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 419eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 420eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 421eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 4228538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 423eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 424f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 425f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 426788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 427788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 428788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 429788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 430788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 431788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 432a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 433405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 434405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 435405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 436405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 437405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 438405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 439405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 440405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 441405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 442405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 443405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 444a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 445a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 44687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 44787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 44887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 44987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 45087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 45187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 45287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 45387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 45487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 45587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 45687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 45787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 45887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 45987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 46087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 461df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 462df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// 463df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// If false, this AST is only a partial translation unit, e.g., one 464df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// that might still be used as a precompiled header or preamble. 465df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool isCompleteTranslationUnit() const { return CompleteTranslationUnit; } 466df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 4674db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 4684db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 4694db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 4704db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 4713c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 4720853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 4733c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 4740853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 4755262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4765262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 47731b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 4783c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 4793c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 48028019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 4815cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 4824db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 483a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 484a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 485521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 486521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 487521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 488521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 489521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 490f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 491521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 4925262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4935262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 494521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 495521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 496521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 497f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 49828019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 499a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 50044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 501df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 50287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 50387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CacheCodeCompletionResults = false); 504521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 5057b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 5067b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 5077b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5087b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 5097b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5107b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 5117b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5125262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 5135262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 5147b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 515869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 5167b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 5177b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 5187b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 5197b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 5207b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 52128019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 522869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 5237b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 5244db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 525a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 52644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 527df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 52887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 52987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CacheCodeCompletionResults = false); 530abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 531abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 532abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 533abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 534abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 535abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 536abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 537abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 5381abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 5391abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 5401abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 5411abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 542cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 543cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 544cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 545cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 546cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 547cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 548cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 549cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 550cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 551cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 552cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 5531abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 5542283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 5552283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 5561abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor void CodeComplete(llvm::StringRef File, unsigned Line, unsigned Column, 5571abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 558cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 5591abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 5601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor Diagnostic &Diag, LangOptions &LangOpts, 5611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 5622283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 5632283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor llvm::SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 5647ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 5657ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 5667ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 5677ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \returns True if an error occurred, false otherwise. 5687ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor bool Save(llvm::StringRef File); 5690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 5700853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5710853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 5720853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5730853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 574