1 //===--- ASTUnit.cpp - ASTUnit utility ------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // ASTUnit Implementation.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Frontend/ASTUnit.h"
15 #include "clang/Frontend/PCHReader.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/ASTConsumer.h"
18 #include "clang/AST/DeclVisitor.h"
19 #include "clang/AST/StmtVisitor.h"
20 #include "clang/Driver/Compilation.h"
21 #include "clang/Driver/Driver.h"
22 #include "clang/Driver/Job.h"
23 #include "clang/Driver/Tool.h"
24 #include "clang/Frontend/CompilerInstance.h"
25 #include "clang/Frontend/FrontendActions.h"
26 #include "clang/Frontend/FrontendDiagnostic.h"
27 #include "clang/Frontend/FrontendOptions.h"
28 #include "clang/Lex/HeaderSearch.h"
29 #include "clang/Lex/Preprocessor.h"
30 #include "clang/Basic/TargetOptions.h"
31 #include "clang/Basic/TargetInfo.h"
32 #include "clang/Basic/Diagnostic.h"
33 #include "llvm/Support/MemoryBuffer.h"
34 #include "llvm/System/Host.h"
35 #include "llvm/System/Path.h"
36 using namespace clang;
38 ASTUnit::ASTUnit(bool _MainFileIsAST)
39 : tempFile(false), MainFileIsAST(_MainFileIsAST) {
43 llvm::sys::Path(getPCHFileName()).eraseFromDisk();
48 /// \brief Gathers information from PCHReader that will be used to initialize
50 class PCHInfoCollector : public PCHReaderListener {
53 std::string &TargetTriple;
54 std::string &Predefines;
57 unsigned NumHeaderInfos;
60 PCHInfoCollector(LangOptions &LangOpt, HeaderSearch &HSI,
61 std::string &TargetTriple, std::string &Predefines,
63 : LangOpt(LangOpt), HSI(HSI), TargetTriple(TargetTriple),
64 Predefines(Predefines), Counter(Counter), NumHeaderInfos(0) {}
66 virtual bool ReadLanguageOptions(const LangOptions &LangOpts) {
71 virtual bool ReadTargetTriple(llvm::StringRef Triple) {
72 TargetTriple = Triple;
76 virtual bool ReadPredefinesBuffer(llvm::StringRef PCHPredef,
78 llvm::StringRef OriginalFileName,
79 std::string &SuggestedPredefines) {
80 Predefines = PCHPredef;
84 virtual void ReadHeaderFileInfo(const HeaderFileInfo &HFI) {
85 HSI.setHeaderFileInfoForUID(HFI, NumHeaderInfos++);
88 virtual void ReadCounter(unsigned Value) {
93 } // anonymous namespace
95 const std::string &ASTUnit::getOriginalSourceFileName() {
96 return OriginalSourceFile;
99 const std::string &ASTUnit::getPCHFileName() {
100 assert(isMainFileAST() && "Not an ASTUnit from a PCH file!");
101 return dyn_cast<PCHReader>(Ctx->getExternalSource())->getFileName();
104 ASTUnit *ASTUnit::LoadFromPCHFile(const std::string &Filename,
107 bool UseBumpAllocator,
108 RemappedFile *RemappedFiles,
109 unsigned NumRemappedFiles) {
110 llvm::OwningPtr<ASTUnit> AST(new ASTUnit(true));
111 AST->OnlyLocalDecls = OnlyLocalDecls;
112 AST->HeaderInfo.reset(new HeaderSearch(AST->getFileManager()));
114 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
115 // Create the file entry for the file that we're mapping from.
116 const FileEntry *FromFile
117 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
118 RemappedFiles[I].second->getBufferSize(),
121 Diags.Report(diag::err_fe_remap_missing_from_file)
122 << RemappedFiles[I].first;
126 // Override the contents of the "from" file with the contents of
128 AST->getSourceManager().overrideFileContents(FromFile,
129 RemappedFiles[I].second);
132 // Gather Info for preprocessor construction later on.
134 LangOptions LangInfo;
135 HeaderSearch &HeaderInfo = *AST->HeaderInfo.get();
136 std::string TargetTriple;
137 std::string Predefines;
140 llvm::OwningPtr<PCHReader> Reader;
141 llvm::OwningPtr<ExternalASTSource> Source;
143 Reader.reset(new PCHReader(AST->getSourceManager(), AST->getFileManager(),
145 Reader->setListener(new PCHInfoCollector(LangInfo, HeaderInfo, TargetTriple,
146 Predefines, Counter));
148 switch (Reader->ReadPCH(Filename)) {
149 case PCHReader::Success:
152 case PCHReader::Failure:
153 case PCHReader::IgnorePCH:
154 Diags.Report(diag::err_fe_unable_to_load_pch);
158 AST->OriginalSourceFile = Reader->getOriginalSourceFile();
160 // PCH loaded successfully. Now create the preprocessor.
162 // Get information about the target being compiled for.
164 // FIXME: This is broken, we should store the TargetOptions in the PCH.
165 TargetOptions TargetOpts;
168 TargetOpts.Features.clear();
169 TargetOpts.Triple = TargetTriple;
170 AST->Target.reset(TargetInfo::CreateTargetInfo(Diags, TargetOpts));
171 AST->PP.reset(new Preprocessor(Diags, LangInfo, *AST->Target.get(),
172 AST->getSourceManager(), HeaderInfo));
173 Preprocessor &PP = *AST->PP.get();
175 PP.setPredefines(Reader->getSuggestedPredefines());
176 PP.setCounterValue(Counter);
177 Reader->setPreprocessor(PP);
179 // Create and initialize the ASTContext.
181 AST->Ctx.reset(new ASTContext(LangInfo,
182 AST->getSourceManager(),
184 PP.getIdentifierTable(),
185 PP.getSelectorTable(),
187 /* FreeMemory = */ !UseBumpAllocator,
188 /* size_reserve = */0));
189 ASTContext &Context = *AST->Ctx.get();
191 Reader->InitializeContext(Context);
193 // Attach the PCH reader to the AST context as an external AST
194 // source, so that declarations will be deserialized from the
195 // PCH file as needed.
196 Source.reset(Reader.take());
197 Context.setExternalSource(Source);
204 class TopLevelDeclTrackerConsumer : public ASTConsumer {
208 TopLevelDeclTrackerConsumer(ASTUnit &_Unit) : Unit(_Unit) {}
210 void HandleTopLevelDecl(DeclGroupRef D) {
211 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it)
212 Unit.getTopLevelDecls().push_back(*it);
216 class TopLevelDeclTrackerAction : public ASTFrontendAction {
220 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
221 llvm::StringRef InFile) {
222 return new TopLevelDeclTrackerConsumer(Unit);
226 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
228 virtual bool hasCodeCompletionSupport() const { return false; }
233 ASTUnit *ASTUnit::LoadFromCompilerInvocation(const CompilerInvocation &CI,
235 bool OnlyLocalDecls) {
236 // Create the compiler instance to use for building the AST.
237 CompilerInstance Clang;
238 llvm::OwningPtr<ASTUnit> AST;
239 llvm::OwningPtr<TopLevelDeclTrackerAction> Act;
241 Clang.getInvocation() = CI;
243 Clang.setDiagnostics(&Diags);
244 Clang.setDiagnosticClient(Diags.getClient());
246 // Create the target instance.
247 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
248 Clang.getTargetOpts()));
249 if (!Clang.hasTarget())
252 // Inform the target of the language options.
254 // FIXME: We shouldn't need to do this, the target should be immutable once
255 // created. This complexity should be lifted elsewhere.
256 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
258 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
259 "Invocation must have exactly one source file!");
260 assert(Clang.getFrontendOpts().Inputs[0].first != FrontendOptions::IK_AST &&
261 "FIXME: AST inputs not yet supported here!");
263 // Create the AST unit.
264 AST.reset(new ASTUnit(false));
266 AST->OnlyLocalDecls = OnlyLocalDecls;
267 AST->OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
269 // Create a file manager object to provide access to and cache the filesystem.
270 Clang.setFileManager(&AST->getFileManager());
272 // Create the source manager.
273 Clang.setSourceManager(&AST->getSourceManager());
275 // Create the preprocessor.
276 Clang.createPreprocessor();
278 Act.reset(new TopLevelDeclTrackerAction(*AST));
279 if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
285 // Steal the created target, context, and preprocessor, and take back the
286 // source and file managers.
287 AST->Ctx.reset(Clang.takeASTContext());
288 AST->PP.reset(Clang.takePreprocessor());
289 Clang.takeSourceManager();
290 Clang.takeFileManager();
291 AST->Target.reset(Clang.takeTarget());
293 Act->EndSourceFile();
295 Clang.takeDiagnosticClient();
296 Clang.takeDiagnostics();
301 Clang.takeSourceManager();
302 Clang.takeFileManager();
303 Clang.takeDiagnosticClient();
304 Clang.takeDiagnostics();
308 ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin,
311 llvm::StringRef ResourceFilesPath,
313 bool UseBumpAllocator,
314 RemappedFile *RemappedFiles,
315 unsigned NumRemappedFiles) {
316 llvm::SmallVector<const char *, 16> Args;
317 Args.push_back("<clang>"); // FIXME: Remove dummy argument.
318 Args.insert(Args.end(), ArgBegin, ArgEnd);
320 // FIXME: Find a cleaner way to force the driver into restricted modes. We
321 // also want to force it to use clang.
322 Args.push_back("-fsyntax-only");
324 // FIXME: We shouldn't have to pass in the path info.
325 driver::Driver TheDriver("clang", "/", llvm::sys::getHostTriple(),
326 "a.out", false, Diags);
327 llvm::OwningPtr<driver::Compilation> C(
328 TheDriver.BuildCompilation(Args.size(), Args.data()));
330 // We expect to get back exactly one command job, if we didn't something
332 const driver::JobList &Jobs = C->getJobs();
333 if (Jobs.size() != 1 || !isa<driver::Command>(Jobs.begin())) {
334 llvm::SmallString<256> Msg;
335 llvm::raw_svector_ostream OS(Msg);
336 C->PrintJob(OS, C->getJobs(), "; ", true);
337 Diags.Report(diag::err_fe_expected_compiler_job) << OS.str();
341 const driver::Command *Cmd = cast<driver::Command>(*Jobs.begin());
342 if (llvm::StringRef(Cmd->getCreator().getName()) != "clang") {
343 Diags.Report(diag::err_fe_expected_clang_command);
347 const driver::ArgStringList &CCArgs = Cmd->getArguments();
348 CompilerInvocation CI;
349 CompilerInvocation::CreateFromArgs(CI, (const char**) CCArgs.data(),
350 (const char**) CCArgs.data()+CCArgs.size(),
353 // Override any files that need remapping
354 for (unsigned I = 0; I != NumRemappedFiles; ++I)
355 CI.getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
356 RemappedFiles[I].second);
358 // Override the resources path.
359 CI.getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
361 CI.getFrontendOpts().DisableFree = UseBumpAllocator;
362 return LoadFromCompilerInvocation(CI, Diags, OnlyLocalDecls);