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 GenerateHeaderModuleAction : public GenerateModuleAction { 159 /// The synthesized module input buffer for the current compilation. 160 std::unique_ptr<llvm::MemoryBuffer> Buffer; 161 std::vector<std::string> ModuleHeaders; 162 163 private: 164 bool PrepareToExecuteAction(CompilerInstance &CI) override; 165 bool BeginSourceFileAction(CompilerInstance &CI) override; 166 167 std::unique_ptr<raw_pwrite_stream> 168 CreateOutputFile(CompilerInstance &CI, StringRef InFile) override; 169 }; 170 171 class GenerateHeaderUnitAction : public GenerateModuleAction { 172 173 private: 174 bool BeginSourceFileAction(CompilerInstance &CI) override; 175 176 std::unique_ptr<raw_pwrite_stream> 177 CreateOutputFile(CompilerInstance &CI, StringRef InFile) override; 178 }; 179 180 class SyntaxOnlyAction : public ASTFrontendAction { 181 protected: 182 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, 183 StringRef InFile) override; 184 185 public: 186 ~SyntaxOnlyAction() override; 187 bool hasCodeCompletionSupport() const override { return true; } 188 }; 189 190 /// Dump information about the given module file, to be used for 191 /// basic debugging and discovery. 192 class DumpModuleInfoAction : public ASTFrontendAction { 193 protected: 194 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, 195 StringRef InFile) override; 196 bool BeginInvocation(CompilerInstance &CI) override; 197 void ExecuteAction() override; 198 199 public: 200 bool hasPCHSupport() const override { return false; } 201 bool hasASTFileSupport() const override { return true; } 202 bool hasIRSupport() const override { return false; } 203 bool hasCodeCompletionSupport() const override { return false; } 204 }; 205 206 class VerifyPCHAction : public ASTFrontendAction { 207 protected: 208 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, 209 StringRef InFile) override; 210 211 void ExecuteAction() override; 212 213 public: 214 bool hasCodeCompletionSupport() const override { return false; } 215 }; 216 217 class TemplightDumpAction : public ASTFrontendAction { 218 protected: 219 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, 220 StringRef InFile) override; 221 222 void ExecuteAction() override; 223 }; 224 225 /** 226 * Frontend action adaptor that merges ASTs together. 227 * 228 * This action takes an existing AST file and "merges" it into the AST 229 * context, producing a merged context. This action is an action 230 * adaptor, which forwards most of its calls to another action that 231 * will consume the merged context. 232 */ 233 class ASTMergeAction : public FrontendAction { 234 /// The action that the merge action adapts. 235 std::unique_ptr<FrontendAction> AdaptedAction; 236 237 /// The set of AST files to merge. 238 std::vector<std::string> ASTFiles; 239 240 protected: 241 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, 242 StringRef InFile) override; 243 244 bool BeginSourceFileAction(CompilerInstance &CI) override; 245 246 void ExecuteAction() override; 247 void EndSourceFileAction() override; 248 249 public: 250 ASTMergeAction(std::unique_ptr<FrontendAction> AdaptedAction, 251 ArrayRef<std::string> ASTFiles); 252 ~ASTMergeAction() override; 253 254 bool usesPreprocessorOnly() const override; 255 TranslationUnitKind getTranslationUnitKind() override; 256 bool hasPCHSupport() const override; 257 bool hasASTFileSupport() const override; 258 bool hasCodeCompletionSupport() const override; 259 }; 260 261 class PrintPreambleAction : public FrontendAction { 262 protected: 263 void ExecuteAction() override; 264 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &, 265 StringRef) override { 266 return nullptr; 267 } 268 269 bool usesPreprocessorOnly() const override { return true; } 270 }; 271 272 class PrintDependencyDirectivesSourceMinimizerAction : public FrontendAction { 273 protected: 274 void ExecuteAction() override; 275 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &, 276 StringRef) override { 277 return nullptr; 278 } 279 280 bool usesPreprocessorOnly() const override { return true; } 281 }; 282 283 //===----------------------------------------------------------------------===// 284 // Preprocessor Actions 285 //===----------------------------------------------------------------------===// 286 287 class DumpRawTokensAction : public PreprocessorFrontendAction { 288 protected: 289 void ExecuteAction() override; 290 }; 291 292 class DumpTokensAction : public PreprocessorFrontendAction { 293 protected: 294 void ExecuteAction() override; 295 }; 296 297 class PreprocessOnlyAction : public PreprocessorFrontendAction { 298 protected: 299 void ExecuteAction() override; 300 }; 301 302 class PrintPreprocessedAction : public PreprocessorFrontendAction { 303 protected: 304 void ExecuteAction() override; 305 306 bool hasPCHSupport() const override { return true; } 307 }; 308 309 class GetDependenciesByModuleNameAction : public PreprocessOnlyAction { 310 StringRef ModuleName; 311 void ExecuteAction() override; 312 313 public: 314 GetDependenciesByModuleNameAction(StringRef ModuleName) 315 : ModuleName(ModuleName) {} 316 }; 317 318 } // end namespace clang 319 320 #endif 321