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