ASTUnit.h revision eababfbddb74d186f78783a9731a78ad371c9800
14b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===--- ASTUnit.h - ASTUnit utility ----------------------------*- C++ -*-===// 24b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 34b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 44b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 54b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 64b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 74b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 84b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 94b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 104b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// ASTUnit utility class. 114b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis// 124b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 134b562cf889bc59e1914dd2c5d9fbd7e7bfa1ad77Argyrios Kyrtzidis 140853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#ifndef LLVM_CLANG_FRONTEND_ASTUNIT_H 150853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#define LLVM_CLANG_FRONTEND_ASTUNIT_H 160853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 17eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Index/ASTLocation.h" 18eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Frontend/PCHBitCodes.h" 194ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h" 2031b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h" 21eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h" 2228019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 230853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h" 24a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h" 25cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h" 26313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor#include "llvm/System/Path.h" 27385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor#include "llvm/Support/Timer.h" 28788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map> 290853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string> 30f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector> 31f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert> 324db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility> 33cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h> 344db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 354db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm { 364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor class MemoryBuffer; 374db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang { 40521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext; 41521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation; 42521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl; 43521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Diagnostic; 44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry; 45521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager; 46521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch; 47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor; 48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager; 49521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo; 500853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 51f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx; 5244c181aec37789f25f6c15543c164416f72e562aDouglas Gregor 530853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// \brief Utility class for loading a ASTContext from a PCH file. 540853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis/// 550853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisclass ASTUnit { 56788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorpublic: 57788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor typedef std::map<FileID, std::vector<PreprocessedEntity *> > 58788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap; 59788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate: 6028019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diagnostics; 61405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<FileManager> FileMgr; 62405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::OwningPtr<SourceManager> SourceMgr; 630853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<HeaderSearch> HeaderInfo; 640853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<TargetInfo> Target; 650853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<Preprocessor> PP; 660853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis llvm::OwningPtr<ASTContext> Ctx; 674ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor 68807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// Optional owned invocation, just used to make the invocation used in 69807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar /// LoadFromCommandLine available. 70807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar llvm::OwningPtr<CompilerInvocation> Invocation; 71807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar 727d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // OnlyLocalDecls - when true, walking this AST should only visit declarations 737d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // that come from the AST itself, not from included precompiled headers. 747d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor // FIXME: This is temporary; eventually, CIndex will always do this. 757d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool OnlyLocalDecls; 76c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 77abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Whether to capture any diagnostics produced. 78abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool CaptureDiagnostics; 79abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 80f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track whether the main file was loaded from an AST or not. 81c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool MainFileIsAST; 82c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 83f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// Track the top-level decls which appeared in an ASTUnit which was loaded 84f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar /// from a source file. 85f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // 86f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // FIXME: This is just an optimization hack to avoid deserializing large parts 87f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // of a PCH file when using the Index library on an ASTUnit loaded from 88f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // source. In the long term we should make the Index library use efficient and 89f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar // more scalable search mechanisms. 90f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar std::vector<Decl*> TopLevelDecls; 91f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 9268d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar /// The name of the original source file used to generate this ASTUnit. 9368d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar std::string OriginalSourceFile; 9468d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar 95f96b524306ccfa623235d375deee79637bd38f29Steve Naroff // Critical optimization when using clang_getCursor(). 96f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation LastLoc; 97f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 98a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief The set of diagnostics produced when creating this 99a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// translation unit. 100405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics; 101a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 102313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Temporary files that should be removed when the ASTUnit is 103313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// destroyed. 104313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor llvm::SmallVector<llvm::sys::Path, 4> TemporaryFiles; 105bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 106788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief A mapping from file IDs to the set of preprocessed entities 107788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// stored in that file. 108788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// 109788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// FIXME: This is just an optimization hack to avoid searching through 110788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// many preprocessed entities during cursor traversal in the CIndex library. 111788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// Ideally, we would just be able to perform a binary search within the 112788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// list of preprocessed entities. 113788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap PreprocessedEntitiesByFile; 114788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 115bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// \brief Simple hack to allow us to assert that ASTUnit is not being 116bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// used concurrently, which is not supported. 117bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// 118bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// Clients should create instances of the ConcurrencyCheck class whenever 119bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// using the ASTUnit in a way that isn't intended to be concurrent, which is 120bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor /// just about any usage. 121bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor unsigned int ConcurrencyCheckValue; 122bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckLocked = 28573289; 123bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor static const unsigned int CheckUnlocked = 9803453; 124175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 125eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// \brief Counter that determines when we want to try building a 126eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// precompiled preamble. 127eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// 128eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// If zero, we will never build a precompiled preamble. Otherwise, 129eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// it's treated as a counter that decrements each time we reparse 130eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// without the benefit of a precompiled preamble. When it hits 1, 131eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// we'll attempt to rebuild the precompiled header. This way, if 132eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// building the precompiled preamble fails, we won't try again for 133eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor /// some number of calls. 134eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor unsigned PreambleRebuildCounter; 135eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor 136175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The file in which the precompiled preamble is stored. 137385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::string PreambleFile; 138175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 139175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The contents of the preamble that has been precompiled to 140175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \c PreambleFile. 141175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor std::vector<char> Preamble; 142175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 143f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the preamble ends at the start of a new line. 144f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 145f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// Used to inform the lexer as to whether it's starting at the beginning of 146f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// a line after skipping the preamble. 147f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool PreambleEndsAtStartOfLine; 148f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 149175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// \brief The size of the source buffer that we've reserved for the main 150175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor /// file within the precompiled preamble. 151175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor unsigned PreambleReservedSize; 152cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 153cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Keeps track of the files that were used when computing the 154cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// preamble, with both their buffer size and their modification time. 155cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// 156cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// If any of the files have changed from one compile to the next, 157cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// the preamble must be thrown away. 158cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble; 159cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 16028233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// \brief When non-NULL, this is the buffer used to store the contents of 16128233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// the main file when it has been padded for use with the precompiled 16228233428da1ebec20c893d6297ae3191318940ddDouglas Gregor /// preamble. 16328233428da1ebec20c893d6297ae3191318940ddDouglas Gregor llvm::MemoryBuffer *SavedMainFileBuffer; 164c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 165c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of warnings that occurred while parsing the preamble. 166c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 167c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value will be used to restore the state of the \c Diagnostic object 168c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when re-using the precompiled preamble. Note that only the 169c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// number of warnings matters, since we will not save the preamble 170c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// when any errors are present. 171c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumWarningsInPreamble; 172c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 173c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// \brief The number of diagnostics that were stored when parsing 174c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// the precompiled preamble. 175c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// 176c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// This value is used to determine how many of the stored 177c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// diagnostics should be retained when reparsing in the presence of 178c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor /// a precompiled preamble. 179c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor unsigned NumStoredDiagnosticsInPreamble; 180c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 181385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The group of timers associated with this translation unit. 182cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor llvm::OwningPtr<llvm::TimerGroup> TimerGroup; 183eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 184eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief A list of the PCH ID numbers for each of the top-level 185eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// declarations parsed within the precompiled preamble. 186eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::vector<pch::DeclID> TopLevelDeclsInPreamble; 187eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 188385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// \brief The timers we've created from the various parses, reparses, etc. 189385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor /// involved in this translation unit. 190385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor std::vector<llvm::Timer *> Timers; 191385103b79c5338a2be5da0ca70652400bc267371Douglas Gregor 19231b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT 19331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT 194bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 1953687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor explicit ASTUnit(bool MainFileIsAST); 1968b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor 197abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void CleanTemporaryFiles(); 198754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor bool Parse(llvm::MemoryBuffer *OverrideMainBuffer); 199175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 200f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > 201f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor ComputePreamble(CompilerInvocation &Invocation, bool &CreatedBuffer); 202175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor 203754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor llvm::MemoryBuffer *BuildPrecompiledPreamble(); 204eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void RealizeTopLevelDeclsFromPreamble(); 205eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 2060853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic: 207bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor class ConcurrencyCheck { 208bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor volatile ASTUnit &Self; 209bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 210bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor public: 211bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor explicit ConcurrencyCheck(ASTUnit &Self) 212bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor : Self(Self) 213bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor { 214bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor assert(Self.ConcurrencyCheckValue == CheckUnlocked && 215bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor "Concurrent access to ASTUnit!"); 216bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckLocked; 217bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 218bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 219bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor ~ConcurrencyCheck() { 220bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor Self.ConcurrencyCheckValue = CheckUnlocked; 221bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor } 222bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor }; 223bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor friend class ConcurrencyCheck; 224bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor 2250853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ~ASTUnit(); 2260853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 227c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar bool isMainFileAST() const { return MainFileIsAST; } 228c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar 2293687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor const Diagnostic &getDiagnostics() const { return *Diagnostics; } 2303687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor Diagnostic &getDiagnostics() { return *Diagnostics; } 2313687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor 232405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const SourceManager &getSourceManager() const { return *SourceMgr; } 233405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor SourceManager &getSourceManager() { return *SourceMgr; } 2340853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 2350853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const Preprocessor &getPreprocessor() const { return *PP.get(); } 2360853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis Preprocessor &getPreprocessor() { return *PP.get(); } 2371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis const ASTContext &getASTContext() const { return *Ctx.get(); } 2390853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis ASTContext &getASTContext() { return *Ctx.get(); } 2400853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 241405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor const FileManager &getFileManager() const { return *FileMgr; } 242405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor FileManager &getFileManager() { return *FileMgr; } 243f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 24477accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff const std::string &getOriginalSourceFileName(); 245e19944c93961b7618f4f3f3185f698f46369ea54Steve Naroff const std::string &getPCHFileName(); 246b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu 247313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// \brief Add a temporary file that the ASTUnit depends on. 248313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// 249313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor /// This file will be erased when the ASTUnit is destroyed. 250313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor void addTemporaryFile(const llvm::sys::Path &TempFile) { 251313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor TemporaryFiles.push_back(TempFile); 252313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor } 253313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor 2547d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 255f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 256eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Retrieve the maximum PCH level of declarations that a 257eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// traversal of the translation unit should consider. 258eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor unsigned getMaxPCHLevel() const; 259eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 260f96b524306ccfa623235d375deee79637bd38f29Steve Naroff void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; } 261f96b524306ccfa623235d375deee79637bd38f29Steve Naroff ASTLocation getLastASTLocation() const { return LastLoc; } 262f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 263eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor typedef std::vector<Decl *>::iterator top_level_iterator; 264eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 265eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_begin() { 266f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 267eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 268eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 269eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.begin(); 270f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 271eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 272eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor top_level_iterator top_level_end() { 273f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 274eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor if (!TopLevelDeclsInPreamble.empty()) 275eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor RealizeTopLevelDeclsFromPreamble(); 276eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDecls.end(); 277eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 278eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 279eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor std::size_t top_level_size() const { 280eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 281eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.size() + TopLevelDecls.size(); 282eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 283eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 284eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor bool top_level_empty() const { 285eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!"); 286eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty(); 287eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 288eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 289eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration. 290eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDecl(Decl *D) { 291eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDecls.push_back(D); 292eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor } 293eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor 294eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// \brief Add a new top-level declaration, identified by its ID in 295eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor /// the precompiled preamble. 296eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor void addTopLevelDeclFromPreamble(pch::DeclID D) { 297eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor TopLevelDeclsInPreamble.push_back(D); 298f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar } 299f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar 300788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// \brief Retrieve the mapping from File IDs to the preprocessed entities 301788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor /// within that file. 302788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor PreprocessedEntitiesByFileMap &getPreprocessedEntitiesByFile() { 303788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor return PreprocessedEntitiesByFile; 304788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor } 305788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor 306a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor // Retrieve the diagnostics associated with this AST 307405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor typedef const StoredDiagnostic *stored_diag_iterator; 308405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_begin() const { 309405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.begin(); 310405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 311405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor stored_diag_iterator stored_diag_end() const { 312405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics.end(); 313405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor } 314405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor unsigned stored_diag_size() const { return StoredDiagnostics.size(); } 315405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor 316405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor llvm::SmallVector<StoredDiagnostic, 4> &getStoredDiagnostics() { 317405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor return StoredDiagnostics; 318a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor } 319a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 3204db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// \brief A mapping from a file name to the memory buffer that stores the 3214db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /// remapped contents of that file. 3224db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor typedef std::pair<std::string, const llvm::MemoryBuffer *> RemappedFile; 3234db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 3240853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// \brief Create a ASTUnit from a PCH file. 3250853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 32631b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \param Filename - The PCH file to load. 3270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis /// 3285262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 3295262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 33031b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// 33131b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar /// \returns - The initialized ASTUnit or null if the PCH failed to load. 3320853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis static ASTUnit *LoadFromPCHFile(const std::string &Filename, 33328019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 3345cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek bool OnlyLocalDecls = false, 3354db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 336a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 337a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool CaptureDiagnostics = false); 338521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 339521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a 340521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// CompilerInvocation object. 341521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 342521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// \param CI - The compiler invocation to use; it must have exactly one input 343f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar /// source file. The ASTUnit takes ownership of the CompilerInvocation object. 344521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar /// 3455262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 3465262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 347521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // 348521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 349521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar // shouldn't need to specify them at construction time. 350f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI, 35128019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 352a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor bool OnlyLocalDecls = false, 35344c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 35444c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 355521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar 3567b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// LoadFromCommandLine - Create an ASTUnit from a vector of command line 3577b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// arguments, which must specify exactly one source file. 3587b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 3597b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgBegin - The beginning of the argument vector. 3607b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 3617b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// \param ArgEnd - The end of the argument vector. 3627b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 3635262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// \param Diags - The diagnostics engine to use for reporting errors; its 3645262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar /// lifetime is expected to extend past that of the returned ASTUnit. 3657b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar /// 366869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar /// \param ResourceFilesPath - The path to the compiler resource files. 3677b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // 3687b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we 3697b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar // shouldn't need to specify them at construction time. 3707b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar static ASTUnit *LoadFromCommandLine(const char **ArgBegin, 3717b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar const char **ArgEnd, 37228019772db70d4547be05a042eb950bc910f134fDouglas Gregor llvm::IntrusiveRefCntPtr<Diagnostic> Diags, 373869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar llvm::StringRef ResourceFilesPath, 3747b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar bool OnlyLocalDecls = false, 3754db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor RemappedFile *RemappedFiles = 0, 376a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned NumRemappedFiles = 0, 37744c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool CaptureDiagnostics = false, 37844c181aec37789f25f6c15543c164416f72e562aDouglas Gregor bool PrecompilePreamble = false); 379abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 380abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reparse the source files using the same command-line options that 381abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// were originally used to produce this translation unit. 382abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// 383abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \returns True if a failure occurred that causes the ASTUnit not to 384abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// contain any translation-unit information, false otherwise. 385abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor bool Reparse(RemappedFile *RemappedFiles = 0, 386abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor unsigned NumRemappedFiles = 0); 3870853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis}; 3880853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3890853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang 3900853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis 3910853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif 392