blob: 46cdeebfdbeb78f3bc581f58aa8a56b2c22735df [file] [log] [blame]
Daniel Dunbar02bd2d72009-11-14 10:42:46 +00001//===--- FrontendActions.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#include "clang/Frontend/FrontendActions.h"
11#include "clang/AST/ASTConsumer.h"
12#include "clang/Basic/FileManager.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000013#include "clang/Frontend/ASTConsumers.h"
14#include "clang/Frontend/ASTUnit.h"
15#include "clang/Frontend/CompilerInstance.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000016#include "clang/Frontend/FrontendDiagnostic.h"
17#include "clang/Frontend/Utils.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000018#include "clang/Lex/HeaderSearch.h"
19#include "clang/Lex/Pragma.h"
20#include "clang/Lex/Preprocessor.h"
21#include "clang/Parse/Parser.h"
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +000022#include "clang/Serialization/ASTReader.h"
Sebastian Redl1914c6f2010-08-18 23:56:37 +000023#include "clang/Serialization/ASTWriter.h"
Douglas Gregor524e33e2011-12-08 19:11:24 +000024#include "llvm/Support/FileSystem.h"
Douglas Gregoraf82e352010-07-20 20:18:03 +000025#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000026#include "llvm/Support/raw_ostream.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000027#include <memory>
Rafael Espindola8a8e5542014-06-12 17:19:42 +000028#include <system_error>
Douglas Gregor52da28b2011-09-23 23:43:36 +000029
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000030using namespace clang;
31
Daniel Dunbar88357802009-11-14 10:42:57 +000032//===----------------------------------------------------------------------===//
Daniel Dunbar1c201fb2010-03-19 19:44:04 +000033// Custom Actions
34//===----------------------------------------------------------------------===//
35
David Blaikie6beb6aa2014-08-10 19:56:51 +000036std::unique_ptr<ASTConsumer>
37InitOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
38 return llvm::make_unique<ASTConsumer>();
Daniel Dunbar1c201fb2010-03-19 19:44:04 +000039}
40
41void InitOnlyAction::ExecuteAction() {
42}
43
44//===----------------------------------------------------------------------===//
Daniel Dunbar88357802009-11-14 10:42:57 +000045// AST Consumer Actions
46//===----------------------------------------------------------------------===//
47
David Blaikie6beb6aa2014-08-10 19:56:51 +000048std::unique_ptr<ASTConsumer>
49ASTPrintAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000050 if (raw_ostream *OS = CI.createDefaultOutputFile(false, InFile))
Alexander Kornienko3db68ee2012-07-26 16:01:23 +000051 return CreateASTPrinter(OS, CI.getFrontendOpts().ASTDumpFilter);
Craig Topper49a27902014-05-22 04:46:25 +000052 return nullptr;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000053}
54
David Blaikie6beb6aa2014-08-10 19:56:51 +000055std::unique_ptr<ASTConsumer>
56ASTDumpAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Richard Smith6ea05822013-06-24 01:45:33 +000057 return CreateASTDumper(CI.getFrontendOpts().ASTDumpFilter,
Richard Smith35f986d2014-08-11 22:11:07 +000058 CI.getFrontendOpts().ASTDumpDecls,
Richard Smith6ea05822013-06-24 01:45:33 +000059 CI.getFrontendOpts().ASTDumpLookups);
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000060}
61
David Blaikie6beb6aa2014-08-10 19:56:51 +000062std::unique_ptr<ASTConsumer>
63ASTDeclListAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Alexander Kornienko4de03592012-07-31 09:37:40 +000064 return CreateASTDeclNodeLister();
65}
66
David Blaikie6beb6aa2014-08-10 19:56:51 +000067std::unique_ptr<ASTConsumer>
68ASTViewAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000069 return CreateASTViewer();
70}
71
David Blaikie6beb6aa2014-08-10 19:56:51 +000072std::unique_ptr<ASTConsumer>
73DeclContextPrintAction::CreateASTConsumer(CompilerInstance &CI,
74 StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000075 return CreateDeclContextPrinter();
76}
77
David Blaikie6beb6aa2014-08-10 19:56:51 +000078std::unique_ptr<ASTConsumer>
79GeneratePCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +000080 std::string Sysroot;
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +000081 std::string OutputFile;
Rafael Espindola47de1492015-04-10 12:54:53 +000082 raw_ostream *OS =
83 ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile);
84 if (!OS)
Craig Topper49a27902014-05-22 04:46:25 +000085 return nullptr;
Douglas Gregor48c8cd32010-08-03 08:14:03 +000086
Douglas Gregorc567ba22011-07-22 16:35:34 +000087 if (!CI.getFrontendOpts().RelocatablePCH)
88 Sysroot.clear();
Adrian Prantlcbc368c2015-02-25 02:44:04 +000089 return llvm::make_unique<PCHGenerator>(CI.getPreprocessor(), OutputFile,
90 nullptr, Sysroot, OS);
Douglas Gregor48c8cd32010-08-03 08:14:03 +000091}
92
Rafael Espindola47de1492015-04-10 12:54:53 +000093raw_ostream *GeneratePCHAction::ComputeASTConsumerArguments(
94 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
95 std::string &OutputFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +000096 Sysroot = CI.getHeaderSearchOpts().Sysroot;
97 if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
Sebastian Redlea68af42010-08-17 17:55:38 +000098 CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
Rafael Espindola47de1492015-04-10 12:54:53 +000099 return nullptr;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000100 }
101
Daniel Dunbara2867c72011-01-31 22:00:44 +0000102 // We use createOutputFile here because this is exposed via libclang, and we
103 // must disable the RemoveFileOnSignal behavior.
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000104 // We use a temporary to avoid race conditions.
Rafael Espindola47de1492015-04-10 12:54:53 +0000105 raw_ostream *OS =
106 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
107 /*RemoveFileOnSignal=*/false, InFile,
108 /*Extension=*/"", /*useTemporary=*/true);
Daniel Dunbar75546992009-12-03 09:13:30 +0000109 if (!OS)
Rafael Espindola47de1492015-04-10 12:54:53 +0000110 return nullptr;
Daniel Dunbar75546992009-12-03 09:13:30 +0000111
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +0000112 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindola47de1492015-04-10 12:54:53 +0000113 return OS;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000114}
115
David Blaikie6beb6aa2014-08-10 19:56:51 +0000116std::unique_ptr<ASTConsumer>
117GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
118 StringRef InFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000119 std::string Sysroot;
120 std::string OutputFile;
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000121 raw_ostream *OS =
122 ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile);
123 if (!OS)
Craig Topper49a27902014-05-22 04:46:25 +0000124 return nullptr;
125
Adrian Prantlcbc368c2015-02-25 02:44:04 +0000126 return llvm::make_unique<PCHGenerator>(CI.getPreprocessor(), OutputFile,
127 Module, Sysroot, OS);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000128}
129
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000130static SmallVectorImpl<char> &
131operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
132 Includes.append(RHS.begin(), RHS.end());
133 return Includes;
134}
135
Rafael Espindolac0809172014-06-12 14:02:15 +0000136static std::error_code addHeaderInclude(StringRef HeaderName,
137 SmallVectorImpl<char> &Includes,
138 const LangOptions &LangOpts,
139 bool IsExternC) {
Richard Smith9bca2982014-03-08 00:03:56 +0000140 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000141 Includes += "extern \"C\" {\n";
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000142 if (LangOpts.ObjC1)
143 Includes += "#import \"";
144 else
145 Includes += "#include \"";
Richard Smith3c1a41a2014-12-02 00:08:08 +0000146
147 Includes += HeaderName;
148
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000149 Includes += "\"\n";
Richard Smith9bca2982014-03-08 00:03:56 +0000150 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000151 Includes += "}\n";
Rafael Espindolac0809172014-06-12 14:02:15 +0000152 return std::error_code();
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000153}
154
Douglas Gregor4332b322011-11-16 17:04:00 +0000155/// \brief Collect the set of header includes needed to construct the given
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000156/// module and update the TopHeaders file set of the module.
Douglas Gregor4332b322011-11-16 17:04:00 +0000157///
158/// \param Module The module we're collecting includes from.
Douglas Gregore5626c42011-12-06 17:15:11 +0000159///
James Dennettc423c532012-06-15 21:48:19 +0000160/// \param Includes Will be augmented with the set of \#includes or \#imports
Douglas Gregore5626c42011-12-06 17:15:11 +0000161/// needed to load all of the named headers.
Rafael Espindolac0809172014-06-12 14:02:15 +0000162static std::error_code
Richard Smith723928c2014-03-11 02:02:47 +0000163collectModuleHeaderIncludes(const LangOptions &LangOpts, FileManager &FileMgr,
164 ModuleMap &ModMap, clang::Module *Module,
165 SmallVectorImpl<char> &Includes) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000166 // Don't collect any headers for unavailable modules.
167 if (!Module->isAvailable())
Rafael Espindolac0809172014-06-12 14:02:15 +0000168 return std::error_code();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000169
Douglas Gregore5626c42011-12-06 17:15:11 +0000170 // Add includes for each of these headers.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000171 for (Module::Header &H : Module->Headers[Module::HK_Normal]) {
172 Module->addTopHeader(H.Entry);
173 // Use the path as specified in the module map file. We'll look for this
174 // file relative to the module build directory (the directory containing
175 // the module map file) so this will find the same file that we found
176 // while parsing the module map.
177 if (std::error_code Err = addHeaderInclude(H.NameAsWritten, Includes,
178 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000179 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000180 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000181 // Note that Module->PrivateHeaders will not be a TopHeader.
Douglas Gregore5626c42011-12-06 17:15:11 +0000182
Richard Smith2b63d152015-05-16 02:28:53 +0000183 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader()) {
184 Module->addTopHeader(UmbrellaHeader.Entry);
Douglas Gregor3ec66632012-02-02 18:42:48 +0000185 if (Module->Parent) {
186 // Include the umbrella header for submodules.
Richard Smith2b63d152015-05-16 02:28:53 +0000187 if (std::error_code Err = addHeaderInclude(UmbrellaHeader.NameAsWritten,
188 Includes, LangOpts,
189 Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000190 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000191 }
Richard Smith2b63d152015-05-16 02:28:53 +0000192 } else if (Module::DirectoryName UmbrellaDir = Module->getUmbrellaDir()) {
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000193 // Add all of the headers we find in this subdirectory.
Rafael Espindolac0809172014-06-12 14:02:15 +0000194 std::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000195 SmallString<128> DirNative;
Richard Smith2b63d152015-05-16 02:28:53 +0000196 llvm::sys::path::native(UmbrellaDir.Entry->getName(), DirNative);
Yaron Keren92e1b622015-03-18 10:17:07 +0000197 for (llvm::sys::fs::recursive_directory_iterator Dir(DirNative, EC),
Douglas Gregorc1aaf8c2011-12-12 19:13:53 +0000198 DirEnd;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000199 Dir != DirEnd && !EC; Dir.increment(EC)) {
200 // Check whether this entry has an extension typically associated with
201 // headers.
202 if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(Dir->path()))
203 .Cases(".h", ".H", ".hh", ".hpp", true)
204 .Default(false))
205 continue;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000206
207 const FileEntry *Header = FileMgr.getFile(Dir->path());
208 // FIXME: This shouldn't happen unless there is a file system race. Is
209 // that worth diagnosing?
210 if (!Header)
211 continue;
212
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000213 // If this header is marked 'unavailable' in this module, don't include
214 // it.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000215 if (ModMap.isHeaderUnavailableInModule(Header, Module))
216 continue;
217
Richard Smith2b63d152015-05-16 02:28:53 +0000218 // Compute the relative path from the directory to this file.
219 SmallVector<StringRef, 16> Components;
220 auto PathIt = llvm::sys::path::rbegin(Dir->path());
221 for (int I = 0; I != Dir.level() + 1; ++I, ++PathIt)
222 Components.push_back(*PathIt);
223 SmallString<128> RelativeHeader(UmbrellaDir.NameAsWritten);
224 for (auto It = Components.rbegin(), End = Components.rend(); It != End;
225 ++It)
226 llvm::sys::path::append(RelativeHeader, *It);
227
Richard Smith723928c2014-03-11 02:02:47 +0000228 // Include this header as part of the umbrella directory.
Richard Smith3c1a41a2014-12-02 00:08:08 +0000229 Module->addTopHeader(Header);
Richard Smith2b63d152015-05-16 02:28:53 +0000230 if (std::error_code Err = addHeaderInclude(RelativeHeader, Includes,
231 LangOpts, Module->IsExternC))
Richard Smith723928c2014-03-11 02:02:47 +0000232 return Err;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000233 }
Richard Smith723928c2014-03-11 02:02:47 +0000234
235 if (EC)
236 return EC;
Douglas Gregor4332b322011-11-16 17:04:00 +0000237 }
Richard Smith3c1a41a2014-12-02 00:08:08 +0000238
Douglas Gregor4332b322011-11-16 17:04:00 +0000239 // Recurse into submodules.
Douglas Gregoreb90e832012-01-04 23:32:19 +0000240 for (clang::Module::submodule_iterator Sub = Module->submodule_begin(),
241 SubEnd = Module->submodule_end();
Douglas Gregore5626c42011-12-06 17:15:11 +0000242 Sub != SubEnd; ++Sub)
Rafael Espindolac0809172014-06-12 14:02:15 +0000243 if (std::error_code Err = collectModuleHeaderIncludes(
Richard Smith723928c2014-03-11 02:02:47 +0000244 LangOpts, FileMgr, ModMap, *Sub, Includes))
245 return Err;
246
Rafael Espindolac0809172014-06-12 14:02:15 +0000247 return std::error_code();
Douglas Gregor4332b322011-11-16 17:04:00 +0000248}
249
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000250bool GenerateModuleAction::BeginSourceFileAction(CompilerInstance &CI,
251 StringRef Filename) {
252 // Find the module map file.
253 const FileEntry *ModuleMap = CI.getFileManager().getFile(Filename);
254 if (!ModuleMap) {
255 CI.getDiagnostics().Report(diag::err_module_map_not_found)
256 << Filename;
257 return false;
258 }
259
260 // Parse the module map file.
261 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Douglas Gregor963c5532013-06-21 16:28:10 +0000262 if (HS.loadModuleMapFile(ModuleMap, IsSystem))
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000263 return false;
264
265 if (CI.getLangOpts().CurrentModule.empty()) {
266 CI.getDiagnostics().Report(diag::err_missing_module_name);
267
268 // FIXME: Eventually, we could consider asking whether there was just
269 // a single module described in the module map, and use that as a
270 // default. Then it would be fairly trivial to just "compile" a module
271 // map with a single module (the common case).
272 return false;
273 }
Richard Smith7bea1d42014-03-05 20:55:36 +0000274
275 // If we're being run from the command-line, the module build stack will not
276 // have been filled in yet, so complete it now in order to allow us to detect
277 // module cycles.
278 SourceManager &SourceMgr = CI.getSourceManager();
279 if (SourceMgr.getModuleBuildStack().empty())
280 SourceMgr.pushModuleBuildStack(CI.getLangOpts().CurrentModule,
281 FullSourceLoc(SourceLocation(), SourceMgr));
282
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000283 // Dig out the module definition.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000284 Module = HS.lookupModule(CI.getLangOpts().CurrentModule,
285 /*AllowSearch=*/false);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000286 if (!Module) {
287 CI.getDiagnostics().Report(diag::err_missing_module)
288 << CI.getLangOpts().CurrentModule << Filename;
289
290 return false;
291 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000292
293 // Check whether we can build this module at all.
Richard Smitha3feee22013-10-28 22:18:19 +0000294 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +0000295 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000296 if (!Module->isAvailable(CI.getLangOpts(), CI.getTarget(), Requirement,
297 MissingHeader)) {
298 if (MissingHeader.FileNameLoc.isValid()) {
Ben Langmuirec8c9752014-04-18 22:07:31 +0000299 CI.getDiagnostics().Report(MissingHeader.FileNameLoc,
300 diag::err_module_header_missing)
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000301 << MissingHeader.IsUmbrella << MissingHeader.FileName;
302 } else {
303 CI.getDiagnostics().Report(diag::err_module_unavailable)
304 << Module->getFullModuleName()
305 << Requirement.second << Requirement.first;
306 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000307
308 return false;
309 }
310
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000311 if (ModuleMapForUniquing && ModuleMapForUniquing != ModuleMap) {
312 Module->IsInferred = true;
313 HS.getModuleMap().setInferredModuleAllowedBy(Module, ModuleMapForUniquing);
314 } else {
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000315 ModuleMapForUniquing = ModuleMap;
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000316 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000317
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000318 FileManager &FileMgr = CI.getFileManager();
319
Douglas Gregor4332b322011-11-16 17:04:00 +0000320 // Collect the set of #includes we need to build the module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000321 SmallString<256> HeaderContents;
Rafael Espindola8e650d72014-06-12 20:37:59 +0000322 std::error_code Err = std::error_code();
Richard Smith2b63d152015-05-16 02:28:53 +0000323 if (Module::Header UmbrellaHeader = Module->getUmbrellaHeader())
324 Err = addHeaderInclude(UmbrellaHeader.NameAsWritten, HeaderContents,
325 CI.getLangOpts(), Module->IsExternC);
Richard Smith723928c2014-03-11 02:02:47 +0000326 if (!Err)
327 Err = collectModuleHeaderIncludes(
328 CI.getLangOpts(), FileMgr,
329 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), Module,
330 HeaderContents);
331
332 if (Err) {
333 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
334 << Module->getFullModuleName() << Err.message();
335 return false;
336 }
Douglas Gregor4332b322011-11-16 17:04:00 +0000337
Richard Smith3c1a41a2014-12-02 00:08:08 +0000338 // Inform the preprocessor that includes from within the input buffer should
339 // be resolved relative to the build directory of the module map file.
340 CI.getPreprocessor().setMainFileDir(Module->Directory);
341
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000342 std::unique_ptr<llvm::MemoryBuffer> InputBuffer =
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000343 llvm::MemoryBuffer::getMemBufferCopy(HeaderContents,
344 Module::getModuleInputBufferName());
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000345 // Ownership of InputBuffer will be transferred to the SourceManager.
Rafael Espindolad87f8d72014-08-27 20:03:29 +0000346 setCurrentInput(FrontendInputFile(InputBuffer.release(), getCurrentFileKind(),
Douglas Gregora686e1b2012-01-27 19:52:33 +0000347 Module->IsSystem));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000348 return true;
349}
350
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000351raw_ostream *GenerateModuleAction::ComputeASTConsumerArguments(
352 CompilerInstance &CI, StringRef InFile, std::string &Sysroot,
353 std::string &OutputFile) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000354 // If no output file was provided, figure out where this module would go
355 // in the module cache.
356 if (CI.getFrontendOpts().OutputFile.empty()) {
357 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000358 CI.getFrontendOpts().OutputFile =
359 HS.getModuleFileName(CI.getLangOpts().CurrentModule,
Ben Langmuird89dc562015-02-19 20:23:22 +0000360 ModuleMapForUniquing->getName());
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000361 }
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000362
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000363 // We use createOutputFile here because this is exposed via libclang, and we
364 // must disable the RemoveFileOnSignal behavior.
365 // We use a temporary to avoid race conditions.
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000366 raw_ostream *OS =
367 CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
368 /*RemoveFileOnSignal=*/false, InFile,
369 /*Extension=*/"", /*useTemporary=*/true,
370 /*CreateMissingDirectories=*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000371 if (!OS)
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000372 return nullptr;
373
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000374 OutputFile = CI.getFrontendOpts().OutputFile;
Rafael Espindolabfd25d42015-04-10 13:14:31 +0000375 return OS;
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000376}
377
David Blaikie6beb6aa2014-08-10 19:56:51 +0000378std::unique_ptr<ASTConsumer>
379SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
380 return llvm::make_unique<ASTConsumer>();
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000381}
382
David Blaikie6beb6aa2014-08-10 19:56:51 +0000383std::unique_ptr<ASTConsumer>
384DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
385 StringRef InFile) {
386 return llvm::make_unique<ASTConsumer>();
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000387}
388
David Blaikie6beb6aa2014-08-10 19:56:51 +0000389std::unique_ptr<ASTConsumer>
390VerifyPCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
391 return llvm::make_unique<ASTConsumer>();
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000392}
393
394void VerifyPCHAction::ExecuteAction() {
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000395 CompilerInstance &CI = getCompilerInstance();
396 bool Preamble = CI.getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
397 const std::string &Sysroot = CI.getHeaderSearchOpts().Sysroot;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000398 std::unique_ptr<ASTReader> Reader(
399 new ASTReader(CI.getPreprocessor(), CI.getASTContext(),
400 Sysroot.empty() ? "" : Sysroot.c_str(),
401 /*DisableValidation*/ false,
402 /*AllowPCHWithCompilerErrors*/ false,
403 /*AllowConfigurationMismatch*/ true,
404 /*ValidateSystemInputs*/ true));
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000405
406 Reader->ReadAST(getCurrentFile(),
407 Preamble ? serialization::MK_Preamble
408 : serialization::MK_PCH,
409 SourceLocation(),
410 ASTReader::ARR_ConfigurationMismatch);
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000411}
412
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000413namespace {
414 /// \brief AST reader listener that dumps module information for a module
415 /// file.
416 class DumpModuleInfoListener : public ASTReaderListener {
417 llvm::raw_ostream &Out;
418
419 public:
420 DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
421
422#define DUMP_BOOLEAN(Value, Text) \
423 Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
424
Craig Topperafa7cb32014-03-13 06:07:04 +0000425 bool ReadFullVersionInformation(StringRef FullVersion) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000426 Out.indent(2)
427 << "Generated by "
428 << (FullVersion == getClangFullRepositoryVersion()? "this"
429 : "a different")
430 << " Clang: " << FullVersion << "\n";
431 return ASTReaderListener::ReadFullVersionInformation(FullVersion);
432 }
433
Ben Langmuir4f5212a2014-04-14 22:12:44 +0000434 void ReadModuleName(StringRef ModuleName) override {
435 Out.indent(2) << "Module name: " << ModuleName << "\n";
436 }
437 void ReadModuleMapFile(StringRef ModuleMapPath) override {
438 Out.indent(2) << "Module map file: " << ModuleMapPath << "\n";
439 }
440
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000441 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
442 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000443 Out.indent(2) << "Language options:\n";
444#define LANGOPT(Name, Bits, Default, Description) \
445 DUMP_BOOLEAN(LangOpts.Name, Description);
446#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
447 Out.indent(4) << Description << ": " \
448 << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
449#define VALUE_LANGOPT(Name, Bits, Default, Description) \
450 Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
451#define BENIGN_LANGOPT(Name, Bits, Default, Description)
452#define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
453#include "clang/Basic/LangOptions.def"
454 return false;
455 }
456
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000457 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
458 bool AllowCompatibleDifferences) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000459 Out.indent(2) << "Target options:\n";
460 Out.indent(4) << " Triple: " << TargetOpts.Triple << "\n";
461 Out.indent(4) << " CPU: " << TargetOpts.CPU << "\n";
462 Out.indent(4) << " ABI: " << TargetOpts.ABI << "\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000463
464 if (!TargetOpts.FeaturesAsWritten.empty()) {
465 Out.indent(4) << "Target features:\n";
466 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
467 I != N; ++I) {
468 Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
469 }
470 }
471
472 return false;
473 }
474
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000475 bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
476 bool Complain) override {
Ben Langmuirb92de022014-04-29 16:25:26 +0000477 Out.indent(2) << "Diagnostic options:\n";
478#define DIAGOPT(Name, Bits, Default) DUMP_BOOLEAN(DiagOpts->Name, #Name);
479#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
480 Out.indent(4) << #Name << ": " << DiagOpts->get##Name() << "\n";
481#define VALUE_DIAGOPT(Name, Bits, Default) \
482 Out.indent(4) << #Name << ": " << DiagOpts->Name << "\n";
483#include "clang/Basic/DiagnosticOptions.def"
484
Richard Smith3be1cb22014-08-07 00:24:21 +0000485 Out.indent(4) << "Diagnostic flags:\n";
486 for (const std::string &Warning : DiagOpts->Warnings)
Ben Langmuirb92de022014-04-29 16:25:26 +0000487 Out.indent(6) << "-W" << Warning << "\n";
Richard Smith3be1cb22014-08-07 00:24:21 +0000488 for (const std::string &Remark : DiagOpts->Remarks)
489 Out.indent(6) << "-R" << Remark << "\n";
Ben Langmuirb92de022014-04-29 16:25:26 +0000490
491 return false;
492 }
493
Craig Topperafa7cb32014-03-13 06:07:04 +0000494 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000495 StringRef SpecificModuleCachePath,
Craig Topperafa7cb32014-03-13 06:07:04 +0000496 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000497 Out.indent(2) << "Header search options:\n";
498 Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000499 Out.indent(4) << "Module Cache: '" << SpecificModuleCachePath << "'\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000500 DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
501 "Use builtin include directories [-nobuiltininc]");
502 DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
503 "Use standard system include directories [-nostdinc]");
504 DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
505 "Use standard C++ include directories [-nostdinc++]");
506 DUMP_BOOLEAN(HSOpts.UseLibcxx,
507 "Use libc++ (rather than libstdc++) [-stdlib=]");
508 return false;
509 }
510
Craig Topperafa7cb32014-03-13 06:07:04 +0000511 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
512 bool Complain,
513 std::string &SuggestedPredefines) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000514 Out.indent(2) << "Preprocessor options:\n";
515 DUMP_BOOLEAN(PPOpts.UsePredefines,
516 "Uses compiler/target-specific predefines [-undef]");
517 DUMP_BOOLEAN(PPOpts.DetailedRecord,
518 "Uses detailed preprocessing record (for indexing)");
519
520 if (!PPOpts.Macros.empty()) {
521 Out.indent(4) << "Predefined macros:\n";
522 }
523
524 for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
525 I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
526 I != IEnd; ++I) {
527 Out.indent(6);
528 if (I->second)
529 Out << "-U";
530 else
531 Out << "-D";
532 Out << I->first << "\n";
533 }
534 return false;
535 }
536#undef DUMP_BOOLEAN
537 };
538}
539
540void DumpModuleInfoAction::ExecuteAction() {
541 // Set up the output file.
Ahmed Charlesb8984322014-03-07 20:03:18 +0000542 std::unique_ptr<llvm::raw_fd_ostream> OutFile;
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000543 StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
544 if (!OutputFileName.empty() && OutputFileName != "-") {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000545 std::error_code EC;
546 OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str(), EC,
547 llvm::sys::fs::F_Text));
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000548 }
549 llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
550
551 Out << "Information for module file '" << getCurrentFile() << "':\n";
552 DumpModuleInfoListener Listener(Out);
553 ASTReader::readASTFileControlBlock(getCurrentFile(),
554 getCompilerInstance().getFileManager(),
555 Listener);
556}
557
Daniel Dunbar88357802009-11-14 10:42:57 +0000558//===----------------------------------------------------------------------===//
559// Preprocessor Actions
560//===----------------------------------------------------------------------===//
561
562void DumpRawTokensAction::ExecuteAction() {
563 Preprocessor &PP = getCompilerInstance().getPreprocessor();
564 SourceManager &SM = PP.getSourceManager();
565
566 // Start lexing the specified input file.
Chris Lattner710bb872009-11-30 04:18:44 +0000567 const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
David Blaikiebbafb8a2012-03-11 07:00:24 +0000568 Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
Daniel Dunbar88357802009-11-14 10:42:57 +0000569 RawLex.SetKeepWhitespaceMode(true);
570
571 Token RawTok;
572 RawLex.LexFromRawLexer(RawTok);
573 while (RawTok.isNot(tok::eof)) {
574 PP.DumpToken(RawTok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000575 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000576 RawLex.LexFromRawLexer(RawTok);
577 }
578}
579
580void DumpTokensAction::ExecuteAction() {
581 Preprocessor &PP = getCompilerInstance().getPreprocessor();
582 // Start preprocessing the specified input file.
583 Token Tok;
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000584 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000585 do {
586 PP.Lex(Tok);
587 PP.DumpToken(Tok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000588 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000589 } while (Tok.isNot(tok::eof));
590}
591
592void GeneratePTHAction::ExecuteAction() {
593 CompilerInstance &CI = getCompilerInstance();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000594 raw_pwrite_stream *OS = CI.createDefaultOutputFile(true, getCurrentFile());
NAKAMURA Takumi5594d792015-04-13 08:43:40 +0000595 if (!OS)
596 return;
Daniel Dunbar75546992009-12-03 09:13:30 +0000597
Daniel Dunbar88357802009-11-14 10:42:57 +0000598 CacheTokens(CI.getPreprocessor(), OS);
599}
600
Daniel Dunbar88357802009-11-14 10:42:57 +0000601void PreprocessOnlyAction::ExecuteAction() {
602 Preprocessor &PP = getCompilerInstance().getPreprocessor();
603
Daniel Dunbard839e772010-06-11 20:10:12 +0000604 // Ignore unknown pragmas.
Lubos Lunak576a0412014-05-01 12:54:03 +0000605 PP.IgnorePragmas();
Daniel Dunbard839e772010-06-11 20:10:12 +0000606
Daniel Dunbar88357802009-11-14 10:42:57 +0000607 Token Tok;
608 // Start parsing the specified input file.
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000609 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000610 do {
611 PP.Lex(Tok);
612 } while (Tok.isNot(tok::eof));
613}
614
Daniel Dunbar88357802009-11-14 10:42:57 +0000615void PrintPreprocessedAction::ExecuteAction() {
616 CompilerInstance &CI = getCompilerInstance();
Douglas Gregor52da28b2011-09-23 23:43:36 +0000617 // Output file may need to be set to 'Binary', to avoid converting Unix style
Steve Naroff3d38a682010-01-05 17:33:23 +0000618 // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
Douglas Gregor52da28b2011-09-23 23:43:36 +0000619 //
620 // Look to see what type of line endings the file uses. If there's a
621 // CRLF, then we won't open the file up in binary mode. If there is
622 // just an LF or CR, then we will open the file up in binary mode.
623 // In this fashion, the output format should match the input format, unless
624 // the input format has inconsistent line endings.
625 //
626 // This should be a relatively fast operation since most files won't have
627 // all of their source code on a single line. However, that is still a
628 // concern, so if we scan for too long, we'll just assume the file should
629 // be opened in binary mode.
630 bool BinaryMode = true;
631 bool InvalidFile = false;
632 const SourceManager& SM = CI.getSourceManager();
633 const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
634 &InvalidFile);
635 if (!InvalidFile) {
636 const char *cur = Buffer->getBufferStart();
637 const char *end = Buffer->getBufferEnd();
638 const char *next = (cur != end) ? cur + 1 : end;
639
640 // Limit ourselves to only scanning 256 characters into the source
641 // file. This is mostly a sanity check in case the file has no
642 // newlines whatsoever.
643 if (end - cur > 256) end = cur + 256;
644
645 while (next < end) {
646 if (*cur == 0x0D) { // CR
647 if (*next == 0x0A) // CRLF
648 BinaryMode = false;
649
650 break;
651 } else if (*cur == 0x0A) // LF
652 break;
653
654 ++cur, ++next;
655 }
656 }
657
658 raw_ostream *OS = CI.createDefaultOutputFile(BinaryMode, getCurrentFile());
Daniel Dunbar75546992009-12-03 09:13:30 +0000659 if (!OS) return;
660
Daniel Dunbar88357802009-11-14 10:42:57 +0000661 DoPrintPreprocessedInput(CI.getPreprocessor(), OS,
662 CI.getPreprocessorOutputOpts());
663}
Douglas Gregoraf82e352010-07-20 20:18:03 +0000664
665void PrintPreambleAction::ExecuteAction() {
666 switch (getCurrentFileKind()) {
667 case IK_C:
668 case IK_CXX:
669 case IK_ObjC:
670 case IK_ObjCXX:
671 case IK_OpenCL:
Peter Collingbourne62089b82010-12-01 03:15:20 +0000672 case IK_CUDA:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000673 break;
674
675 case IK_None:
676 case IK_Asm:
677 case IK_PreprocessedC:
Artem Belevich83a6dcc2015-03-19 17:32:06 +0000678 case IK_PreprocessedCuda:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000679 case IK_PreprocessedCXX:
680 case IK_PreprocessedObjC:
681 case IK_PreprocessedObjCXX:
682 case IK_AST:
683 case IK_LLVM_IR:
684 // We can't do anything with these.
685 return;
686 }
Rafael Espindola6406f7b2014-08-26 19:54:40 +0000687
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000688 CompilerInstance &CI = getCompilerInstance();
Benjamin Kramera8857962014-10-26 22:44:13 +0000689 auto Buffer = CI.getFileManager().getBufferForFile(getCurrentFile());
690 if (Buffer) {
Rafael Espindolacd0b3802014-08-12 15:46:24 +0000691 unsigned Preamble =
Benjamin Kramera8857962014-10-26 22:44:13 +0000692 Lexer::ComputePreamble((*Buffer)->getBuffer(), CI.getLangOpts()).first;
693 llvm::outs().write((*Buffer)->getBufferStart(), Preamble);
Douglas Gregoraf82e352010-07-20 20:18:03 +0000694 }
695}