1 //===-- FrontendActions.h - Useful Frontend Actions -------------*- 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 #ifndef LLVM_CLANG_FRONTEND_FRONTENDACTIONS_H
10 #define LLVM_CLANG_FRONTEND_FRONTENDACTIONS_H
11 
12 #include "clang/Frontend/FrontendAction.h"
13 #include <memory>
14 #include <string>
15 #include <vector>
16 
17 namespace clang {
18 
19 //===----------------------------------------------------------------------===//
20 // Custom Consumer Actions
21 //===----------------------------------------------------------------------===//
22 
23 class InitOnlyAction : public FrontendAction {
24   void ExecuteAction() override;
25 
26   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
27                                                  StringRef InFile) override;
28 
29 public:
30   // Don't claim to only use the preprocessor, we want to follow the AST path,
31   // but do nothing.
32   bool usesPreprocessorOnly() const override { return false; }
33 };
34 
35 /// Preprocessor-based frontend action that also loads PCH files.
36 class ReadPCHAndPreprocessAction : public FrontendAction {
37   void ExecuteAction() override;
38 
39   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
40                                                  StringRef InFile) override;
41 
42 public:
43   bool usesPreprocessorOnly() const override { return false; }
44 };
45 
46 class DumpCompilerOptionsAction : public FrontendAction {
47   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
48                                                  StringRef InFile) override {
49     return nullptr;
50   }
51 
52   void ExecuteAction() override;
53 
54 public:
55   bool usesPreprocessorOnly() const override { return true; }
56 };
57 
58 //===----------------------------------------------------------------------===//
59 // AST Consumer Actions
60 //===----------------------------------------------------------------------===//
61 
62 class ASTPrintAction : public ASTFrontendAction {
63 protected:
64   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
65                                                  StringRef InFile) override;
66 };
67 
68 class ASTDumpAction : public ASTFrontendAction {
69 protected:
70   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
71                                                  StringRef InFile) override;
72 };
73 
74 class ASTDeclListAction : public ASTFrontendAction {
75 protected:
76   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
77                                                  StringRef InFile) override;
78 };
79 
80 class ASTViewAction : public ASTFrontendAction {
81 protected:
82   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
83                                                  StringRef InFile) override;
84 };
85 
86 class GeneratePCHAction : public ASTFrontendAction {
87 protected:
88   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
89                                                  StringRef InFile) override;
90 
91   TranslationUnitKind getTranslationUnitKind() override {
92     return TU_Prefix;
93   }
94 
95   bool hasASTFileSupport() const override { return false; }
96 
97   bool shouldEraseOutputFiles() override;
98 
99 public:
100   /// Compute the AST consumer arguments that will be used to
101   /// create the PCHGenerator instance returned by CreateASTConsumer.
102   ///
103   /// \returns false if an error occurred, true otherwise.
104   static bool ComputeASTConsumerArguments(CompilerInstance &CI,
105                                           std::string &Sysroot);
106 
107   /// Creates file to write the PCH into and returns a stream to write it
108   /// into. On error, returns null.
109   static std::unique_ptr<llvm::raw_pwrite_stream>
110   CreateOutputFile(CompilerInstance &CI, StringRef InFile,
111                    std::string &OutputFile);
112 
113   bool BeginSourceFileAction(CompilerInstance &CI) override;
114 };
115 
116 class GenerateModuleAction : public ASTFrontendAction {
117   virtual std::unique_ptr<raw_pwrite_stream>
118   CreateOutputFile(CompilerInstance &CI, StringRef InFile) = 0;
119 
120 protected:
121   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
122                                                  StringRef InFile) override;
123 
124   TranslationUnitKind getTranslationUnitKind() override {
125     return TU_Module;
126   }
127 
128   bool hasASTFileSupport() const override { return false; }
129 
130   bool shouldEraseOutputFiles() override;
131 };
132 
133 class GenerateInterfaceStubsAction : public ASTFrontendAction {
134 protected:
135   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
136                                                  StringRef InFile) override;
137 
138   TranslationUnitKind getTranslationUnitKind() override { return TU_Module; }
139   bool hasASTFileSupport() const override { return false; }
140 };
141 
142 class GenerateModuleFromModuleMapAction : public GenerateModuleAction {
143 private:
144   bool BeginSourceFileAction(CompilerInstance &CI) override;
145 
146   std::unique_ptr<raw_pwrite_stream>
147   CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
148 };
149 
150 class GenerateModuleInterfaceAction : public GenerateModuleAction {
151 private:
152   bool BeginSourceFileAction(CompilerInstance &CI) override;
153 
154   std::unique_ptr<raw_pwrite_stream>
155   CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
156 };
157 
158 class GenerateHeaderUnitAction : public GenerateModuleAction {
159 
160 private:
161   bool BeginSourceFileAction(CompilerInstance &CI) override;
162 
163   std::unique_ptr<raw_pwrite_stream>
164   CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
165 };
166 
167 class SyntaxOnlyAction : public ASTFrontendAction {
168 protected:
169   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
170                                                  StringRef InFile) override;
171 
172 public:
173   ~SyntaxOnlyAction() override;
174   bool hasCodeCompletionSupport() const override { return true; }
175 };
176 
177 /// Dump information about the given module file, to be used for
178 /// basic debugging and discovery.
179 class DumpModuleInfoAction : public ASTFrontendAction {
180   // Allow other tools (ex lldb) to direct output for their use.
181   std::shared_ptr<llvm::raw_ostream> OutputStream;
182 
183 protected:
184   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
185                                                  StringRef InFile) override;
186   bool BeginInvocation(CompilerInstance &CI) override;
187   void ExecuteAction() override;
188 
189 public:
190   DumpModuleInfoAction() = default;
191   explicit DumpModuleInfoAction(std::shared_ptr<llvm::raw_ostream> Out)
192       : OutputStream(Out) {}
193   bool hasPCHSupport() const override { return false; }
194   bool hasASTFileSupport() const override { return true; }
195   bool hasIRSupport() const override { return false; }
196   bool hasCodeCompletionSupport() const override { return false; }
197 };
198 
199 class VerifyPCHAction : public ASTFrontendAction {
200 protected:
201   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
202                                                  StringRef InFile) override;
203 
204   void ExecuteAction() override;
205 
206 public:
207   bool hasCodeCompletionSupport() const override { return false; }
208 };
209 
210 class TemplightDumpAction : public ASTFrontendAction {
211 protected:
212   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
213                                                  StringRef InFile) override;
214 
215   void ExecuteAction() override;
216 };
217 
218 /**
219  * Frontend action adaptor that merges ASTs together.
220  *
221  * This action takes an existing AST file and "merges" it into the AST
222  * context, producing a merged context. This action is an action
223  * adaptor, which forwards most of its calls to another action that
224  * will consume the merged context.
225  */
226 class ASTMergeAction : public FrontendAction {
227   /// The action that the merge action adapts.
228   std::unique_ptr<FrontendAction> AdaptedAction;
229 
230   /// The set of AST files to merge.
231   std::vector<std::string> ASTFiles;
232 
233 protected:
234   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
235                                                  StringRef InFile) override;
236 
237   bool BeginSourceFileAction(CompilerInstance &CI) override;
238 
239   void ExecuteAction() override;
240   void EndSourceFileAction() override;
241 
242 public:
243   ASTMergeAction(std::unique_ptr<FrontendAction> AdaptedAction,
244                  ArrayRef<std::string> ASTFiles);
245   ~ASTMergeAction() override;
246 
247   bool usesPreprocessorOnly() const override;
248   TranslationUnitKind getTranslationUnitKind() override;
249   bool hasPCHSupport() const override;
250   bool hasASTFileSupport() const override;
251   bool hasCodeCompletionSupport() const override;
252 };
253 
254 class PrintPreambleAction : public FrontendAction {
255 protected:
256   void ExecuteAction() override;
257   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &,
258                                                  StringRef) override {
259     return nullptr;
260   }
261 
262   bool usesPreprocessorOnly() const override { return true; }
263 };
264 
265 class PrintDependencyDirectivesSourceMinimizerAction : public FrontendAction {
266 protected:
267   void ExecuteAction() override;
268   std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &,
269                                                  StringRef) override {
270     return nullptr;
271   }
272 
273   bool usesPreprocessorOnly() const override { return true; }
274 };
275 
276 //===----------------------------------------------------------------------===//
277 // Preprocessor Actions
278 //===----------------------------------------------------------------------===//
279 
280 class DumpRawTokensAction : public PreprocessorFrontendAction {
281 protected:
282   void ExecuteAction() override;
283 };
284 
285 class DumpTokensAction : public PreprocessorFrontendAction {
286 protected:
287   void ExecuteAction() override;
288 };
289 
290 class PreprocessOnlyAction : public PreprocessorFrontendAction {
291 protected:
292   void ExecuteAction() override;
293 };
294 
295 class PrintPreprocessedAction : public PreprocessorFrontendAction {
296 protected:
297   void ExecuteAction() override;
298 
299   bool hasPCHSupport() const override { return true; }
300 };
301 
302 class GetDependenciesByModuleNameAction : public PreprocessOnlyAction {
303   StringRef ModuleName;
304   void ExecuteAction() override;
305 
306 public:
307   GetDependenciesByModuleNameAction(StringRef ModuleName)
308       : ModuleName(ModuleName) {}
309 };
310 
311 }  // end namespace clang
312 
313 #endif
314