xref: /llvm-project/clang/lib/FrontendTool/ExecuteCompilerInvocation.cpp (revision ce2c726e99b4fde2f6adff6772e8fa6396b9f332)
1 //===--- ExecuteCompilerInvocation.cpp ------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file holds ExecuteCompilerInvocation(). It is split into its own file to
11 // minimize the impact of pulling in essentially everything else in Clang.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/FrontendTool/Utils.h"
16 #include "clang/ARCMigrate/ARCMTActions.h"
17 #include "clang/CodeGen/CodeGenAction.h"
18 #include "clang/Driver/Options.h"
19 #include "clang/Frontend/CompilerInstance.h"
20 #include "clang/Frontend/CompilerInvocation.h"
21 #include "clang/Frontend/FrontendActions.h"
22 #include "clang/Frontend/FrontendDiagnostic.h"
23 #include "clang/Frontend/FrontendPluginRegistry.h"
24 #include "clang/Frontend/Utils.h"
25 #include "clang/Rewrite/Frontend/FrontendActions.h"
26 #include "clang/StaticAnalyzer/Frontend/FrontendActions.h"
27 #include "llvm/Option/OptTable.h"
28 #include "llvm/Option/Option.h"
29 #include "llvm/Support/DynamicLibrary.h"
30 #include "llvm/Support/ErrorHandling.h"
31 using namespace clang;
32 using namespace llvm::opt;
33 
34 static FrontendAction *CreateFrontendBaseAction(CompilerInstance &CI) {
35   using namespace clang::frontend;
36   StringRef Action("unknown");
37   (void)Action;
38 
39   switch (CI.getFrontendOpts().ProgramAction) {
40   case ASTDeclList:            return new ASTDeclListAction();
41   case ASTDump:                return new ASTDumpAction();
42   case ASTPrint:               return new ASTPrintAction();
43   case ASTView:                return new ASTViewAction();
44   case DumpRawTokens:          return new DumpRawTokensAction();
45   case DumpTokens:             return new DumpTokensAction();
46   case EmitAssembly:           return new EmitAssemblyAction();
47   case EmitBC:                 return new EmitBCAction();
48 #ifdef CLANG_ENABLE_REWRITER
49   case EmitHTML:               return new HTMLPrintAction();
50 #else
51   case EmitHTML:               Action = "EmitHTML"; break;
52 #endif
53   case EmitLLVM:               return new EmitLLVMAction();
54   case EmitLLVMOnly:           return new EmitLLVMOnlyAction();
55   case EmitCodeGenOnly:        return new EmitCodeGenOnlyAction();
56   case EmitObj:                return new EmitObjAction();
57 #ifdef CLANG_ENABLE_REWRITER
58   case FixIt:                  return new FixItAction();
59 #else
60   case FixIt:                  Action = "FixIt"; break;
61 #endif
62   case GenerateModule:         return new GenerateModuleAction;
63   case GeneratePCH:            return new GeneratePCHAction;
64   case GeneratePTH:            return new GeneratePTHAction();
65   case InitOnly:               return new InitOnlyAction();
66   case ParseSyntaxOnly:        return new SyntaxOnlyAction();
67   case ModuleFileInfo:         return new DumpModuleInfoAction();
68 
69   case PluginAction: {
70     for (FrontendPluginRegistry::iterator it =
71            FrontendPluginRegistry::begin(), ie = FrontendPluginRegistry::end();
72          it != ie; ++it) {
73       if (it->getName() == CI.getFrontendOpts().ActionName) {
74         OwningPtr<PluginASTAction> P(it->instantiate());
75         if (!P->ParseArgs(CI, CI.getFrontendOpts().PluginArgs))
76           return 0;
77         return P.take();
78       }
79     }
80 
81     CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
82       << CI.getFrontendOpts().ActionName;
83     return 0;
84   }
85 
86   case PrintDeclContext:       return new DeclContextPrintAction();
87   case PrintPreamble:          return new PrintPreambleAction();
88   case PrintPreprocessedInput: {
89     if (CI.getPreprocessorOutputOpts().RewriteIncludes) {
90 #ifdef CLANG_ENABLE_REWRITER
91       return new RewriteIncludesAction();
92 #else
93       Action = "RewriteIncludesAction";
94       break;
95 #endif
96     }
97     return new PrintPreprocessedAction();
98   }
99 
100 #ifdef CLANG_ENABLE_REWRITER
101   case RewriteMacros:          return new RewriteMacrosAction();
102   case RewriteObjC:            return new RewriteObjCAction();
103   case RewriteTest:            return new RewriteTestAction();
104 #else
105   case RewriteMacros:          Action = "RewriteMacros"; break;
106   case RewriteObjC:            Action = "RewriteObjC"; break;
107   case RewriteTest:            Action = "RewriteTest"; break;
108 #endif
109 #ifdef CLANG_ENABLE_ARCMT
110   case MigrateSource:          return new arcmt::MigrateSourceAction();
111 #else
112   case MigrateSource:          Action = "MigrateSource"; break;
113 #endif
114 #ifdef CLANG_ENABLE_STATIC_ANALYZER
115   case RunAnalysis:            return new ento::AnalysisAction();
116 #else
117   case RunAnalysis:            Action = "RunAnalysis"; break;
118 #endif
119   case RunPreprocessorOnly:    return new PreprocessOnlyAction();
120   }
121 
122 #if !defined(CLANG_ENABLE_ARCMT) || !defined(CLANG_ENABLE_STATIC_ANALYZER) \
123   || !defined(CLANG_ENABLE_REWRITER)
124   CI.getDiagnostics().Report(diag::err_fe_action_not_available) << Action;
125   return 0;
126 #else
127   llvm_unreachable("Invalid program action!");
128 #endif
129 }
130 
131 static FrontendAction *CreateFrontendAction(CompilerInstance &CI) {
132   // Create the underlying action.
133   FrontendAction *Act = CreateFrontendBaseAction(CI);
134   if (!Act)
135     return 0;
136 
137   const FrontendOptions &FEOpts = CI.getFrontendOpts();
138 
139 #ifdef CLANG_ENABLE_REWRITER
140   if (FEOpts.FixAndRecompile) {
141     Act = new FixItRecompile(Act);
142   }
143 #endif
144 
145 #ifdef CLANG_ENABLE_ARCMT
146   if (CI.getFrontendOpts().ProgramAction != frontend::MigrateSource) {
147     // Potentially wrap the base FE action in an ARC Migrate Tool action.
148     switch (FEOpts.ARCMTAction) {
149     case FrontendOptions::ARCMT_None:
150       break;
151     case FrontendOptions::ARCMT_Check:
152       Act = new arcmt::CheckAction(Act);
153       break;
154     case FrontendOptions::ARCMT_Modify:
155       Act = new arcmt::ModifyAction(Act);
156       break;
157     case FrontendOptions::ARCMT_Migrate:
158       Act = new arcmt::MigrateAction(Act,
159                                      FEOpts.MTMigrateDir,
160                                      FEOpts.ARCMTMigrateReportOut,
161                                      FEOpts.ARCMTMigrateEmitARCErrors);
162       break;
163     }
164 
165     if (FEOpts.ObjCMTAction != FrontendOptions::ObjCMT_None) {
166       Act = new arcmt::ObjCMigrateAction(Act, FEOpts.MTMigrateDir,
167                                          FEOpts.ObjCMTAction);
168     }
169   }
170 #endif
171 
172   // If there are any AST files to merge, create a frontend action
173   // adaptor to perform the merge.
174   if (!FEOpts.ASTMergeFiles.empty())
175     Act = new ASTMergeAction(Act, FEOpts.ASTMergeFiles);
176 
177   return Act;
178 }
179 
180 bool clang::ExecuteCompilerInvocation(CompilerInstance *Clang) {
181   // Honor -help.
182   if (Clang->getFrontendOpts().ShowHelp) {
183     OwningPtr<OptTable> Opts(driver::createDriverOptTable());
184     Opts->PrintHelp(llvm::outs(), "clang -cc1",
185                     "LLVM 'Clang' Compiler: http://clang.llvm.org",
186                     /*Include=*/ driver::options::CC1Option, /*Exclude=*/ 0);
187     return true;
188   }
189 
190   // Honor -version.
191   //
192   // FIXME: Use a better -version message?
193   if (Clang->getFrontendOpts().ShowVersion) {
194     llvm::cl::PrintVersionMessage();
195     return true;
196   }
197 
198   // Load any requested plugins.
199   for (unsigned i = 0,
200          e = Clang->getFrontendOpts().Plugins.size(); i != e; ++i) {
201     const std::string &Path = Clang->getFrontendOpts().Plugins[i];
202     std::string Error;
203     if (llvm::sys::DynamicLibrary::LoadLibraryPermanently(Path.c_str(), &Error))
204       Clang->getDiagnostics().Report(diag::err_fe_unable_to_load_plugin)
205         << Path << Error;
206   }
207 
208   // Honor -mllvm.
209   //
210   // FIXME: Remove this, one day.
211   // This should happen AFTER plugins have been loaded!
212   if (!Clang->getFrontendOpts().LLVMArgs.empty()) {
213     unsigned NumArgs = Clang->getFrontendOpts().LLVMArgs.size();
214     const char **Args = new const char*[NumArgs + 2];
215     Args[0] = "clang (LLVM option parsing)";
216     for (unsigned i = 0; i != NumArgs; ++i)
217       Args[i + 1] = Clang->getFrontendOpts().LLVMArgs[i].c_str();
218     Args[NumArgs + 1] = 0;
219     llvm::cl::ParseCommandLineOptions(NumArgs + 1, Args);
220   }
221 
222 #ifdef CLANG_ENABLE_STATIC_ANALYZER
223   // Honor -analyzer-checker-help.
224   // This should happen AFTER plugins have been loaded!
225   if (Clang->getAnalyzerOpts()->ShowCheckerHelp) {
226     ento::printCheckerHelp(llvm::outs(), Clang->getFrontendOpts().Plugins);
227     return true;
228   }
229 #endif
230 
231   // If there were errors in processing arguments, don't do anything else.
232   if (Clang->getDiagnostics().hasErrorOccurred())
233     return false;
234   // Create and execute the frontend action.
235   OwningPtr<FrontendAction> Act(CreateFrontendAction(*Clang));
236   if (!Act)
237     return false;
238   bool Success = Clang->ExecuteAction(*Act);
239   if (Clang->getFrontendOpts().DisableFree)
240     BuryPointer(Act.take());
241   return Success;
242 }
243