1 //===-- FrontendAction.h - Generic Frontend Action Interface ----*- C++ -*-===//
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 //===----------------------------------------------------------------------===//
11 /// \brief Defines the clang::FrontendAction interface and various convenience
12 /// abstract classes (clang::ASTFrontendAction, clang::PluginASTAction,
13 /// clang::PreprocessorFrontendAction, and clang::WrapperFrontendAction)
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_CLANG_FRONTEND_FRONTENDACTION_H
19 #define LLVM_CLANG_FRONTEND_FRONTENDACTION_H
21 #include "clang/AST/ASTConsumer.h"
22 #include "clang/Basic/LLVM.h"
23 #include "clang/Basic/LangOptions.h"
24 #include "clang/Frontend/ASTUnit.h"
25 #include "clang/Frontend/FrontendOptions.h"
26 #include "llvm/ADT/StringRef.h"
33 class CompilerInstance;
35 /// Abstract base class for actions which can be performed by the frontend.
36 class FrontendAction {
37 FrontendInputFile CurrentInput;
38 std::unique_ptr<ASTUnit> CurrentASTUnit;
39 CompilerInstance *Instance;
40 friend class ASTMergeAction;
41 friend class WrapperFrontendAction;
44 std::unique_ptr<ASTConsumer> CreateWrappedASTConsumer(CompilerInstance &CI,
48 /// @name Implementation Action Interface
51 /// \brief Create the AST consumer object for this action, if supported.
53 /// This routine is called as part of BeginSourceFile(), which will
54 /// fail if the AST consumer cannot be created. This will not be called if the
55 /// action has indicated that it only uses the preprocessor.
57 /// \param CI - The current compiler instance, provided as a convenience, see
58 /// getCompilerInstance().
60 /// \param InFile - The current input file, provided as a convenience, see
63 /// \return The new AST consumer, or null on failure.
64 virtual std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
65 StringRef InFile) = 0;
67 /// \brief Callback before starting processing a single input, giving the
68 /// opportunity to modify the CompilerInvocation or do some other action
69 /// before BeginSourceFileAction is called.
71 /// \return True on success; on failure BeginSourceFileAction(),
72 /// ExecuteAction() and EndSourceFileAction() will not be called.
73 virtual bool BeginInvocation(CompilerInstance &CI) { return true; }
75 /// \brief Callback at the start of processing a single input.
77 /// \return True on success; on failure ExecutionAction() and
78 /// EndSourceFileAction() will not be called.
79 virtual bool BeginSourceFileAction(CompilerInstance &CI,
84 /// \brief Callback to run the program action, using the initialized
85 /// compiler instance.
87 /// This is guaranteed to only be called between BeginSourceFileAction()
88 /// and EndSourceFileAction().
89 virtual void ExecuteAction() = 0;
91 /// \brief Callback at the end of processing a single input.
93 /// This is guaranteed to only be called following a successful call to
94 /// BeginSourceFileAction (and BeginSourceFile).
95 virtual void EndSourceFileAction() {}
97 /// \brief Callback at the end of processing a single input, to determine
98 /// if the output files should be erased or not.
100 /// By default it returns true if a compiler error occurred.
101 /// This is guaranteed to only be called following a successful call to
102 /// BeginSourceFileAction (and BeginSourceFile).
103 virtual bool shouldEraseOutputFiles();
109 virtual ~FrontendAction();
111 /// @name Compiler Instance Access
114 CompilerInstance &getCompilerInstance() const {
115 assert(Instance && "Compiler instance not registered!");
119 void setCompilerInstance(CompilerInstance *Value) { Instance = Value; }
122 /// @name Current File Information
125 bool isCurrentFileAST() const {
126 assert(!CurrentInput.isEmpty() && "No current file!");
127 return (bool)CurrentASTUnit;
130 const FrontendInputFile &getCurrentInput() const {
134 const StringRef getCurrentFile() const {
135 assert(!CurrentInput.isEmpty() && "No current file!");
136 return CurrentInput.getFile();
139 InputKind getCurrentFileKind() const {
140 assert(!CurrentInput.isEmpty() && "No current file!");
141 return CurrentInput.getKind();
144 ASTUnit &getCurrentASTUnit() const {
145 assert(CurrentASTUnit && "No current AST unit!");
146 return *CurrentASTUnit;
149 Module *getCurrentModule() const;
151 std::unique_ptr<ASTUnit> takeCurrentASTUnit() {
152 return std::move(CurrentASTUnit);
155 void setCurrentInput(const FrontendInputFile &CurrentInput,
156 std::unique_ptr<ASTUnit> AST = nullptr);
159 /// @name Supported Modes
162 /// \brief Is this action invoked on a model file?
164 /// Model files are incomplete translation units that relies on type
165 /// information from another translation unit. Check ParseModelFileAction for
167 virtual bool isModelParsingAction() const { return false; }
169 /// \brief Does this action only use the preprocessor?
171 /// If so no AST context will be created and this action will be invalid
172 /// with AST file inputs.
173 virtual bool usesPreprocessorOnly() const = 0;
175 /// \brief For AST-based actions, the kind of translation unit we're handling.
176 virtual TranslationUnitKind getTranslationUnitKind() { return TU_Complete; }
178 /// \brief Does this action support use with PCH?
179 virtual bool hasPCHSupport() const { return !usesPreprocessorOnly(); }
181 /// \brief Does this action support use with AST files?
182 virtual bool hasASTFileSupport() const { return !usesPreprocessorOnly(); }
184 /// \brief Does this action support use with IR files?
185 virtual bool hasIRSupport() const { return false; }
187 /// \brief Does this action support use with code completion?
188 virtual bool hasCodeCompletionSupport() const { return false; }
191 /// @name Public Action Interface
194 /// \brief Prepare the action for processing the input file \p Input.
196 /// This is run after the options and frontend have been initialized,
197 /// but prior to executing any per-file processing.
199 /// \param CI - The compiler instance this action is being run from. The
200 /// action may store and use this object up until the matching EndSourceFile
203 /// \param Input - The input filename and kind. Some input kinds are handled
204 /// specially, for example AST inputs, since the AST file itself contains
205 /// several objects which would normally be owned by the
206 /// CompilerInstance. When processing AST input files, these objects should
207 /// generally not be initialized in the CompilerInstance -- they will
208 /// automatically be shared with the AST file in between
209 /// BeginSourceFile() and EndSourceFile().
211 /// \return True on success; on failure the compilation of this file should
212 /// be aborted and neither Execute() nor EndSourceFile() should be called.
213 bool BeginSourceFile(CompilerInstance &CI, const FrontendInputFile &Input);
215 /// \brief Set the source manager's main input file, and run the action.
218 /// \brief Perform any per-file post processing, deallocate per-file
219 /// objects, and run statistics and output file cleanup code.
220 void EndSourceFile();
225 /// \brief Abstract base class to use for AST consumer-based frontend actions.
226 class ASTFrontendAction : public FrontendAction {
228 /// \brief Implement the ExecuteAction interface by running Sema on
229 /// the already-initialized AST consumer.
231 /// This will also take care of instantiating a code completion consumer if
232 /// the user requested it and the action supports it.
233 void ExecuteAction() override;
236 ASTFrontendAction() {}
237 bool usesPreprocessorOnly() const override { return false; }
240 class PluginASTAction : public ASTFrontendAction {
241 virtual void anchor();
243 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
244 StringRef InFile) override = 0;
246 /// \brief Parse the given plugin command line arguments.
248 /// \param CI - The compiler instance, for use in reporting diagnostics.
249 /// \return True if the parsing succeeded; otherwise the plugin will be
250 /// destroyed and no action run. The plugin is responsible for using the
251 /// CompilerInstance's Diagnostic object to report errors.
252 virtual bool ParseArgs(const CompilerInstance &CI,
253 const std::vector<std::string> &arg) = 0;
256 Cmdline, ///< Action is determined by the cc1 command-line
257 ReplaceAction, ///< Replace the main action
258 AddBeforeMainAction, ///< Execute the action before the main action
259 AddAfterMainAction ///< Execute the action after the main action
261 /// \brief Get the action type for this plugin
263 /// \return The action type. If the type is Cmdline then by default the
264 /// plugin does nothing and what it does is determined by the cc1
266 virtual ActionType getActionType() { return Cmdline; }
269 /// \brief Abstract base class to use for preprocessor-based frontend actions.
270 class PreprocessorFrontendAction : public FrontendAction {
272 /// \brief Provide a default implementation which returns aborts;
273 /// this method should never be called by FrontendAction clients.
274 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
275 StringRef InFile) override;
278 bool usesPreprocessorOnly() const override { return true; }
281 /// \brief A frontend action which simply wraps some other runtime-specified
284 /// Deriving from this class allows an action to inject custom logic around
285 /// some existing action's behavior. It implements every virtual method in
286 /// the FrontendAction interface by forwarding to the wrapped action.
287 class WrapperFrontendAction : public FrontendAction {
288 std::unique_ptr<FrontendAction> WrappedAction;
291 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
292 StringRef InFile) override;
293 bool BeginInvocation(CompilerInstance &CI) override;
294 bool BeginSourceFileAction(CompilerInstance &CI, StringRef Filename) override;
295 void ExecuteAction() override;
296 void EndSourceFileAction() override;
299 /// Construct a WrapperFrontendAction from an existing action, taking
301 WrapperFrontendAction(std::unique_ptr<FrontendAction> WrappedAction);
303 bool usesPreprocessorOnly() const override;
304 TranslationUnitKind getTranslationUnitKind() override;
305 bool hasPCHSupport() const override;
306 bool hasASTFileSupport() const override;
307 bool hasIRSupport() const override;
308 bool hasCodeCompletionSupport() const override;
311 } // end namespace clang