Changed FrontendActionFactory::create to return a std::unique_ptr
[lldb.git] / clang / lib / Tooling / Tooling.cpp
1 //===- Tooling.cpp - Running clang standalone tools -----------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 //  This file implements functions to run clang tools standalone instead
10 //  of running them as a plugin.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "clang/Tooling/Tooling.h"
15 #include "clang/Basic/Diagnostic.h"
16 #include "clang/Basic/DiagnosticIDs.h"
17 #include "clang/Basic/DiagnosticOptions.h"
18 #include "clang/Basic/FileManager.h"
19 #include "clang/Basic/FileSystemOptions.h"
20 #include "clang/Basic/LLVM.h"
21 #include "clang/Driver/Compilation.h"
22 #include "clang/Driver/Driver.h"
23 #include "clang/Driver/Job.h"
24 #include "clang/Driver/Options.h"
25 #include "clang/Driver/Tool.h"
26 #include "clang/Driver/ToolChain.h"
27 #include "clang/Frontend/ASTUnit.h"
28 #include "clang/Frontend/CompilerInstance.h"
29 #include "clang/Frontend/CompilerInvocation.h"
30 #include "clang/Frontend/FrontendDiagnostic.h"
31 #include "clang/Frontend/FrontendOptions.h"
32 #include "clang/Frontend/TextDiagnosticPrinter.h"
33 #include "clang/Lex/HeaderSearchOptions.h"
34 #include "clang/Lex/PreprocessorOptions.h"
35 #include "clang/Tooling/ArgumentsAdjusters.h"
36 #include "clang/Tooling/CompilationDatabase.h"
37 #include "llvm/ADT/ArrayRef.h"
38 #include "llvm/ADT/IntrusiveRefCntPtr.h"
39 #include "llvm/ADT/SmallString.h"
40 #include "llvm/ADT/StringRef.h"
41 #include "llvm/ADT/Twine.h"
42 #include "llvm/Option/ArgList.h"
43 #include "llvm/Option/OptTable.h"
44 #include "llvm/Option/Option.h"
45 #include "llvm/Support/Casting.h"
46 #include "llvm/Support/Debug.h"
47 #include "llvm/Support/ErrorHandling.h"
48 #include "llvm/Support/FileSystem.h"
49 #include "llvm/Support/Host.h"
50 #include "llvm/Support/MemoryBuffer.h"
51 #include "llvm/Support/Path.h"
52 #include "llvm/Support/VirtualFileSystem.h"
53 #include "llvm/Support/raw_ostream.h"
54 #include <cassert>
55 #include <cstring>
56 #include <memory>
57 #include <string>
58 #include <system_error>
59 #include <utility>
60 #include <vector>
61
62 #define DEBUG_TYPE "clang-tooling"
63
64 using namespace clang;
65 using namespace tooling;
66
67 ToolAction::~ToolAction() = default;
68
69 FrontendActionFactory::~FrontendActionFactory() = default;
70
71 // FIXME: This file contains structural duplication with other parts of the
72 // code that sets up a compiler to run tools on it, and we should refactor
73 // it to be based on the same framework.
74
75 /// Builds a clang driver initialized for running clang tools.
76 static driver::Driver *
77 newDriver(DiagnosticsEngine *Diagnostics, const char *BinaryName,
78           IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
79   driver::Driver *CompilerDriver =
80       new driver::Driver(BinaryName, llvm::sys::getDefaultTargetTriple(),
81                          *Diagnostics, std::move(VFS));
82   CompilerDriver->setTitle("clang_based_tool");
83   return CompilerDriver;
84 }
85
86 /// Retrieves the clang CC1 specific flags out of the compilation's jobs.
87 ///
88 /// Returns nullptr on error.
89 static const llvm::opt::ArgStringList *getCC1Arguments(
90     DiagnosticsEngine *Diagnostics, driver::Compilation *Compilation) {
91   // We expect to get back exactly one Command job, if we didn't something
92   // failed. Extract that job from the Compilation.
93   const driver::JobList &Jobs = Compilation->getJobs();
94   if (Jobs.size() != 1 || !isa<driver::Command>(*Jobs.begin())) {
95     SmallString<256> error_msg;
96     llvm::raw_svector_ostream error_stream(error_msg);
97     Jobs.Print(error_stream, "; ", true);
98     Diagnostics->Report(diag::err_fe_expected_compiler_job)
99         << error_stream.str();
100     return nullptr;
101   }
102
103   // The one job we find should be to invoke clang again.
104   const auto &Cmd = cast<driver::Command>(*Jobs.begin());
105   if (StringRef(Cmd.getCreator().getName()) != "clang") {
106     Diagnostics->Report(diag::err_fe_expected_clang_command);
107     return nullptr;
108   }
109
110   return &Cmd.getArguments();
111 }
112
113 namespace clang {
114 namespace tooling {
115
116 /// Returns a clang build invocation initialized from the CC1 flags.
117 CompilerInvocation *newInvocation(
118     DiagnosticsEngine *Diagnostics, const llvm::opt::ArgStringList &CC1Args) {
119   assert(!CC1Args.empty() && "Must at least contain the program name!");
120   CompilerInvocation *Invocation = new CompilerInvocation;
121   CompilerInvocation::CreateFromArgs(*Invocation, CC1Args, *Diagnostics);
122   Invocation->getFrontendOpts().DisableFree = false;
123   Invocation->getCodeGenOpts().DisableFree = false;
124   return Invocation;
125 }
126
127 bool runToolOnCode(FrontendAction *ToolAction, const Twine &Code,
128                    const Twine &FileName,
129                    std::shared_ptr<PCHContainerOperations> PCHContainerOps) {
130   return runToolOnCodeWithArgs(ToolAction, Code, std::vector<std::string>(),
131                                FileName, "clang-tool",
132                                std::move(PCHContainerOps));
133 }
134
135 } // namespace tooling
136 } // namespace clang
137
138 static std::vector<std::string>
139 getSyntaxOnlyToolArgs(const Twine &ToolName,
140                       const std::vector<std::string> &ExtraArgs,
141                       StringRef FileName) {
142   std::vector<std::string> Args;
143   Args.push_back(ToolName.str());
144   Args.push_back("-fsyntax-only");
145   Args.insert(Args.end(), ExtraArgs.begin(), ExtraArgs.end());
146   Args.push_back(FileName.str());
147   return Args;
148 }
149
150 namespace clang {
151 namespace tooling {
152
153 bool runToolOnCodeWithArgs(
154     FrontendAction *ToolAction, const Twine &Code,
155     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS,
156     const std::vector<std::string> &Args, const Twine &FileName,
157     const Twine &ToolName,
158     std::shared_ptr<PCHContainerOperations> PCHContainerOps) {
159   SmallString<16> FileNameStorage;
160   StringRef FileNameRef = FileName.toNullTerminatedStringRef(FileNameStorage);
161
162   llvm::IntrusiveRefCntPtr<FileManager> Files(
163       new FileManager(FileSystemOptions(), VFS));
164   ArgumentsAdjuster Adjuster = getClangStripDependencyFileAdjuster();
165   ToolInvocation Invocation(
166       getSyntaxOnlyToolArgs(ToolName, Adjuster(Args, FileNameRef), FileNameRef),
167       ToolAction, Files.get(),
168       std::move(PCHContainerOps));
169   return Invocation.run();
170 }
171
172 bool runToolOnCodeWithArgs(
173     FrontendAction *ToolAction, const Twine &Code,
174     const std::vector<std::string> &Args, const Twine &FileName,
175     const Twine &ToolName,
176     std::shared_ptr<PCHContainerOperations> PCHContainerOps,
177     const FileContentMappings &VirtualMappedFiles) {
178   llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> OverlayFileSystem(
179       new llvm::vfs::OverlayFileSystem(llvm::vfs::getRealFileSystem()));
180   llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem(
181       new llvm::vfs::InMemoryFileSystem);
182   OverlayFileSystem->pushOverlay(InMemoryFileSystem);
183
184   SmallString<1024> CodeStorage;
185   InMemoryFileSystem->addFile(FileName, 0,
186                               llvm::MemoryBuffer::getMemBuffer(
187                                   Code.toNullTerminatedStringRef(CodeStorage)));
188
189   for (auto &FilenameWithContent : VirtualMappedFiles) {
190     InMemoryFileSystem->addFile(
191         FilenameWithContent.first, 0,
192         llvm::MemoryBuffer::getMemBuffer(FilenameWithContent.second));
193   }
194
195   return runToolOnCodeWithArgs(ToolAction, Code, OverlayFileSystem, Args,
196                                FileName, ToolName);
197 }
198
199 llvm::Expected<std::string> getAbsolutePath(llvm::vfs::FileSystem &FS,
200                                             StringRef File) {
201   StringRef RelativePath(File);
202   // FIXME: Should '.\\' be accepted on Win32?
203   if (RelativePath.startswith("./")) {
204     RelativePath = RelativePath.substr(strlen("./"));
205   }
206
207   SmallString<1024> AbsolutePath = RelativePath;
208   if (auto EC = FS.makeAbsolute(AbsolutePath))
209     return llvm::errorCodeToError(EC);
210   llvm::sys::path::native(AbsolutePath);
211   return AbsolutePath.str();
212 }
213
214 std::string getAbsolutePath(StringRef File) {
215   return llvm::cantFail(getAbsolutePath(*llvm::vfs::getRealFileSystem(), File));
216 }
217
218 void addTargetAndModeForProgramName(std::vector<std::string> &CommandLine,
219                                     StringRef InvokedAs) {
220   if (!CommandLine.empty() && !InvokedAs.empty()) {
221     bool AlreadyHasTarget = false;
222     bool AlreadyHasMode = false;
223     // Skip CommandLine[0].
224     for (auto Token = ++CommandLine.begin(); Token != CommandLine.end();
225          ++Token) {
226       StringRef TokenRef(*Token);
227       AlreadyHasTarget |=
228           (TokenRef == "-target" || TokenRef.startswith("-target="));
229       AlreadyHasMode |= (TokenRef == "--driver-mode" ||
230                          TokenRef.startswith("--driver-mode="));
231     }
232     auto TargetMode =
233         driver::ToolChain::getTargetAndModeFromProgramName(InvokedAs);
234     if (!AlreadyHasMode && TargetMode.DriverMode) {
235       CommandLine.insert(++CommandLine.begin(), TargetMode.DriverMode);
236     }
237     if (!AlreadyHasTarget && TargetMode.TargetIsValid) {
238       CommandLine.insert(++CommandLine.begin(), {"-target",
239                                                  TargetMode.TargetPrefix});
240     }
241   }
242 }
243
244 } // namespace tooling
245 } // namespace clang
246
247 namespace {
248
249 class SingleFrontendActionFactory : public FrontendActionFactory {
250   std::unique_ptr<FrontendAction> Action;
251
252 public:
253   SingleFrontendActionFactory(std::unique_ptr<FrontendAction> Action)
254       : Action(std::move(Action)) {}
255
256   std::unique_ptr<FrontendAction> create() override {
257     return std::move(Action);
258   }
259 };
260
261 } // namespace
262
263 ToolInvocation::ToolInvocation(
264     std::vector<std::string> CommandLine, ToolAction *Action,
265     FileManager *Files, std::shared_ptr<PCHContainerOperations> PCHContainerOps)
266     : CommandLine(std::move(CommandLine)), Action(Action), OwnsAction(false),
267       Files(Files), PCHContainerOps(std::move(PCHContainerOps)) {}
268
269 ToolInvocation::ToolInvocation(
270     std::vector<std::string> CommandLine, FrontendAction *FAction,
271     FileManager *Files, std::shared_ptr<PCHContainerOperations> PCHContainerOps)
272     : CommandLine(std::move(CommandLine)),
273       Action(new SingleFrontendActionFactory(
274           std::unique_ptr<FrontendAction>(FAction))),
275       OwnsAction(true), Files(Files),
276       PCHContainerOps(std::move(PCHContainerOps)) {}
277
278 ToolInvocation::~ToolInvocation() {
279   if (OwnsAction)
280     delete Action;
281 }
282
283 void ToolInvocation::mapVirtualFile(StringRef FilePath, StringRef Content) {
284   SmallString<1024> PathStorage;
285   llvm::sys::path::native(FilePath, PathStorage);
286   MappedFileContents[PathStorage] = Content;
287 }
288
289 bool ToolInvocation::run() {
290   std::vector<const char*> Argv;
291   for (const std::string &Str : CommandLine)
292     Argv.push_back(Str.c_str());
293   const char *const BinaryName = Argv[0];
294   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
295   unsigned MissingArgIndex, MissingArgCount;
296   std::unique_ptr<llvm::opt::OptTable> Opts = driver::createDriverOptTable();
297   llvm::opt::InputArgList ParsedArgs = Opts->ParseArgs(
298       ArrayRef<const char *>(Argv).slice(1), MissingArgIndex, MissingArgCount);
299   ParseDiagnosticArgs(*DiagOpts, ParsedArgs);
300   TextDiagnosticPrinter DiagnosticPrinter(
301       llvm::errs(), &*DiagOpts);
302   DiagnosticsEngine Diagnostics(
303       IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()), &*DiagOpts,
304       DiagConsumer ? DiagConsumer : &DiagnosticPrinter, false);
305
306   const std::unique_ptr<driver::Driver> Driver(
307       newDriver(&Diagnostics, BinaryName, &Files->getVirtualFileSystem()));
308   // The "input file not found" diagnostics from the driver are useful.
309   // The driver is only aware of the VFS working directory, but some clients
310   // change this at the FileManager level instead.
311   // In this case the checks have false positives, so skip them.
312   if (!Files->getFileSystemOpts().WorkingDir.empty())
313     Driver->setCheckInputsExist(false);
314   const std::unique_ptr<driver::Compilation> Compilation(
315       Driver->BuildCompilation(llvm::makeArrayRef(Argv)));
316   if (!Compilation)
317     return false;
318   const llvm::opt::ArgStringList *const CC1Args = getCC1Arguments(
319       &Diagnostics, Compilation.get());
320   if (!CC1Args)
321     return false;
322   std::unique_ptr<CompilerInvocation> Invocation(
323       newInvocation(&Diagnostics, *CC1Args));
324   // FIXME: remove this when all users have migrated!
325   for (const auto &It : MappedFileContents) {
326     // Inject the code as the given file name into the preprocessor options.
327     std::unique_ptr<llvm::MemoryBuffer> Input =
328         llvm::MemoryBuffer::getMemBuffer(It.getValue());
329     Invocation->getPreprocessorOpts().addRemappedFile(It.getKey(),
330                                                       Input.release());
331   }
332   return runInvocation(BinaryName, Compilation.get(), std::move(Invocation),
333                        std::move(PCHContainerOps));
334 }
335
336 bool ToolInvocation::runInvocation(
337     const char *BinaryName, driver::Compilation *Compilation,
338     std::shared_ptr<CompilerInvocation> Invocation,
339     std::shared_ptr<PCHContainerOperations> PCHContainerOps) {
340   // Show the invocation, with -v.
341   if (Invocation->getHeaderSearchOpts().Verbose) {
342     llvm::errs() << "clang Invocation:\n";
343     Compilation->getJobs().Print(llvm::errs(), "\n", true);
344     llvm::errs() << "\n";
345   }
346
347   return Action->runInvocation(std::move(Invocation), Files,
348                                std::move(PCHContainerOps), DiagConsumer);
349 }
350
351 bool FrontendActionFactory::runInvocation(
352     std::shared_ptr<CompilerInvocation> Invocation, FileManager *Files,
353     std::shared_ptr<PCHContainerOperations> PCHContainerOps,
354     DiagnosticConsumer *DiagConsumer) {
355   // Create a compiler instance to handle the actual work.
356   CompilerInstance Compiler(std::move(PCHContainerOps));
357   Compiler.setInvocation(std::move(Invocation));
358   Compiler.setFileManager(Files);
359
360   // The FrontendAction can have lifetime requirements for Compiler or its
361   // members, and we need to ensure it's deleted earlier than Compiler. So we
362   // pass it to an std::unique_ptr declared after the Compiler variable.
363   std::unique_ptr<FrontendAction> ScopedToolAction(create());
364
365   // Create the compiler's actual diagnostics engine.
366   Compiler.createDiagnostics(DiagConsumer, /*ShouldOwnClient=*/false);
367   if (!Compiler.hasDiagnostics())
368     return false;
369
370   Compiler.createSourceManager(*Files);
371
372   const bool Success = Compiler.ExecuteAction(*ScopedToolAction);
373
374   Files->clearStatCache();
375   return Success;
376 }
377
378 ClangTool::ClangTool(const CompilationDatabase &Compilations,
379                      ArrayRef<std::string> SourcePaths,
380                      std::shared_ptr<PCHContainerOperations> PCHContainerOps,
381                      IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS)
382     : Compilations(Compilations), SourcePaths(SourcePaths),
383       PCHContainerOps(std::move(PCHContainerOps)),
384       OverlayFileSystem(new llvm::vfs::OverlayFileSystem(std::move(BaseFS))),
385       InMemoryFileSystem(new llvm::vfs::InMemoryFileSystem),
386       Files(new FileManager(FileSystemOptions(), OverlayFileSystem)) {
387   OverlayFileSystem->pushOverlay(InMemoryFileSystem);
388   appendArgumentsAdjuster(getClangStripOutputAdjuster());
389   appendArgumentsAdjuster(getClangSyntaxOnlyAdjuster());
390   appendArgumentsAdjuster(getClangStripDependencyFileAdjuster());
391 }
392
393 ClangTool::~ClangTool() = default;
394
395 void ClangTool::mapVirtualFile(StringRef FilePath, StringRef Content) {
396   MappedFileContents.push_back(std::make_pair(FilePath, Content));
397 }
398
399 void ClangTool::appendArgumentsAdjuster(ArgumentsAdjuster Adjuster) {
400   ArgsAdjuster = combineAdjusters(std::move(ArgsAdjuster), std::move(Adjuster));
401 }
402
403 void ClangTool::clearArgumentsAdjusters() {
404   ArgsAdjuster = nullptr;
405 }
406
407 static void injectResourceDir(CommandLineArguments &Args, const char *Argv0,
408                               void *MainAddr) {
409   // Allow users to override the resource dir.
410   for (StringRef Arg : Args)
411     if (Arg.startswith("-resource-dir"))
412       return;
413
414   // If there's no override in place add our resource dir.
415   Args.push_back("-resource-dir=" +
416                  CompilerInvocation::GetResourcesPath(Argv0, MainAddr));
417 }
418
419 int ClangTool::run(ToolAction *Action) {
420   // Exists solely for the purpose of lookup of the resource path.
421   // This just needs to be some symbol in the binary.
422   static int StaticSymbol;
423
424   // First insert all absolute paths into the in-memory VFS. These are global
425   // for all compile commands.
426   if (SeenWorkingDirectories.insert("/").second)
427     for (const auto &MappedFile : MappedFileContents)
428       if (llvm::sys::path::is_absolute(MappedFile.first))
429         InMemoryFileSystem->addFile(
430             MappedFile.first, 0,
431             llvm::MemoryBuffer::getMemBuffer(MappedFile.second));
432
433   bool ProcessingFailed = false;
434   bool FileSkipped = false;
435   // Compute all absolute paths before we run any actions, as those will change
436   // the working directory.
437   std::vector<std::string> AbsolutePaths;
438   AbsolutePaths.reserve(SourcePaths.size());
439   for (const auto &SourcePath : SourcePaths) {
440     auto AbsPath = getAbsolutePath(*OverlayFileSystem, SourcePath);
441     if (!AbsPath) {
442       llvm::errs() << "Skipping " << SourcePath
443                    << ". Error while getting an absolute path: "
444                    << llvm::toString(AbsPath.takeError()) << "\n";
445       continue;
446     }
447     AbsolutePaths.push_back(std::move(*AbsPath));
448   }
449
450   // Remember the working directory in case we need to restore it.
451   std::string InitialWorkingDir;
452   if (RestoreCWD) {
453     if (auto CWD = OverlayFileSystem->getCurrentWorkingDirectory()) {
454       InitialWorkingDir = std::move(*CWD);
455     } else {
456       llvm::errs() << "Could not get working directory: "
457                    << CWD.getError().message() << "\n";
458     }
459   }
460
461   for (llvm::StringRef File : AbsolutePaths) {
462     // Currently implementations of CompilationDatabase::getCompileCommands can
463     // change the state of the file system (e.g.  prepare generated headers), so
464     // this method needs to run right before we invoke the tool, as the next
465     // file may require a different (incompatible) state of the file system.
466     //
467     // FIXME: Make the compilation database interface more explicit about the
468     // requirements to the order of invocation of its members.
469     std::vector<CompileCommand> CompileCommandsForFile =
470         Compilations.getCompileCommands(File);
471     if (CompileCommandsForFile.empty()) {
472       llvm::errs() << "Skipping " << File << ". Compile command not found.\n";
473       FileSkipped = true;
474       continue;
475     }
476     for (CompileCommand &CompileCommand : CompileCommandsForFile) {
477       // FIXME: chdir is thread hostile; on the other hand, creating the same
478       // behavior as chdir is complex: chdir resolves the path once, thus
479       // guaranteeing that all subsequent relative path operations work
480       // on the same path the original chdir resulted in. This makes a
481       // difference for example on network filesystems, where symlinks might be
482       // switched during runtime of the tool. Fixing this depends on having a
483       // file system abstraction that allows openat() style interactions.
484       if (OverlayFileSystem->setCurrentWorkingDirectory(
485               CompileCommand.Directory))
486         llvm::report_fatal_error("Cannot chdir into \"" +
487                                  Twine(CompileCommand.Directory) + "\"!");
488
489       // Now fill the in-memory VFS with the relative file mappings so it will
490       // have the correct relative paths. We never remove mappings but that
491       // should be fine.
492       if (SeenWorkingDirectories.insert(CompileCommand.Directory).second)
493         for (const auto &MappedFile : MappedFileContents)
494           if (!llvm::sys::path::is_absolute(MappedFile.first))
495             InMemoryFileSystem->addFile(
496                 MappedFile.first, 0,
497                 llvm::MemoryBuffer::getMemBuffer(MappedFile.second));
498
499       std::vector<std::string> CommandLine = CompileCommand.CommandLine;
500       if (ArgsAdjuster)
501         CommandLine = ArgsAdjuster(CommandLine, CompileCommand.Filename);
502       assert(!CommandLine.empty());
503
504       // Add the resource dir based on the binary of this tool. argv[0] in the
505       // compilation database may refer to a different compiler and we want to
506       // pick up the very same standard library that compiler is using. The
507       // builtin headers in the resource dir need to match the exact clang
508       // version the tool is using.
509       // FIXME: On linux, GetMainExecutable is independent of the value of the
510       // first argument, thus allowing ClangTool and runToolOnCode to just
511       // pass in made-up names here. Make sure this works on other platforms.
512       injectResourceDir(CommandLine, "clang_tool", &StaticSymbol);
513
514       // FIXME: We need a callback mechanism for the tool writer to output a
515       // customized message for each file.
516       LLVM_DEBUG({ llvm::dbgs() << "Processing: " << File << ".\n"; });
517       ToolInvocation Invocation(std::move(CommandLine), Action, Files.get(),
518                                 PCHContainerOps);
519       Invocation.setDiagnosticConsumer(DiagConsumer);
520
521       if (!Invocation.run()) {
522         // FIXME: Diagnostics should be used instead.
523         if (PrintErrorMessage)
524           llvm::errs() << "Error while processing " << File << ".\n";
525         ProcessingFailed = true;
526       }
527     }
528   }
529
530   if (!InitialWorkingDir.empty()) {
531     if (auto EC =
532             OverlayFileSystem->setCurrentWorkingDirectory(InitialWorkingDir))
533       llvm::errs() << "Error when trying to restore working dir: "
534                    << EC.message() << "\n";
535   }
536   return ProcessingFailed ? 1 : (FileSkipped ? 2 : 0);
537 }
538
539 namespace {
540
541 class ASTBuilderAction : public ToolAction {
542   std::vector<std::unique_ptr<ASTUnit>> &ASTs;
543
544 public:
545   ASTBuilderAction(std::vector<std::unique_ptr<ASTUnit>> &ASTs) : ASTs(ASTs) {}
546
547   bool runInvocation(std::shared_ptr<CompilerInvocation> Invocation,
548                      FileManager *Files,
549                      std::shared_ptr<PCHContainerOperations> PCHContainerOps,
550                      DiagnosticConsumer *DiagConsumer) override {
551     std::unique_ptr<ASTUnit> AST = ASTUnit::LoadFromCompilerInvocation(
552         Invocation, std::move(PCHContainerOps),
553         CompilerInstance::createDiagnostics(&Invocation->getDiagnosticOpts(),
554                                             DiagConsumer,
555                                             /*ShouldOwnClient=*/false),
556         Files);
557     if (!AST)
558       return false;
559
560     ASTs.push_back(std::move(AST));
561     return true;
562   }
563 };
564
565 } // namespace
566
567 int ClangTool::buildASTs(std::vector<std::unique_ptr<ASTUnit>> &ASTs) {
568   ASTBuilderAction Action(ASTs);
569   return run(&Action);
570 }
571
572 void ClangTool::setRestoreWorkingDir(bool RestoreCWD) {
573   this->RestoreCWD = RestoreCWD;
574 }
575
576 void ClangTool::setPrintErrorMessage(bool PrintErrorMessage) {
577   this->PrintErrorMessage = PrintErrorMessage;
578 }
579
580 namespace clang {
581 namespace tooling {
582
583 std::unique_ptr<ASTUnit>
584 buildASTFromCode(StringRef Code, StringRef FileName,
585                  std::shared_ptr<PCHContainerOperations> PCHContainerOps) {
586   return buildASTFromCodeWithArgs(Code, std::vector<std::string>(), FileName,
587                                   "clang-tool", std::move(PCHContainerOps));
588 }
589
590 std::unique_ptr<ASTUnit> buildASTFromCodeWithArgs(
591     StringRef Code, const std::vector<std::string> &Args, StringRef FileName,
592     StringRef ToolName, std::shared_ptr<PCHContainerOperations> PCHContainerOps,
593     ArgumentsAdjuster Adjuster) {
594   std::vector<std::unique_ptr<ASTUnit>> ASTs;
595   ASTBuilderAction Action(ASTs);
596   llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> OverlayFileSystem(
597       new llvm::vfs::OverlayFileSystem(llvm::vfs::getRealFileSystem()));
598   llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem(
599       new llvm::vfs::InMemoryFileSystem);
600   OverlayFileSystem->pushOverlay(InMemoryFileSystem);
601   llvm::IntrusiveRefCntPtr<FileManager> Files(
602       new FileManager(FileSystemOptions(), OverlayFileSystem));
603
604   ToolInvocation Invocation(
605       getSyntaxOnlyToolArgs(ToolName, Adjuster(Args, FileName), FileName),
606       &Action, Files.get(), std::move(PCHContainerOps));
607
608   InMemoryFileSystem->addFile(FileName, 0,
609                               llvm::MemoryBuffer::getMemBufferCopy(Code));
610   if (!Invocation.run())
611     return nullptr;
612
613   assert(ASTs.size() == 1);
614   return std::move(ASTs[0]);
615 }
616
617 } // namespace tooling
618 } // namespace clang