clang 19.0.0git
FrontendActions.h
Go to the documentation of this file.
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
13#include <memory>
14#include <string>
15#include <vector>
16
17namespace clang {
18
19//===----------------------------------------------------------------------===//
20// Custom Consumer Actions
21//===----------------------------------------------------------------------===//
22
24 void ExecuteAction() override;
25
26 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
27 StringRef InFile) override;
28
29public:
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.
37 void ExecuteAction() override;
38
39 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
40 StringRef InFile) override;
41
42public:
43 bool usesPreprocessorOnly() const override { return false; }
44};
45
47 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
48 StringRef InFile) override {
49 return nullptr;
50 }
51
52 void ExecuteAction() override;
53
54public:
55 bool usesPreprocessorOnly() const override { return true; }
56};
57
58//===----------------------------------------------------------------------===//
59// AST Consumer Actions
60//===----------------------------------------------------------------------===//
61
63protected:
64 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
65 StringRef InFile) override;
66};
67
69protected:
70 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
71 StringRef InFile) override;
72};
73
75protected:
76 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
77 StringRef InFile) override;
78};
79
81protected:
82 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
83 StringRef InFile) override;
84};
85
87protected:
88 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
89 StringRef InFile) override;
90
92 return TU_Prefix;
93 }
94
95 bool hasASTFileSupport() const override { return false; }
96
97 bool shouldEraseOutputFiles() override;
98
99public:
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.
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
117 virtual std::unique_ptr<raw_pwrite_stream>
118 CreateOutputFile(CompilerInstance &CI, StringRef InFile) = 0;
119
120protected:
121 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
122 StringRef InFile) override;
123
125 return TU_Module;
126 }
127
128 bool hasASTFileSupport() const override { return false; }
129
130 bool shouldEraseOutputFiles() override;
131};
132
134protected:
135 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
136 StringRef InFile) override;
137
139 bool hasASTFileSupport() const override { return false; }
140};
141
143private:
144 bool BeginSourceFileAction(CompilerInstance &CI) override;
145
146 std::unique_ptr<raw_pwrite_stream>
147 CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
148};
149
151private:
152 bool BeginSourceFileAction(CompilerInstance &CI) override;
153
154 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
155 StringRef InFile) override;
156
157 std::unique_ptr<raw_pwrite_stream>
158 CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
159};
160
162
163private:
164 bool BeginSourceFileAction(CompilerInstance &CI) override;
165
166 std::unique_ptr<raw_pwrite_stream>
167 CreateOutputFile(CompilerInstance &CI, StringRef InFile) override;
168};
169
171protected:
172 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
173 StringRef InFile) override;
174
175public:
176 ~SyntaxOnlyAction() override;
177 bool hasCodeCompletionSupport() const override { return true; }
178};
179
180/// Dump information about the given module file, to be used for
181/// basic debugging and discovery.
183 // Allow other tools (ex lldb) to direct output for their use.
184 std::shared_ptr<llvm::raw_ostream> OutputStream;
185
186protected:
187 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
188 StringRef InFile) override;
189 bool BeginInvocation(CompilerInstance &CI) override;
190 void ExecuteAction() override;
191
192public:
194 explicit DumpModuleInfoAction(std::shared_ptr<llvm::raw_ostream> Out)
195 : OutputStream(Out) {}
196 bool hasPCHSupport() const override { return false; }
197 bool hasASTFileSupport() const override { return true; }
198 bool hasIRSupport() const override { return false; }
199 bool hasCodeCompletionSupport() const override { return false; }
200};
201
203protected:
204 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
205 StringRef InFile) override;
206
207 void ExecuteAction() override;
208
209public:
210 bool hasCodeCompletionSupport() const override { return false; }
211};
212
214protected:
215 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
216 StringRef InFile) override;
217
218 void ExecuteAction() override;
219};
220
221/**
222 * Frontend action adaptor that merges ASTs together.
223 *
224 * This action takes an existing AST file and "merges" it into the AST
225 * context, producing a merged context. This action is an action
226 * adaptor, which forwards most of its calls to another action that
227 * will consume the merged context.
228 */
230 /// The action that the merge action adapts.
231 std::unique_ptr<FrontendAction> AdaptedAction;
232
233 /// The set of AST files to merge.
234 std::vector<std::string> ASTFiles;
235
236protected:
237 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
238 StringRef InFile) override;
239
240 bool BeginSourceFileAction(CompilerInstance &CI) override;
241
242 void ExecuteAction() override;
243 void EndSourceFileAction() override;
244
245public:
246 ASTMergeAction(std::unique_ptr<FrontendAction> AdaptedAction,
247 ArrayRef<std::string> ASTFiles);
248 ~ASTMergeAction() override;
249
250 bool usesPreprocessorOnly() const override;
252 bool hasPCHSupport() const override;
253 bool hasASTFileSupport() const override;
254 bool hasCodeCompletionSupport() const override;
255};
256
258protected:
259 void ExecuteAction() override;
260 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &,
261 StringRef) override {
262 return nullptr;
263 }
264
265 bool usesPreprocessorOnly() const override { return true; }
266};
267
269protected:
270 void ExecuteAction() override;
271 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &,
272 StringRef) override {
273 return nullptr;
274 }
275
276 bool usesPreprocessorOnly() const override { return true; }
277};
278
279//===----------------------------------------------------------------------===//
280// Preprocessor Actions
281//===----------------------------------------------------------------------===//
282
284protected:
285 void ExecuteAction() override;
286};
287
289protected:
290 void ExecuteAction() override;
291};
292
294protected:
295 void ExecuteAction() override;
296};
297
299protected:
300 void ExecuteAction() override;
301
302 bool hasPCHSupport() const override { return true; }
303};
304
306 StringRef ModuleName;
307 void ExecuteAction() override;
308
309public:
311 : ModuleName(ModuleName) {}
312};
313
314} // end namespace clang
315
316#endif
Defines the clang::FrontendAction interface and various convenience abstract classes (clang::ASTFront...
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
Abstract base class to use for AST consumer-based frontend actions.
Frontend action adaptor that merges ASTs together.
bool hasCodeCompletionSupport() const override
Does this action support use with code completion?
Definition: ASTMerge.cpp:112
void EndSourceFileAction() override
Callback at the end of processing a single input.
Definition: ASTMerge.cpp:83
TranslationUnitKind getTranslationUnitKind() override
For AST-based actions, the kind of translation unit we're handling.
Definition: ASTMerge.cpp:100
~ASTMergeAction() override
Definition: ASTMerge.cpp:93
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
Definition: ASTMerge.cpp:96
bool hasASTFileSupport() const override
Does this action support use with AST files?
Definition: ASTMerge.cpp:108
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
Definition: ASTMerge.cpp:33
bool BeginSourceFileAction(CompilerInstance &CI) override
Callback at the start of processing a single input.
Definition: ASTMerge.cpp:24
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
Definition: ASTMerge.cpp:20
bool hasPCHSupport() const override
Does this action support use with PCH?
Definition: ASTMerge.cpp:104
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
Dump information about the given module file, to be used for basic debugging and discovery.
DumpModuleInfoAction(std::shared_ptr< llvm::raw_ostream > Out)
bool hasCodeCompletionSupport() const override
Does this action support use with code completion?
bool hasASTFileSupport() const override
Does this action support use with AST files?
bool hasIRSupport() const override
Does this action support use with IR files?
bool hasPCHSupport() const override
Does this action support use with PCH?
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
void ExecuteAction() override
Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.
bool BeginInvocation(CompilerInstance &CI) override
Callback before starting processing a single input, giving the opportunity to modify the CompilerInvo...
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
Abstract base class for actions which can be performed by the frontend.
friend class ASTMergeAction
TranslationUnitKind getTranslationUnitKind() override
For AST-based actions, the kind of translation unit we're handling.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
bool hasASTFileSupport() const override
Does this action support use with AST files?
bool shouldEraseOutputFiles() override
Callback at the end of processing a single input, to determine if the output files should be erased o...
TranslationUnitKind getTranslationUnitKind() override
For AST-based actions, the kind of translation unit we're handling.
bool hasASTFileSupport() const override
Does this action support use with AST files?
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
static std::unique_ptr< llvm::raw_pwrite_stream > CreateOutputFile(CompilerInstance &CI, StringRef InFile, std::string &OutputFile)
Creates file to write the PCH into and returns a stream to write it into.
bool BeginSourceFileAction(CompilerInstance &CI) override
Callback at the start of processing a single input.
TranslationUnitKind getTranslationUnitKind() override
For AST-based actions, the kind of translation unit we're handling.
static bool ComputeASTConsumerArguments(CompilerInstance &CI, std::string &Sysroot)
Compute the AST consumer arguments that will be used to create the PCHGenerator instance returned by ...
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
bool hasASTFileSupport() const override
Does this action support use with AST files?
bool shouldEraseOutputFiles() override
Callback at the end of processing a single input, to determine if the output files should be erased o...
GetDependenciesByModuleNameAction(StringRef ModuleName)
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
Abstract base class to use for preprocessor-based frontend actions.
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &, StringRef) override
Create the AST consumer object for this action, if supported.
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &, StringRef) override
Create the AST consumer object for this action, if supported.
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
bool hasPCHSupport() const override
Does this action support use with PCH?
Preprocessor-based frontend action that also loads PCH files.
bool usesPreprocessorOnly() const override
Does this action only use the preprocessor?
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
bool hasCodeCompletionSupport() const override
Does this action support use with code completion?
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
void ExecuteAction() override
Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
bool hasCodeCompletionSupport() const override
Does this action support use with code completion?
void ExecuteAction() override
Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.
The JSON file list parser is used to communicate input to InstallAPI.
TranslationUnitKind
Describes the kind of translation unit being processed.
Definition: LangOptions.h:987
@ TU_Module
The translation unit is a module.
Definition: LangOptions.h:996
@ TU_Prefix
The translation unit is a prefix to a translation unit, and is not complete.
Definition: LangOptions.h:993