ASTUnit.h revision 332cb9be88fd2d1b294a2fbc299c354e93be673c
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"
216aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor#include "clang/Lex/ModuleLoader.h"
224ae8f298b1ea51b4c2234f9148e2e4349c9bdd23Douglas Gregor#include "clang/Lex/PreprocessingRecord.h"
2331b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar#include "clang/Basic/SourceManager.h"
24eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor#include "clang/Basic/FileManager.h"
25389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis#include "clang/Basic/FileSystemOptions.h"
2687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor#include "clang-c/Index.h"
2728019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h"
280853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include "llvm/ADT/OwningPtr.h"
29a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor#include "llvm/ADT/SmallVector.h"
30cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include "llvm/ADT/StringMap.h"
3103013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/Path.h"
32788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor#include <map>
330853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#include <string>
34f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <vector>
35f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar#include <cassert>
364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <utility>
37cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor#include <sys/types.h>
384db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor
394db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace llvm {
404db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor  class MemoryBuffer;
414db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor}
420853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
430853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidisnamespace clang {
44521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass ASTContext;
45f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregorclass ASTReader;
461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregorclass CodeCompleteConsumer;
47521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass CompilerInvocation;
48521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Decl;
49d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine;
50521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileEntry;
51521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass FileManager;
52521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass HeaderSearch;
53521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass Preprocessor;
54521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass SourceManager;
55521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbarclass TargetInfo;
56d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidisclass ASTFrontendAction;
570853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
58f96b524306ccfa623235d375deee79637bd38f29Steve Naroffusing namespace idx;
5944c181aec37789f25f6c15543c164416f72e562aDouglas Gregor
6048601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor/// \brief Allocator for a cached set of global code completions.
6148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregorclass GlobalCodeCompletionAllocator
6248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  : public CodeCompletionAllocator,
6348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor    public llvm::RefCountedBase<GlobalCodeCompletionAllocator>
6448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor{
6548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor
6648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor};
6748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor
683c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl/// \brief Utility class for loading a ASTContext from an AST file.
690853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis///
706aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ASTUnit : public ModuleLoader {
71788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregorprivate:
72d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics;
73d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<FileManager>       FileMgr;
74d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<SourceManager>     SourceMgr;
75d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::OwningPtr<HeaderSearch>               HeaderInfo;
76d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<TargetInfo>        Target;
77d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<Preprocessor>      PP;
78d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  llvm::IntrusiveRefCntPtr<ASTContext>        Ctx;
79389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis
80389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis  FileSystemOptions FileSystemOpts;
81389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis
82914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  /// \brief The AST consumer that received information about the translation
83914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  /// unit as it was parsed or loaded.
84914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  llvm::OwningPtr<ASTConsumer> Consumer;
85914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor
86914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  /// \brief The semantic analysis object used to type-check the translation
87914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  /// unit.
88914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  llvm::OwningPtr<Sema> TheSema;
89914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor
90807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar  /// Optional owned invocation, just used to make the invocation used in
91807b06157a1a5c050520fc194d32f16d22d423a8Daniel Dunbar  /// LoadFromCommandLine available.
924f32786ac45210143654390177105eb749b614e9Ted Kremenek  llvm::IntrusiveRefCntPtr<CompilerInvocation> Invocation;
93914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor
941aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  /// \brief The set of target features.
951aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  ///
961aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  /// FIXME: each time we reparse, we need to restore the set of target
971aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  /// features from this vector, because TargetInfo::CreateTargetInfo()
981aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  /// mangles the target options in place. Yuck!
991aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor  std::vector<std::string> TargetFeatures;
1001aa27307c462baaa9e5fda14ff6797dd39fe8b84Douglas Gregor
1017d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor  // OnlyLocalDecls - when true, walking this AST should only visit declarations
1027d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor  // that come from the AST itself, not from included precompiled headers.
1037d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor  // FIXME: This is temporary; eventually, CIndex will always do this.
1047d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor  bool                              OnlyLocalDecls;
105c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar
106abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// \brief Whether to capture any diagnostics produced.
107abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  bool CaptureDiagnostics;
108e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor
109df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor  /// \brief Track whether the main file was loaded from an AST or not.
110c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar  bool MainFileIsAST;
111c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar
112467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor  /// \brief What kind of translation unit this AST represents.
113467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor  TranslationUnitKind TUKind;
114df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor
115213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor  /// \brief Whether we should time each operation.
116213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor  bool WantTiming;
11715727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis
11815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis  /// \brief Whether the ASTUnit should delete the remapped buffers.
11915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis  bool OwnsRemappedFileBuffers;
120213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor
121f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  /// Track the top-level decls which appeared in an ASTUnit which was loaded
122f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  /// from a source file.
123f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  //
124f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  // FIXME: This is just an optimization hack to avoid deserializing large parts
125f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  // of a PCH file when using the Index library on an ASTUnit loaded from
126f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  // source. In the long term we should make the Index library use efficient and
127f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  // more scalable search mechanisms.
128f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  std::vector<Decl*> TopLevelDecls;
129332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis
130332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  /// \brief Sorted (by file offset) vector of pairs of file offset/Decl.
131332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  typedef SmallVector<std::pair<unsigned, Decl *>, 64> LocDeclsTy;
132332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  typedef llvm::DenseMap<FileID, LocDeclsTy *> FileDeclsTy;
133332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis
134332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  /// \brief Map from FileID to the file-level declarations that it contains.
135332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  /// The files and decls are only local (and non-preamble) ones.
136332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  FileDeclsTy FileDecls;
13789d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor
13868d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar  /// The name of the original source file used to generate this ASTUnit.
13968d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar  std::string OriginalSourceFile;
14068d40e2d16b9fadba386853d6bbb60089291fdc5Daniel Dunbar
141f96b524306ccfa623235d375deee79637bd38f29Steve Naroff  // Critical optimization when using clang_getCursor().
142f96b524306ccfa623235d375deee79637bd38f29Steve Naroff  ASTLocation LastLoc;
143f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar
144f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor  /// \brief The set of diagnostics produced when creating the preamble.
145686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  SmallVector<StoredDiagnostic, 4> PreambleDiagnostics;
146f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor
147a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  /// \brief The set of diagnostics produced when creating this
148a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  /// translation unit.
149686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
150a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1514cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \brief The number of stored diagnostics that come from the driver
1524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// itself.
1534cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  ///
1544cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// Diagnostics that come from the driver are retained from one parse to
1554cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// the next.
1564cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  unsigned NumStoredDiagnosticsFromDriver;
1574cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor
158eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// \brief Counter that determines when we want to try building a
159eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// precompiled preamble.
160eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  ///
161eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// If zero, we will never build a precompiled preamble. Otherwise,
162eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// it's treated as a counter that decrements each time we reparse
163eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// without the benefit of a precompiled preamble. When it hits 1,
164eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// we'll attempt to rebuild the precompiled header. This way, if
165eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// building the precompiled preamble fails, we won't try again for
166eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  /// some number of calls.
167eababfbddb74d186f78783a9731a78ad371c9800Douglas Gregor  unsigned PreambleRebuildCounter;
1681872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek
169ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidispublic:
170507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  class PreambleData {
171507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    const FileEntry *File;
172507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    std::vector<char> Buffer;
173507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    mutable unsigned NumLines;
174507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
175507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  public:
176507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    PreambleData() : File(0), NumLines(0) { }
177507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
178507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    void assign(const FileEntry *F, const char *begin, const char *end) {
179507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      File = F;
180507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      Buffer.assign(begin, end);
181507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      NumLines = 0;
182507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    }
183507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
184507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    void clear() { Buffer.clear(); File = 0; NumLines = 0; }
185507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
186507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    size_t size() const { return Buffer.size(); }
187507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    bool empty() const { return Buffer.empty(); }
188507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
189507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    const char *getBufferStart() const { return &Buffer[0]; }
190507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
191507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    unsigned getNumLines() const {
192507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      if (NumLines)
193507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis        return NumLines;
194507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      countLines();
195507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis      return NumLines;
196507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    }
197507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
198ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis    SourceRange getSourceRange(const SourceManager &SM) const {
199ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis      SourceLocation FileLoc = SM.getLocForStartOfFile(SM.getPreambleFileID());
200ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis      return SourceRange(FileLoc, FileLoc.getLocWithOffset(size()-1));
201ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis    }
202ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
203507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  private:
204507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis    void countLines() const;
205507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  };
206507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
207ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  const PreambleData &getPreambleData() const {
208ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis    return Preamble;
209ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  }
210ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
211ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidisprivate:
212ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
213175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor  /// \brief The contents of the preamble that has been precompiled to
214175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor  /// \c PreambleFile.
215507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  PreambleData Preamble;
216175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor
217f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  /// \brief Whether the preamble ends at the start of a new line.
218f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  ///
219f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  /// Used to inform the lexer as to whether it's starting at the beginning of
220f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  /// a line after skipping the preamble.
221f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  bool PreambleEndsAtStartOfLine;
222f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor
223175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor  /// \brief The size of the source buffer that we've reserved for the main
224175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor  /// file within the precompiled preamble.
225175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor  unsigned PreambleReservedSize;
226cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor
227cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  /// \brief Keeps track of the files that were used when computing the
228cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  /// preamble, with both their buffer size and their modification time.
229cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  ///
230cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  /// If any of the files have changed from one compile to the next,
231cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  /// the preamble must be thrown away.
232cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor  llvm::StringMap<std::pair<off_t, time_t> > FilesInPreamble;
233cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor
23428233428da1ebec20c893d6297ae3191318940ddDouglas Gregor  /// \brief When non-NULL, this is the buffer used to store the contents of
23528233428da1ebec20c893d6297ae3191318940ddDouglas Gregor  /// the main file when it has been padded for use with the precompiled
23628233428da1ebec20c893d6297ae3191318940ddDouglas Gregor  /// preamble.
23728233428da1ebec20c893d6297ae3191318940ddDouglas Gregor  llvm::MemoryBuffer *SavedMainFileBuffer;
238c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor
239671947b18dba342f9aba022ee992babef325a833Douglas Gregor  /// \brief When non-NULL, this is the buffer used to store the
240671947b18dba342f9aba022ee992babef325a833Douglas Gregor  /// contents of the preamble when it has been padded to build the
241671947b18dba342f9aba022ee992babef325a833Douglas Gregor  /// precompiled preamble.
242671947b18dba342f9aba022ee992babef325a833Douglas Gregor  llvm::MemoryBuffer *PreambleBuffer;
243671947b18dba342f9aba022ee992babef325a833Douglas Gregor
244c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  /// \brief The number of warnings that occurred while parsing the preamble.
245c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  ///
246d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// This value will be used to restore the state of the \c DiagnosticsEngine
247d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// object when re-using the precompiled preamble. Note that only the
248c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  /// number of warnings matters, since we will not save the preamble
249c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  /// when any errors are present.
250c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  unsigned NumWarningsInPreamble;
251c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor
2523c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// \brief A list of the serialization ID numbers for each of the top-level
253eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  /// declarations parsed within the precompiled preamble.
2548538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl  std::vector<serialization::DeclID> TopLevelDeclsInPreamble;
25589d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor
25687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  /// \brief Whether we should be caching code-completion results.
25787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  bool ShouldCacheCodeCompletionResults;
25887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
259ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth  /// \brief Whether we want to include nested macro expansions in the
260dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor  /// detailed preprocessing record.
261ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth  bool NestedMacroExpansions;
2623e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor
2633e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor  /// \brief The language options used when we load an AST file.
2643e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor  LangOptions ASTFileLangOpts;
2653e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor
266d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  static void ConfigureDiags(llvm::IntrusiveRefCntPtr<DiagnosticsEngine> &Diags,
2670b53cf834346d78985aaa9e7300445a39c245614Douglas Gregor                             const char **ArgBegin, const char **ArgEnd,
268e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor                             ASTUnit &AST, bool CaptureDiagnostics);
269e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor
270686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  void TranslateStoredDiagnostics(ASTReader *MMan, StringRef ModName,
271f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor                                  SourceManager &SrcMan,
272686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                      const SmallVectorImpl<StoredDiagnostic> &Diags,
273686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                            SmallVectorImpl<StoredDiagnostic> &Out);
274f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor
275332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  void clearFileLevelDecls();
276332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis
27787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorpublic:
27887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  /// \brief A cached code-completion result, which may be introduced in one of
27987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  /// many different contexts.
28087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  struct CachedCodeCompletionResult {
28187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// \brief The code-completion string corresponding to this completion
28287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// result.
28387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    CodeCompletionString *Completion;
28487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
28587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// \brief A bitmask that indicates which code-completion contexts should
28687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// contain this completion result.
28787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    ///
28887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// The bits in the bitmask correspond to the values of
28987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// CodeCompleteContext::Kind. To map from a completion context kind to a
29087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// bit, subtract one from the completion context kind and shift 1 by that
29187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// number of bits. Many completions can occur in several different
29287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// contexts.
29387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    unsigned ShowInContexts;
29487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
29587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// \brief The priority given to this code-completion result.
29687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    unsigned Priority;
29787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
29887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// \brief The libclang cursor kind corresponding to this code-completion
29987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    /// result.
30087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    CXCursorKind Kind;
3011827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor
30258ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor    /// \brief The availability of this code-completion result.
30358ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor    CXAvailabilityKind Availability;
30458ddb60f409125eda5436c4a1f070f7fa4744295Douglas Gregor
3051827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor    /// \brief The simplified type class for a non-macro completion result.
3061827e10051638770ad9ccf3e285caf95f995afd1Douglas Gregor    SimplifiedTypeClass TypeClass;
307f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor
308f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    /// \brief The type of a non-macro completion result, stored as a unique
309f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    /// integer used by the string map of cached completion types.
310f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    ///
311f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    /// This value will be zero if the type is not known, or a unique value
312f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    /// determined by the formatted type string. Se \c CachedCompletionTypes
313f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    /// for more information.
314f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    unsigned Type;
31587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  };
31687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
317f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  /// \brief Retrieve the mapping from formatted type names to unique type
318f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  /// identifiers.
319f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  llvm::StringMap<unsigned> &getCachedCompletionTypes() {
320f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor    return CachedCompletionTypes;
321f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  }
322f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor
32348601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  /// \brief Retrieve the allocator used to cache global code completions.
32448601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
32548601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  getCachedCompletionAllocator() {
32648601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor    return CachedCompletionAllocator;
32748601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  }
32848601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor
3298fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  /// \brief Retrieve the allocator used to cache global code completions.
3308fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  /// Creates the allocator if it doesn't already exist.
3318fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
3328fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  getCursorCompletionAllocator() {
3338fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor    if (!CursorCompletionAllocator.getPtr()) {
3348fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor      CursorCompletionAllocator = new GlobalCodeCompletionAllocator;
3358fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor    }
3368fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor    return CursorCompletionAllocator;
3378fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  }
3388fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor
33987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregorprivate:
340218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor  /// \brief Allocator used to store cached code completions.
34148601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor  llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
34248601b32321496b07a18fb6631f8563275d8c5fbDouglas Gregor    CachedCompletionAllocator;
3438fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor
3448fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  /// \brief Allocator used to store code completions for arbitrary cursors.
3458fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor  llvm::IntrusiveRefCntPtr<GlobalCodeCompletionAllocator>
3468fa0a80b4482ad94e82c4a19e23de17fd69140b5Douglas Gregor    CursorCompletionAllocator;
347218937c13ef5b0625a70aad41ca7a92da9278bd2Douglas Gregor
34887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  /// \brief The set of cached code-completion results.
34987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  std::vector<CachedCodeCompletionResult> CachedCompletionResults;
35087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
351f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  /// \brief A mapping from the formatted type name to a unique number for that
352f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  /// type, which is used for type equality comparisons.
353f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor  llvm::StringMap<unsigned> CachedCompletionTypes;
354f5586f6b311c98e1022a8fe0609053849b70d323Douglas Gregor
3559b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// \brief A string hash of the top-level declaration and macro definition
3569b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// names processed the last time that we reparsed the file.
357727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor  ///
3589b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// This hash value is used to determine when we need to refresh the
3599b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// global code-completion cache.
3609b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  unsigned CompletionCacheTopLevelHashValue;
361727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor
3629b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// \brief A string hash of the top-level declaration and macro definition
3639b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// names processed the last time that we reparsed the precompiled preamble.
364727d93ef49e18147149354fadd10e86b13bc4ab0Douglas Gregor  ///
3659b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// This hash value is used to determine when we need to refresh the
3669b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// global code-completion cache after a rebuild of the precompiled preamble.
3679b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  unsigned PreambleTopLevelHashValue;
368ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar
3699b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// \brief The current hash value for the top-level declaration and macro
3709b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// definition names
3719b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  unsigned CurrentTopLevelHashValue;
3729b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor
373ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar  /// \brief Bit used by CIndex to mark when a translation unit may be in an
374ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar  /// inconsistent state, and is not safe to free.
375ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar  unsigned UnsafeToFree : 1;
376ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar
377c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor  /// \brief Cache any "global" code-completion results, so that we can avoid
378c4421e966d77a18f815284175b3fcbb46f36fa39Douglas Gregor  /// recomputing them with each completion.
37987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  void CacheCodeCompletionResults();
38087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
38187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  /// \brief Clear out and deallocate
38287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  void ClearCachedCompletionResults();
38387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
38431b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar  ASTUnit(const ASTUnit&); // DO NOT IMPLEMENT
38531b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar  ASTUnit &operator=(const ASTUnit &); // DO NOT IMPLEMENT
386bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor
3873687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor  explicit ASTUnit(bool MainFileIsAST);
3888b96253907c47141af0b7b2a44a368748d006a87Douglas Gregor
389abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  void CleanTemporaryFiles();
390754f3490c5b0f5d83361f001bc87944f23644abbDouglas Gregor  bool Parse(llvm::MemoryBuffer *OverrideMainBuffer);
391175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor
392f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor  std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
393df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor  ComputePreamble(CompilerInvocation &Invocation,
394df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor                  unsigned MaxLines, bool &CreatedBuffer);
395175c4a9aa61f4449f27b729737e4438684ac6d92Douglas Gregor
396df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor  llvm::MemoryBuffer *getMainBufferWithPrecompiledPreamble(
39701b6e31a62e2265849f4388b9be6be0a5d13348dDouglas Gregor                               const CompilerInvocation &PreambleInvocationIn,
398df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor                                                     bool AllowRebuild = true,
399df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor                                                        unsigned MaxLines = 0);
400eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  void RealizeTopLevelDeclsFromPreamble();
40189d9980bbc2e4a4ac86673e6ec16fb9f5babb63bDouglas Gregor
402a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// \brief Allows us to assert that ASTUnit is not being used concurrently,
403a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// which is not supported.
404a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  ///
405a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// Clients should create instances of the ConcurrencyCheck class whenever
406a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// using the ASTUnit in a way that isn't intended to be concurrent, which is
407a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// just about any usage.
408a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  /// Becomes a noop in release mode; only useful for debug mode checking.
409a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  class ConcurrencyState {
410a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    void *Mutex; // a llvm::sys::MutexImpl in debug;
411a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis
412a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  public:
413a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    ConcurrencyState();
414a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    ~ConcurrencyState();
415a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis
416a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    void start();
417a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    void finish();
418a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  };
419a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis  ConcurrencyState ConcurrencyCheckValue;
420a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis
4210853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidispublic:
422bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor  class ConcurrencyCheck {
423a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis    ASTUnit &Self;
424bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor
425bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor  public:
426bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor    explicit ConcurrencyCheck(ASTUnit &Self)
427bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor      : Self(Self)
428bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor    {
429a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis      Self.ConcurrencyCheckValue.start();
430bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor    }
431bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor    ~ConcurrencyCheck() {
432a696ece1ac449a2b77e7c0a693b55cb10e9e2068Argyrios Kyrtzidis      Self.ConcurrencyCheckValue.finish();
433bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor    }
434bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor  };
435bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor  friend class ConcurrencyCheck;
436bdf6062bc10aa3b73b16402b440b8073310acd06Douglas Gregor
4370853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis  ~ASTUnit();
4380853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
439c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar  bool isMainFileAST() const { return MainFileIsAST; }
440c7822dbf3c01a2a5f837cff82ba7889ea755dacaDaniel Dunbar
441ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar  bool isUnsafeToFree() const { return UnsafeToFree; }
442ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar  void setUnsafeToFree(bool Value) { UnsafeToFree = Value; }
443ea94bbc4769697143e717df9b0310f874102b6c1Daniel Dunbar
444d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  const DiagnosticsEngine &getDiagnostics() const { return *Diagnostics; }
445d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DiagnosticsEngine &getDiagnostics()             { return *Diagnostics; }
4463687e9d3a5dbfa9963af02a49a2b139d91310813Douglas Gregor
447405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor  const SourceManager &getSourceManager() const { return *SourceMgr; }
448405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor        SourceManager &getSourceManager()       { return *SourceMgr; }
4490853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
4504f32786ac45210143654390177105eb749b614e9Ted Kremenek  const Preprocessor &getPreprocessor() const { return *PP; }
4514f32786ac45210143654390177105eb749b614e9Ted Kremenek        Preprocessor &getPreprocessor()       { return *PP; }
4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4534f32786ac45210143654390177105eb749b614e9Ted Kremenek  const ASTContext &getASTContext() const { return *Ctx; }
4544f32786ac45210143654390177105eb749b614e9Ted Kremenek        ASTContext &getASTContext()       { return *Ctx; }
4550853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
456abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis  void setASTContext(ASTContext *ctx) { Ctx = ctx; }
457abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis
458914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  bool hasSema() const { return TheSema; }
459914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  Sema &getSema() const {
460914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor    assert(TheSema && "ASTUnit does not have a Sema object!");
461914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor    return *TheSema;
462914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor  }
463914ed9d30e9abf829a62aa996b083b1e47c19ff6Douglas Gregor
464405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor  const FileManager &getFileManager() const { return *FileMgr; }
465405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor        FileManager &getFileManager()       { return *FileMgr; }
466f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar
467389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis  const FileSystemOptions &getFileSystemOpts() const { return FileSystemOpts; }
468389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis
46977accc11f04ed4ff9afd4e27d430144d4714be56Steve Naroff  const std::string &getOriginalSourceFileName();
470b85bca2676b433ae555db09de4dd2823ff13b856Zhongxing Xu
471313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor  /// \brief Add a temporary file that the ASTUnit depends on.
472313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor  ///
473313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor  /// This file will be erased when the ASTUnit is destroyed.
4741872b3153a388b3a548c9f699cbc348128059be9Ted Kremenek  void addTemporaryFile(const llvm::sys::Path &TempFile);
475313e26c4e81f0e467490a530548450f4c824a6c4Douglas Gregor
4767d1d49d2971b20a97b3c2a301470b9eaaa130137Douglas Gregor  bool getOnlyLocalDecls() const { return OnlyLocalDecls; }
477f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar
47815727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis  bool getOwnsRemappedFileBuffers() const { return OwnsRemappedFileBuffers; }
47915727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis  void setOwnsRemappedFileBuffers(bool val) { OwnsRemappedFileBuffers = val; }
48015727ddb11405c45372150b5bfb07dbfa4c9960bArgyrios Kyrtzidis
481f96b524306ccfa623235d375deee79637bd38f29Steve Naroff  void setLastASTLocation(ASTLocation ALoc) { LastLoc = ALoc; }
482f96b524306ccfa623235d375deee79637bd38f29Steve Naroff  ASTLocation getLastASTLocation() const { return LastLoc; }
483f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar
484213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor
485686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  StringRef getMainFileName() const;
486213f18b3d654de7d1c7cf4a329ea9d3db1c50b6aDouglas Gregor
487eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  typedef std::vector<Decl *>::iterator top_level_iterator;
488eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
489eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  top_level_iterator top_level_begin() {
490f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar    assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
491eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    if (!TopLevelDeclsInPreamble.empty())
492eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor      RealizeTopLevelDeclsFromPreamble();
493eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    return TopLevelDecls.begin();
494f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  }
495eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
496eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  top_level_iterator top_level_end() {
497f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar    assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
498eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    if (!TopLevelDeclsInPreamble.empty())
499eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor      RealizeTopLevelDeclsFromPreamble();
500eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    return TopLevelDecls.end();
501eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  }
502eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
503eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  std::size_t top_level_size() const {
504eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
505eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    return TopLevelDeclsInPreamble.size() + TopLevelDecls.size();
506eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  }
507eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
508eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  bool top_level_empty() const {
509eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    assert(!isMainFileAST() && "Invalid call for AST based ASTUnit!");
510eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    return TopLevelDeclsInPreamble.empty() && TopLevelDecls.empty();
511eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  }
512eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
513eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  /// \brief Add a new top-level declaration.
514eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  void addTopLevelDecl(Decl *D) {
515eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    TopLevelDecls.push_back(D);
516eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  }
517eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor
518332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  /// \brief Add a new local file-level declaration.
519332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis  void addFileLevelDecl(Decl *D);
520332cb9be88fd2d1b294a2fbc299c354e93be673cArgyrios Kyrtzidis
521eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  /// \brief Add a new top-level declaration, identified by its ID in
522eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor  /// the precompiled preamble.
5238538e8d43a3a9bd439c987c0de37bcbf035dd391Sebastian Redl  void addTopLevelDeclFromPreamble(serialization::DeclID D) {
524eb8837b88c18631c69ac75f64ab1853762063180Douglas Gregor    TopLevelDeclsInPreamble.push_back(D);
525f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar  }
526f772d1e2a5688572d07f42896a50ac57a4a41fe8Daniel Dunbar
5279b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// \brief Retrieve a reference to the current top-level name hash value.
5289b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  ///
5299b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  /// Note: This is used internally by the top-level tracking action
5309b7db6200d366e4964d63ae1f33c7b9d7b9831cbDouglas Gregor  unsigned &getCurrentTopLevelHashValue() { return CurrentTopLevelHashValue; }
531507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
532507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  /// \brief Get the source location for the given file:line:col triplet.
533507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  ///
534507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  /// The difference with SourceManager::getLocation is that this method checks
535507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  /// whether the requested location points inside the precompiled preamble
536507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  /// in which case the returned source location will be a "loaded" one.
537507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  SourceLocation getLocation(const FileEntry *File,
538507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis                             unsigned Line, unsigned Col) const;
539507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis
540507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  /// \brief Get the source location for the given file:offset pair.
541507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis  SourceLocation getLocation(const FileEntry *File, unsigned Offset) const;
542ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
543ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// \brief If \arg Loc is a loaded location from the preamble, returns
544ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// the corresponding local location of the main file, otherwise it returns
545ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// \arg Loc.
546ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  SourceLocation mapLocationFromPreamble(SourceLocation Loc);
547ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
548ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// \brief If \arg Loc is a local location of the main file but inside the
549ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// preamble chunk, returns the corresponding loaded location from the
550ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// preamble, otherwise it returns \arg Loc.
551ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  SourceLocation mapLocationToPreamble(SourceLocation Loc);
552ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
553f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis  bool isInPreambleFileID(SourceLocation Loc);
554f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis  bool isInMainFileID(SourceLocation Loc);
555f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis  SourceLocation getStartOfMainFileID();
556f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis  SourceLocation getEndOfPreambleFileID();
557f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis
558ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// \brief \see mapLocationFromPreamble.
559ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  SourceRange mapRangeFromPreamble(SourceRange R) {
560ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis    return SourceRange(mapLocationFromPreamble(R.getBegin()),
561ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis                       mapLocationFromPreamble(R.getEnd()));
562ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  }
563ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis
564ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  /// \brief \see mapLocationToPreamble.
565ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  SourceRange mapRangeToPreamble(SourceRange R) {
566ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis    return SourceRange(mapLocationToPreamble(R.getBegin()),
567ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis                       mapLocationToPreamble(R.getEnd()));
568ee0f84fc84ed7de7975e102668d8e53a778f7a8cArgyrios Kyrtzidis  }
569788f5a1242c04762f91eaa7565c07b9865846d88Douglas Gregor
570a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  // Retrieve the diagnostics associated with this AST
5713e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  typedef StoredDiagnostic *stored_diag_iterator;
5723e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  typedef const StoredDiagnostic *stored_diag_const_iterator;
5733e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  stored_diag_const_iterator stored_diag_begin() const {
574405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor    return StoredDiagnostics.begin();
575405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor  }
5763e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  stored_diag_iterator stored_diag_begin() {
5773e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis    return StoredDiagnostics.begin();
5783e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  }
5793e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  stored_diag_const_iterator stored_diag_end() const {
5803e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis    return StoredDiagnostics.end();
5813e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  }
5823e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  stored_diag_iterator stored_diag_end() {
583405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor    return StoredDiagnostics.end();
584405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor  }
585405634b215f19eec7183bd8005e34aa5a02f64a1Douglas Gregor  unsigned stored_diag_size() const { return StoredDiagnostics.size(); }
5863e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis
5873e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis  stored_diag_iterator stored_diag_afterDriver_begin() {
5883e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis    if (NumStoredDiagnosticsFromDriver > StoredDiagnostics.size())
5893e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis      NumStoredDiagnosticsFromDriver = 0;
5903e9d32656a8a3a787f64f9beeef66d2d700eb85dArgyrios Kyrtzidis    return StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver;
591a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  }
592a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
59387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  typedef std::vector<CachedCodeCompletionResult>::iterator
59487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    cached_completion_iterator;
59587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
59687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  cached_completion_iterator cached_completion_begin() {
59787c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    return CachedCompletionResults.begin();
59887c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  }
59987c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
60087c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  cached_completion_iterator cached_completion_end() {
60187c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    return CachedCompletionResults.end();
60287c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  }
60387c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor
60487c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  unsigned cached_completion_size() const {
60587c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor    return CachedCompletionResults.size();
60687c08a5d6b9e1e44ae6f554df40139d3a6f60b33Douglas Gregor  }
607389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis
608686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  llvm::MemoryBuffer *getBufferForFile(StringRef Filename,
60975dfb65c38d51772df9a00ce2d2feeefd55667adChris Lattner                                       std::string *ErrorStr = 0);
610389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis
611467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor  /// \brief Determine what kind of translation unit this AST represents.
612467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor  TranslationUnitKind getTranslationUnitKind() const { return TUKind; }
613df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor
614b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis  typedef llvm::PointerUnion<const char *, const llvm::MemoryBuffer *>
615b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis      FilenameOrMemBuf;
6164db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor  /// \brief A mapping from a file name to the memory buffer that stores the
6174db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor  /// remapped contents of that file.
618b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis  typedef std::pair<std::string, FilenameOrMemBuf> RemappedFile;
619b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis
620b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis  /// \brief Create a ASTUnit. Gets ownership of the passed CompilerInvocation.
621b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis  static ASTUnit *create(CompilerInvocation *CI,
622d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                         llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags);
623b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis
6243c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// \brief Create a ASTUnit from an AST file.
6250853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis  ///
6263c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// \param Filename - The AST file to load.
6270853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis  ///
6285262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// \param Diags - The diagnostics engine to use for reporting errors; its
6295262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// lifetime is expected to extend past that of the returned ASTUnit.
63031b87d8006d4863dd9b17e515ac720941efc38e3Daniel Dunbar  ///
6313c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// \returns - The initialized ASTUnit or null if the AST failed to load.
6323c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  static ASTUnit *LoadFromASTFile(const std::string &Filename,
633d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                              llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
634389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis                                  const FileSystemOptions &FileSystemOpts,
6355cf48766d626ff6b223acc9d4b7e415ca8480836Ted Kremenek                                  bool OnlyLocalDecls = false,
6364db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor                                  RemappedFile *RemappedFiles = 0,
637a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor                                  unsigned NumRemappedFiles = 0,
638a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor                                  bool CaptureDiagnostics = false);
639521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar
6404cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorprivate:
6414cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \brief Helper function for \c LoadFromCompilerInvocation() and
6424cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \c LoadFromCommandLine(), which loads an AST from a compiler invocation.
6434cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  ///
6444cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \param PrecompilePreamble Whether to precompile the preamble of this
6454cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// translation unit, to improve the performance of reparsing.
6464cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  ///
6474cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \returns \c true if a catastrophic failure occurred (which means that the
6484cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  /// \c ASTUnit itself is invalid), or \c false otherwise.
6494cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor  bool LoadFromCompilerInvocation(bool PrecompilePreamble);
6504cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor
6514cd912aa94656697a44c3ebb159f05060300524eDouglas Gregorpublic:
6524cd912aa94656697a44c3ebb159f05060300524eDouglas Gregor
653d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// \brief Create an ASTUnit from a source file, via a CompilerInvocation
654d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// object, by invoking the optionally provided ASTFrontendAction.
655d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  ///
656d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// \param CI - The compiler invocation to use; it must have exactly one input
657d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// source file. The ASTUnit takes ownership of the CompilerInvocation object.
658d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  ///
659d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// \param Diags - The diagnostics engine to use for reporting errors; its
660d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// lifetime is expected to extend past that of the returned ASTUnit.
661d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  ///
662d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// \param Action - The ASTFrontendAction to invoke. Its ownership is not
663d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  /// transfered.
664abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis  ///
665abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis  /// \param Unit - optionally an already created ASTUnit. Its ownership is not
666abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis  /// transfered.
667d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis  static ASTUnit *LoadFromCompilerInvocationAction(CompilerInvocation *CI,
668d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                              llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
669abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis                                             ASTFrontendAction *Action = 0,
670abb5afadd11b19568359880faa5d966a4e33551cArgyrios Kyrtzidis                                             ASTUnit *Unit = 0);
671d808bd2978bd4ac95a92b309b038452b533fd7a0Argyrios Kyrtzidis
672521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  /// LoadFromCompilerInvocation - Create an ASTUnit from a source file, via a
673521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  /// CompilerInvocation object.
674521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  ///
675521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  /// \param CI - The compiler invocation to use; it must have exactly one input
676f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar  /// source file. The ASTUnit takes ownership of the CompilerInvocation object.
677521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  ///
6785262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// \param Diags - The diagnostics engine to use for reporting errors; its
6795262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// lifetime is expected to extend past that of the returned ASTUnit.
680521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  //
681521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we
682521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar  // shouldn't need to specify them at construction time.
683f7acc37450d59ef751df73acb91de73850cc6517Daniel Dunbar  static ASTUnit *LoadFromCompilerInvocation(CompilerInvocation *CI,
684d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                              llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
685a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor                                             bool OnlyLocalDecls = false,
68644c181aec37789f25f6c15543c164416f72e562aDouglas Gregor                                             bool CaptureDiagnostics = false,
687df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor                                             bool PrecompilePreamble = false,
688467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor                                      TranslationUnitKind TUKind = TU_Complete,
689dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor                                       bool CacheCodeCompletionResults = false,
690ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth                                       bool NestedMacroExpansions = true);
691521bf9c529e653ab28896d027352d3e16e2672d5Daniel Dunbar
6927b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  /// LoadFromCommandLine - Create an ASTUnit from a vector of command line
6937b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  /// arguments, which must specify exactly one source file.
6947b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  ///
6957b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  /// \param ArgBegin - The beginning of the argument vector.
6967b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  ///
6977b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  /// \param ArgEnd - The end of the argument vector.
6987b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  ///
6995262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// \param Diags - The diagnostics engine to use for reporting errors; its
7005262fda30b876c8aae95f2eb92e349418d6b14bbDaniel Dunbar  /// lifetime is expected to extend past that of the returned ASTUnit.
7017b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  ///
702869824e87940f97b87064db2df2861e82e08a8c6Daniel Dunbar  /// \param ResourceFilesPath - The path to the compiler resource files.
7037b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  //
7047b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  // FIXME: Move OnlyLocalDecls, UseBumpAllocator to setters on the ASTUnit, we
7057b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  // shouldn't need to specify them at construction time.
7067b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar  static ASTUnit *LoadFromCommandLine(const char **ArgBegin,
7077b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar                                      const char **ArgEnd,
708d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                              llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
709686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                                      StringRef ResourceFilesPath,
7107b55668db7618334cc40011d3c1e128524d89462Daniel Dunbar                                      bool OnlyLocalDecls = false,
711e47be3e9682e82da15059006f43c7f3c021e4fffDouglas Gregor                                      bool CaptureDiagnostics = false,
7124db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor                                      RemappedFile *RemappedFiles = 0,
713a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor                                      unsigned NumRemappedFiles = 0,
714299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis                                      bool RemappedFilesKeepOriginalName = true,
715df95a13ec73d2cdaea79555cb412d767f4963120Douglas Gregor                                      bool PrecompilePreamble = false,
716467dc88512b4ba4bb16e274ea3771dc1415d31daDouglas Gregor                                      TranslationUnitKind TUKind = TU_Complete,
71799ba202f659e1885fa5ee114f97c97cf6a857491Douglas Gregor                                      bool CacheCodeCompletionResults = false,
718ba7537febdf1bc1cc617e1f1746f2644feba6274Chandler Carruth                                      bool NestedMacroExpansions = true);
719abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor
720abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// \brief Reparse the source files using the same command-line options that
721abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// were originally used to produce this translation unit.
722abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  ///
723abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// \returns True if a failure occurred that causes the ASTUnit not to
724abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// contain any translation-unit information, false otherwise.
725abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  bool Reparse(RemappedFile *RemappedFiles = 0,
726abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor               unsigned NumRemappedFiles = 0);
7271abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor
7281abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor  /// \brief Perform code completion at the given file, line, and
7291abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor  /// column within this translation unit.
7301abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor  ///
731cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// \param File The file in which code completion will occur.
732cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  ///
733cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// \param Line The line at which code completion will occur.
734cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  ///
735cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// \param Column The column at which code completion will occur.
736cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  ///
737cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// \param IncludeMacros Whether to include macros in the code-completion
738cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// results.
739cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  ///
740cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// \param IncludeCodePatterns Whether to include code patterns (such as a
741cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor  /// for loop) in the code-completion results.
7421abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor  ///
7432283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor  /// FIXME: The Diag, LangOpts, SourceMgr, FileMgr, StoredDiagnostics, and
7442283d79155a3e82442fce124ce5fd704ca138801Douglas Gregor  /// OwnedBuffers parameters are all disgusting hacks. They will go away.
745686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  void CodeComplete(StringRef File, unsigned Line, unsigned Column,
7461abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor                    RemappedFile *RemappedFiles, unsigned NumRemappedFiles,
747cee235cdf0b8047761ffac598c4c3a32ab7411a2Douglas Gregor                    bool IncludeMacros, bool IncludeCodePatterns,
7481abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor                    CodeCompleteConsumer &Consumer,
749d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                    DiagnosticsEngine &Diag, LangOptions &LangOpts,
7501abc6bca3d7fb0e7b1e40fbcad6cfb5e10594548Douglas Gregor                    SourceManager &SourceMgr, FileManager &FileMgr,
751686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                    SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
752686775deca8b8685eb90801495880e3abdd844c2Chris Lattner              SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers);
7537ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor
7547ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor  /// \brief Save this translation unit to a file with the given name.
7557ae2faafd30524ef5f863bb3b8701977888839bbDouglas Gregor  ///
75639c411fa229b2a6747b92f945d1702ee674d3470Douglas Gregor  /// \returns An indication of whether the save was successful or not.
757686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  CXSaveError Save(StringRef File);
758b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis
759b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis  /// \brief Serialize this translation unit with the given output stream.
760b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis  ///
761b0f4b9a558933b307073f7cd7753602f94354ae9Argyrios Kyrtzidis  /// \returns True if an error occurred, false otherwise.
7628cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner  bool serialize(raw_ostream &OS);
7636aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor
7646aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor  virtual ModuleKey loadModule(SourceLocation ImportLoc,
7656aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor                               IdentifierInfo &ModuleName,
7666aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor                               SourceLocation ModuleNameLoc) {
7676aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor    // ASTUnit doesn't know how to load modules (not that this matters).
7686aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor    return 0;
7696aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor  }
7700853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis};
7710853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
7720853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis} // namespace clang
7730853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis
7740853a02c3b04d96a3c432b883e403175c954cd81Argyrios Kyrtzidis#endif
775