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