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