AllTUsExecution.h revision 360784 
1//===--- AllTUsExecution.h - Execute actions on all TUs. -*- C++ --------*-===//
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 defines a tool executor that runs given actions on all TUs in the
10//  compilation database. Tool results are deuplicated by the result key.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H
15#define LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H
16
17#include "clang/Tooling/ArgumentsAdjusters.h"
18#include "clang/Tooling/Execution.h"
19
20namespace clang {
21namespace tooling {
22
23/// Executes given frontend actions on all files/TUs in the compilation
24/// database.
25class AllTUsToolExecutor : public ToolExecutor {
26public:
27  static const char *ExecutorName;
28
29  /// Init with \p CompilationDatabase.
30  /// This uses \p ThreadCount threads to exececute the actions on all files in
31  /// parallel. If \p ThreadCount is 0, this uses `llvm::hardware_concurrency`.
32  AllTUsToolExecutor(const CompilationDatabase &Compilations,
33                     unsigned ThreadCount,
34                     std::shared_ptr<PCHContainerOperations> PCHContainerOps =
35                         std::make_shared<PCHContainerOperations>());
36
37  /// Init with \p CommonOptionsParser. This is expected to be used by
38  /// `createExecutorFromCommandLineArgs` based on commandline options.
39  ///
40  /// The executor takes ownership of \p Options.
41  AllTUsToolExecutor(CommonOptionsParser Options, unsigned ThreadCount,
42                     std::shared_ptr<PCHContainerOperations> PCHContainerOps =
43                         std::make_shared<PCHContainerOperations>());
44
45  StringRef getExecutorName() const override { return ExecutorName; }
46
47  using ToolExecutor::execute;
48
49  llvm::Error
50  execute(llvm::ArrayRef<
51          std::pair<std::unique_ptr<FrontendActionFactory>, ArgumentsAdjuster>>
52              Actions) override;
53
54  ExecutionContext *getExecutionContext() override { return &Context; };
55
56  ToolResults *getToolResults() override { return Results.get(); }
57
58  void mapVirtualFile(StringRef FilePath, StringRef Content) override {
59    OverlayFiles[FilePath] = Content;
60  }
61
62private:
63  // Used to store the parser when the executor is initialized with parser.
64  llvm::Optional<CommonOptionsParser> OptionsParser;
65  const CompilationDatabase &Compilations;
66  std::unique_ptr<ToolResults> Results;
67  ExecutionContext Context;
68  llvm::StringMap<std::string> OverlayFiles;
69  unsigned ThreadCount;
70};
71
72extern llvm::cl::opt<unsigned> ExecutorConcurrency;
73extern llvm::cl::opt<std::string> Filter;
74
75} // end namespace tooling
76} // end namespace clang
77
78#endif // LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H
79