ASTUnit.h revision 75dfb65c38d51772df9a00ce2d2feeefd55667ad
14b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===--- ASTUnit.h - ASTUnit utility ----------------------------*- C++ -*-===// 24b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 34b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 44b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 54b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 64b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 74b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 84b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 94b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 104b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// ASTUnit utility class. 114b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 124b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 134b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis 140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H 150853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#define LLVM_CLANG_FRONTEND_ASTUNIT_H 160853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 17eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Index/ASTLocation.h" 1805a07605322dfef2b017781042043a261c5a89cdSebastian Redl#include "clang/Serialization/ASTBitCodes.h" 19914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor#include "clang/Sema/Sema.h" 200a2c5e256abb4dc031c21fe4dc92c4f3afe9947cJohn McCall#include "clang/Sema/CodeCompleteConsumer.h" 214ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 23eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 24389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h" 2587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h" 2628019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 28a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 29cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 30313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 31788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 320853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 33f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 34f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 354db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 36cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 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; 72389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 73389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileSystemOptions FileSystemOpts; 74389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 75914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The AST consumer that received information about the translation 76914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit as it was parsed or loaded. 77914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<ASTConsumer> Consumer; 78914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 79914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// \brief The semantic analysis object used to type-check the translation 80914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor /// unit. 81914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor llvm::OwningPtr<Sema> TheSema; 82914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 83807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 84807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 85807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 877d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 887d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 897d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 907d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 91c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 92abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 93abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 94e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 95df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Track whether the main file was loaded from an AST or not. 96c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 97c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 98df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 99df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool CompleteTranslationUnit; 100df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 101213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor /// \brief Whether we should time each operation. 102213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor bool WantTiming; 103213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 104f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 105f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 106f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 107f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 108f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 109f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 110f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 111f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 112f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 11368d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 11468d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 11568d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 116f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 117f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 118f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 119a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 120a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 121405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 122a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1234cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief The number of stored diagnostics that come from the driver 1244cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// itself. 1254cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 1264cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// Diagnostics that come from the driver are retained from one parse to 1274cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// the next. 1284cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor unsigned NumStoredDiagnosticsFromDriver; 1294cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 130313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 131313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 132313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 133bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 134788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 135788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 136788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 137788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 138788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 139788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 140788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 141788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 142788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 143bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 144bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 145bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 146bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 147bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 148bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 149bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 150bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 151bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 152175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 153eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 154eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 155eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 156eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 157eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 158eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 159eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 160eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 161eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 162eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 163eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor 164175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 165385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 166175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 167175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 168175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 169175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 170175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 171f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 172f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 173f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 174f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 175f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 176f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 177175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 178175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 179175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 180cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 181cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 182cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 183cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 184cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 185cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 186cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 187cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 18828233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 18928233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 19028233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 19128233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 192c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 193671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// \brief When non-NULL, this is the buffer used to store the 194671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// contents of the preamble when it has been padded to build the 195671947b18dba342f9aba022ee992babef325a833Douglas Gregor /// precompiled preamble. 196671947b18dba342f9aba022ee992babef325a833Douglas Gregor llvm::MemoryBuffer *PreambleBuffer; 197671947b18dba342f9aba022ee992babef325a833Douglas Gregor 198c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 199c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 200c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value will be used to restore the state of the \c Diagnostic object 201c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when re-using the precompiled preamble. Note that only the 202c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 203c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 204c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 205c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 206c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of diagnostics that were stored when parsing 207c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// the precompiled preamble. 208c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 209c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value is used to determine how many of the stored 210c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// diagnostics should be retained when reparsing in the presence of 211c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// a precompiled preamble. 212c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumStoredDiagnosticsInPreamble; 213c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 2143c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief A list of the serialization ID numbers for each of the top-level 215eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 2168538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl std::vector<serialization::DeclID> TopLevelDeclsInPreamble; 217eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 21887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Whether we should be caching code-completion results. 21987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool ShouldCacheCodeCompletionResults; 22087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 221e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor static void ConfigureDiags(llvm::IntrusiveRefCntPtr<Diagnostic> &Diags, 222e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor ASTUnit &AST, bool CaptureDiagnostics); 223e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor 22487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic: 22587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A cached code-completion result, which may be introduced in one of 22687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// many different contexts. 22787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor struct CachedCodeCompletionResult { 22887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The code-completion string corresponding to this completion 22987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 23087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CodeCompletionString *Completion; 23187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 23287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief A bitmask that indicates which code-completion contexts should 23387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contain this completion result. 23487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// 23587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// The bits in the bitmask correspond to the values of 23687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// CodeCompleteContext::Kind. To map from a completion context kind to a 23787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// bit, subtract one from the completion context kind and shift 1 by that 23887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// number of bits. Many completions can occur in several different 23987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// contexts. 24087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned ShowInContexts; 24187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 24287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The priority given to this code-completion result. 24387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned Priority; 24487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 24587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The libclang cursor kind corresponding to this code-completion 24687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// result. 24787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor CXCursorKind Kind; 2481827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor 24958ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor /// \brief The availability of this code-completion result. 25058ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor CXAvailabilityKind Availability; 25158ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor 2521827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor /// \brief The simplified type class for a non-macro completion result. 2531827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor SimplifiedTypeClass TypeClass; 254f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 255f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief The type of a non-macro completion result, stored as a unique 256f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// integer used by the string map of cached completion types. 257f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// 258f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// This value will be zero if the type is not known, or a unique value 259f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// determined by the formatted type string. Se \c CachedCompletionTypes 260f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// for more information. 261f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor unsigned Type; 26287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor }; 26387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 264f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief Retrieve the mapping from formatted type names to unique type 265f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// identifiers. 266f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> &getCachedCompletionTypes() { 267f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor return CachedCompletionTypes; 268f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor } 269f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 27087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate: 27187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief The set of cached code-completion results. 27287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor std::vector<CachedCodeCompletionResult> CachedCompletionResults; 27387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 274f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// \brief A mapping from the formatted type name to a unique number for that 275f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor /// type, which is used for type equality comparisons. 276f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor llvm::StringMap<unsigned> CachedCompletionTypes; 277f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor 278727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// \brief The number of top-level declarations present the last time we 279727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// cached code-completion results. 280727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 281727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// The value is used to help detect when we should repopulate the global 282727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// completion cache. 283727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor unsigned NumTopLevelDeclsAtLastCompletionCache; 284727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor 285727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// \brief The number of reparses left until we'll consider updating the 286727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// code-completion cache. 287727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// 288727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// This is meant to avoid thrashing during reparsing, by not allowing the 289727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor /// code-completion cache to be updated on every reparse. 290727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor unsigned CacheCodeCompletionCoolDown; 291ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 292ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// \brief Bit used by CIndex to mark when a translation unit may be in an 293ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar /// inconsistent state, and is not safe to free. 294ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar unsigned UnsafeToFree : 1; 295ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 296c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// \brief Cache any "global" code-completion results, so that we can avoid 297c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor /// recomputing them with each completion. 29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void CacheCodeCompletionResults(); 29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor /// \brief Clear out and deallocate 30187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor void ClearCachedCompletionResults(); 30287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 30331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 30431b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 305bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3063687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 3078b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 308abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 309754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 310175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 311f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 312df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, 313df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines, bool &CreatedBuffer); 314175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 315df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble( 3162283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor CompilerInvocation PreambleInvocation, 317df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool AllowRebuild = true, 318df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor unsigned MaxLines = 0); 319eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 320eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 3210853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 322bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 323bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 324bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 325bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 326bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 327bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 328bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 329bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 330bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 331bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 332bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 333bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 334bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 335bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 336bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 337bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 338bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 339bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 3400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 3410853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 342c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 343c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 344ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar bool isUnsafeToFree() const { return UnsafeToFree; } 345ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar void setUnsafeToFree(bool Value) { UnsafeToFree = Value; } 346ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar 3473687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 3483687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 3493687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 350405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 351405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 3520853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3530853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 3540853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 3551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3560853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 3570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 3580853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 359914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor bool hasSema() const { return TheSema; } 360914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor Sema &getSema() const { 361914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor assert(TheSema && "ASTUnit does not have a Sema object!"); 362914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor return *TheSema; 363914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor } 364914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor 365405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 366405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 367f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 368389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; } 369389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 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 389213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 390213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor llvm::StringRef getMainFileName() const; 391213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor 392eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 393eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 394eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 395f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 396eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 397eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 398eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 399f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 400eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 401eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 402f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 403eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 404eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 405eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 406eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 407eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 408eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 409eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 410eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 411eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 412eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 413eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 414eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 415eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 416eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 417eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 418eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 419eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 420eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 421eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 422eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 423eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 424eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 4258538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl void addTopLevelDeclFromPreamble(serialization::DeclID D) { 426eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 427f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 428f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 429788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 430788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 431788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 432788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 433788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 434788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 435a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 436405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 437405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 438405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 439405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 440405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 441405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 442405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 443405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 444405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 445405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 446405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 447a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 448a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 44987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor typedef std::vector<CachedCodeCompletionResult>::iterator 45087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator; 45187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 45287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_begin() { 45387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.begin(); 45487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 45587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 45687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor cached_completion_iterator cached_completion_end() { 45787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.end(); 45887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 45987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor 46087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor unsigned cached_completion_size() const { 46187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor return CachedCompletionResults.size(); 46287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor } 463389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 464389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis llvm::MemoryBuffer *getBufferForFile(llvm::StringRef Filename, 46575dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner std::string *ErrorStr = 0); 466389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 467df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// \brief Whether this AST represents a complete translation unit. 468df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// 469df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// If false, this AST is only a partial translation unit, e.g., one 470df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor /// that might still be used as a precompiled header or preamble. 471df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool isCompleteTranslationUnit() const { return CompleteTranslationUnit; } 472df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor 4734db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 4744db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 4754db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 4764db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 4773c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \brief Create a ASTUnit from an AST file. 4780853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 4793c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \param Filename - The AST file to load. 4800853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 4815262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 4825262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 48331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 4843c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// \returns - The initialized ASTUnit or null if the AST failed to load. 4853c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl static ASTUnit *LoadFromASTFile(const std::string &Filename, 48628019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 487389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const FileSystemOptions &FileSystemOpts, 4885cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 4894db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 490a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 491a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 492521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 4934cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate: 4944cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \brief Helper function for \c LoadFromCompilerInvocation() and 4954cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation. 4964cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 4974cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \param PrecompilePreamble Whether to precompile the preamble of this 4984cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// translation unit, to improve the performance of reparsing. 4994cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// 5004cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \returns \c true if a catastrophic failure occurred (which means that the 5014cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor /// \c ASTUnit itself is invalid), or \c false otherwise. 5024cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor bool LoadFromCompilerInvocation(bool PrecompilePreamble); 5034cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 5044cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic: 5054cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor 506521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 507521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 508521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 509521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 510f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 511521bf9c529e653ab28896d027352d3e16e2672d5Daniel 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. 514521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 515521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 516521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 517f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 51828019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 519a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 52044c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 521df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 52287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 52387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CacheCodeCompletionResults = false); 524521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 5257b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 5267b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 5277b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5287b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 5297b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5307b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 5317b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 5325262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 5335262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 5347b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 535869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 5367b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 5377b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 5387b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 5397b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 5407b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 54128019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 542869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 5437b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 544e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor bool CaptureDiagnostics = false, 5454db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 546a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 547df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor bool PrecompilePreamble = false, 54887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor bool CompleteTranslationUnit = true, 54999ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CacheCodeCompletionResults = false, 55099ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CXXPrecompilePreamble = false, 55199ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor bool CXXChainedPCH = false); 552abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 553abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 554abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 555abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 556abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 557abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 558abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 559abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 5601abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor 5611abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// \brief Perform code completion at the given file, line, and 5621abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// column within this translation unit. 5631abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 564cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param File The file in which code completion will occur. 565cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 566cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Line The line at which code completion will occur. 567cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 568cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param Column The column at which code completion will occur. 569cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 570cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeMacros Whether to include macros in the code-completion 571cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// results. 572cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// 573cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// \param IncludeCodePatterns Whether to include code patterns (such as a 574cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor /// for loop) in the code-completion results. 5751abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor /// 5762283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and 5772283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor /// OwnedBuffers parameters are all disgusting hacks. They will go away. 5781abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor void CodeComplete(llvm::StringRef File, unsigned Line, unsigned Column, 5791abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor RemappedFile *RemappedFiles, unsigned NumRemappedFiles, 580cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor bool IncludeMacros, bool IncludeCodePatterns, 5811abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor CodeCompleteConsumer &Consumer, 5821abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor Diagnostic &Diag, LangOptions &LangOpts, 5831abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor SourceManager &SourceMgr, FileManager &FileMgr, 5842283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics, 5852283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor llvm::SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers); 5867ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor 5877ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \brief Save this translation unit to a file with the given name. 5887ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// 5897ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor /// \returns True if an error occurred, false otherwise. 5907ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor bool Save(llvm::StringRef File); 5910853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 5920853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5930853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 5940853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 5950853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 596