blob: bbd2dff46c06c600c2c09eb1d21bd2380f63e8e7 [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"
Douglas Gregor52da28b2011-09-23 23:43:36 +000027#include "llvm/Support/system_error.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000028#include <memory>
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
36ASTConsumer *InitOnlyAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000037 StringRef InFile) {
Daniel Dunbar1c201fb2010-03-19 19:44:04 +000038 return new ASTConsumer();
39}
40
41void InitOnlyAction::ExecuteAction() {
42}
43
44//===----------------------------------------------------------------------===//
Daniel Dunbar88357802009-11-14 10:42:57 +000045// AST Consumer Actions
46//===----------------------------------------------------------------------===//
47
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000048ASTConsumer *ASTPrintAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000049 StringRef InFile) {
50 if (raw_ostream *OS = CI.createDefaultOutputFile(false, InFile))
Alexander Kornienko3db68ee2012-07-26 16:01:23 +000051 return CreateASTPrinter(OS, CI.getFrontendOpts().ASTDumpFilter);
Daniel Dunbar75546992009-12-03 09:13:30 +000052 return 0;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000053}
54
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000055ASTConsumer *ASTDumpAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000056 StringRef InFile) {
Richard Smith6ea05822013-06-24 01:45:33 +000057 return CreateASTDumper(CI.getFrontendOpts().ASTDumpFilter,
58 CI.getFrontendOpts().ASTDumpLookups);
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000059}
60
Alexander Kornienko4de03592012-07-31 09:37:40 +000061ASTConsumer *ASTDeclListAction::CreateASTConsumer(CompilerInstance &CI,
62 StringRef InFile) {
63 return CreateASTDeclNodeLister();
64}
65
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000066ASTConsumer *ASTViewAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000067 StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000068 return CreateASTViewer();
69}
70
71ASTConsumer *DeclContextPrintAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000072 StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000073 return CreateDeclContextPrinter();
74}
75
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000076ASTConsumer *GeneratePCHAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000077 StringRef InFile) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +000078 std::string Sysroot;
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +000079 std::string OutputFile;
Chris Lattner0e62c1c2011-07-23 10:55:15 +000080 raw_ostream *OS = 0;
Douglas Gregor36db4f92011-08-25 22:35:51 +000081 if (ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile, OS))
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000082 return 0;
Douglas Gregor48c8cd32010-08-03 08:14:03 +000083
Douglas Gregorc567ba22011-07-22 16:35:34 +000084 if (!CI.getFrontendOpts().RelocatablePCH)
85 Sysroot.clear();
Douglas Gregorf7a700fd2011-11-30 04:39:39 +000086 return new PCHGenerator(CI.getPreprocessor(), OutputFile, 0, Sysroot, OS);
Douglas Gregor48c8cd32010-08-03 08:14:03 +000087}
88
89bool GeneratePCHAction::ComputeASTConsumerArguments(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000090 StringRef InFile,
Douglas Gregor48c8cd32010-08-03 08:14:03 +000091 std::string &Sysroot,
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +000092 std::string &OutputFile,
Douglas Gregor36db4f92011-08-25 22:35:51 +000093 raw_ostream *&OS) {
Douglas Gregor48c8cd32010-08-03 08:14:03 +000094 Sysroot = CI.getHeaderSearchOpts().Sysroot;
95 if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
Sebastian Redlea68af42010-08-17 17:55:38 +000096 CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
Douglas Gregor48c8cd32010-08-03 08:14:03 +000097 return true;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +000098 }
99
Daniel Dunbara2867c72011-01-31 22:00:44 +0000100 // We use createOutputFile here because this is exposed via libclang, and we
101 // must disable the RemoveFileOnSignal behavior.
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000102 // We use a temporary to avoid race conditions.
Daniel Dunbara2867c72011-01-31 22:00:44 +0000103 OS = CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000104 /*RemoveFileOnSignal=*/false, InFile,
105 /*Extension=*/"", /*useTemporary=*/true);
Daniel Dunbar75546992009-12-03 09:13:30 +0000106 if (!OS)
Douglas Gregor48c8cd32010-08-03 08:14:03 +0000107 return true;
Daniel Dunbar75546992009-12-03 09:13:30 +0000108
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +0000109 OutputFile = CI.getFrontendOpts().OutputFile;
Douglas Gregor48c8cd32010-08-03 08:14:03 +0000110 return false;
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000111}
112
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000113ASTConsumer *GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
114 StringRef InFile) {
115 std::string Sysroot;
116 std::string OutputFile;
117 raw_ostream *OS = 0;
118 if (ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile, OS))
119 return 0;
120
Douglas Gregorf7a700fd2011-11-30 04:39:39 +0000121 return new PCHGenerator(CI.getPreprocessor(), OutputFile, Module,
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000122 Sysroot, OS);
123}
124
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000125static SmallVectorImpl<char> &
126operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
127 Includes.append(RHS.begin(), RHS.end());
128 return Includes;
129}
130
Richard Smith723928c2014-03-11 02:02:47 +0000131static llvm::error_code addHeaderInclude(StringRef HeaderName,
132 SmallVectorImpl<char> &Includes,
133 const LangOptions &LangOpts,
134 bool IsExternC) {
Richard Smith9bca2982014-03-08 00:03:56 +0000135 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000136 Includes += "extern \"C\" {\n";
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000137 if (LangOpts.ObjC1)
138 Includes += "#import \"";
139 else
140 Includes += "#include \"";
Richard Smith723928c2014-03-11 02:02:47 +0000141 // Use an absolute path for the include; there's no reason to think that
142 // a relative path will work (. might not be on our include path) or that
143 // it will find the same file.
144 if (llvm::sys::path::is_absolute(HeaderName)) {
145 Includes += HeaderName;
146 } else {
147 SmallString<256> Header = HeaderName;
148 if (llvm::error_code Err = llvm::sys::fs::make_absolute(Header))
149 return Err;
150 Includes += Header;
151 }
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000152 Includes += "\"\n";
Richard Smith9bca2982014-03-08 00:03:56 +0000153 if (IsExternC && LangOpts.CPlusPlus)
Richard Smith77944862014-03-02 05:58:18 +0000154 Includes += "}\n";
Richard Smith723928c2014-03-11 02:02:47 +0000155 return llvm::error_code::success();
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000156}
157
Richard Smith723928c2014-03-11 02:02:47 +0000158static llvm::error_code addHeaderInclude(const FileEntry *Header,
159 SmallVectorImpl<char> &Includes,
160 const LangOptions &LangOpts,
161 bool IsExternC) {
162 return addHeaderInclude(Header->getName(), Includes, LangOpts, IsExternC);
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000163}
164
Douglas Gregor4332b322011-11-16 17:04:00 +0000165/// \brief Collect the set of header includes needed to construct the given
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000166/// module and update the TopHeaders file set of the module.
Douglas Gregor4332b322011-11-16 17:04:00 +0000167///
168/// \param Module The module we're collecting includes from.
Douglas Gregore5626c42011-12-06 17:15:11 +0000169///
James Dennettc423c532012-06-15 21:48:19 +0000170/// \param Includes Will be augmented with the set of \#includes or \#imports
Douglas Gregore5626c42011-12-06 17:15:11 +0000171/// needed to load all of the named headers.
Richard Smith723928c2014-03-11 02:02:47 +0000172static llvm::error_code
173collectModuleHeaderIncludes(const LangOptions &LangOpts, FileManager &FileMgr,
174 ModuleMap &ModMap, clang::Module *Module,
175 SmallVectorImpl<char> &Includes) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000176 // Don't collect any headers for unavailable modules.
177 if (!Module->isAvailable())
Richard Smith723928c2014-03-11 02:02:47 +0000178 return llvm::error_code::success();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000179
Douglas Gregore5626c42011-12-06 17:15:11 +0000180 // Add includes for each of these headers.
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000181 for (unsigned I = 0, N = Module->NormalHeaders.size(); I != N; ++I) {
182 const FileEntry *Header = Module->NormalHeaders[I];
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +0000183 Module->addTopHeader(Header);
Richard Smith723928c2014-03-11 02:02:47 +0000184 if (llvm::error_code Err =
185 addHeaderInclude(Header, Includes, LangOpts, Module->IsExternC))
186 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000187 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000188 // Note that Module->PrivateHeaders will not be a TopHeader.
Douglas Gregore5626c42011-12-06 17:15:11 +0000189
Douglas Gregor73141fa2011-12-08 17:39:04 +0000190 if (const FileEntry *UmbrellaHeader = Module->getUmbrellaHeader()) {
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +0000191 Module->addTopHeader(UmbrellaHeader);
Douglas Gregor3ec66632012-02-02 18:42:48 +0000192 if (Module->Parent) {
193 // Include the umbrella header for submodules.
Richard Smith723928c2014-03-11 02:02:47 +0000194 if (llvm::error_code Err = addHeaderInclude(UmbrellaHeader, Includes,
195 LangOpts, Module->IsExternC))
196 return Err;
Douglas Gregor3ec66632012-02-02 18:42:48 +0000197 }
Douglas Gregor524e33e2011-12-08 19:11:24 +0000198 } else if (const DirectoryEntry *UmbrellaDir = Module->getUmbrellaDir()) {
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000199 // Add all of the headers we find in this subdirectory.
Douglas Gregor524e33e2011-12-08 19:11:24 +0000200 llvm::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000201 SmallString<128> DirNative;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000202 llvm::sys::path::native(UmbrellaDir->getName(), DirNative);
Douglas Gregorc1aaf8c2011-12-12 19:13:53 +0000203 for (llvm::sys::fs::recursive_directory_iterator Dir(DirNative.str(), EC),
204 DirEnd;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000205 Dir != DirEnd && !EC; Dir.increment(EC)) {
206 // Check whether this entry has an extension typically associated with
207 // headers.
208 if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(Dir->path()))
209 .Cases(".h", ".H", ".hh", ".hpp", true)
210 .Default(false))
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.
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000215 if (const FileEntry *Header = FileMgr.getFile(Dir->path())) {
Richard Smith50996ce2014-04-08 13:13:04 +0000216 if (ModMap.isHeaderUnavailableInModule(Header, Module))
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000217 continue;
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +0000218 Module->addTopHeader(Header);
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +0000219 }
Douglas Gregord2a8fe12012-01-05 00:04:05 +0000220
Richard Smith723928c2014-03-11 02:02:47 +0000221 // Include this header as part of the umbrella directory.
222 if (llvm::error_code Err = addHeaderInclude(Dir->path(), Includes,
223 LangOpts, Module->IsExternC))
224 return Err;
Douglas Gregor524e33e2011-12-08 19:11:24 +0000225 }
Richard Smith723928c2014-03-11 02:02:47 +0000226
227 if (EC)
228 return EC;
Douglas Gregor4332b322011-11-16 17:04:00 +0000229 }
230
231 // Recurse into submodules.
Douglas Gregoreb90e832012-01-04 23:32:19 +0000232 for (clang::Module::submodule_iterator Sub = Module->submodule_begin(),
233 SubEnd = Module->submodule_end();
Douglas Gregore5626c42011-12-06 17:15:11 +0000234 Sub != SubEnd; ++Sub)
Richard Smith723928c2014-03-11 02:02:47 +0000235 if (llvm::error_code Err = collectModuleHeaderIncludes(
236 LangOpts, FileMgr, ModMap, *Sub, Includes))
237 return Err;
238
239 return llvm::error_code::success();
Douglas Gregor4332b322011-11-16 17:04:00 +0000240}
241
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000242bool GenerateModuleAction::BeginSourceFileAction(CompilerInstance &CI,
243 StringRef Filename) {
244 // Find the module map file.
245 const FileEntry *ModuleMap = CI.getFileManager().getFile(Filename);
246 if (!ModuleMap) {
247 CI.getDiagnostics().Report(diag::err_module_map_not_found)
248 << Filename;
249 return false;
250 }
251
252 // Parse the module map file.
253 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Douglas Gregor963c5532013-06-21 16:28:10 +0000254 if (HS.loadModuleMapFile(ModuleMap, IsSystem))
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000255 return false;
256
257 if (CI.getLangOpts().CurrentModule.empty()) {
258 CI.getDiagnostics().Report(diag::err_missing_module_name);
259
260 // FIXME: Eventually, we could consider asking whether there was just
261 // a single module described in the module map, and use that as a
262 // default. Then it would be fairly trivial to just "compile" a module
263 // map with a single module (the common case).
264 return false;
265 }
Richard Smith7bea1d42014-03-05 20:55:36 +0000266
267 // If we're being run from the command-line, the module build stack will not
268 // have been filled in yet, so complete it now in order to allow us to detect
269 // module cycles.
270 SourceManager &SourceMgr = CI.getSourceManager();
271 if (SourceMgr.getModuleBuildStack().empty())
272 SourceMgr.pushModuleBuildStack(CI.getLangOpts().CurrentModule,
273 FullSourceLoc(SourceLocation(), SourceMgr));
274
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000275 // Dig out the module definition.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000276 Module = HS.lookupModule(CI.getLangOpts().CurrentModule,
277 /*AllowSearch=*/false);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000278 if (!Module) {
279 CI.getDiagnostics().Report(diag::err_missing_module)
280 << CI.getLangOpts().CurrentModule << Filename;
281
282 return false;
283 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000284
285 // Check whether we can build this module at all.
Richard Smitha3feee22013-10-28 22:18:19 +0000286 clang::Module::Requirement Requirement;
Daniel Jasper0761a8a2013-12-17 10:31:37 +0000287 clang::Module::HeaderDirective MissingHeader;
288 if (!Module->isAvailable(CI.getLangOpts(), CI.getTarget(), Requirement,
289 MissingHeader)) {
290 if (MissingHeader.FileNameLoc.isValid()) {
291 CI.getDiagnostics().Report(diag::err_module_header_missing)
292 << MissingHeader.IsUmbrella << MissingHeader.FileName;
293 } else {
294 CI.getDiagnostics().Report(diag::err_module_unavailable)
295 << Module->getFullModuleName()
296 << Requirement.second << Requirement.first;
297 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000298
299 return false;
300 }
301
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000302 if (!ModuleMapForUniquing)
303 ModuleMapForUniquing = ModuleMap;
304 Module->ModuleMap = ModuleMapForUniquing;
305 assert(Module->ModuleMap && "missing module map file");
306
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000307 FileManager &FileMgr = CI.getFileManager();
308
Douglas Gregor4332b322011-11-16 17:04:00 +0000309 // Collect the set of #includes we need to build the module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000310 SmallString<256> HeaderContents;
Richard Smith723928c2014-03-11 02:02:47 +0000311 llvm::error_code Err = llvm::error_code::success();
Argyrios Kyrtzidis130190f2012-10-10 02:12:39 +0000312 if (const FileEntry *UmbrellaHeader = Module->getUmbrellaHeader())
Richard Smith723928c2014-03-11 02:02:47 +0000313 Err = addHeaderInclude(UmbrellaHeader, HeaderContents, CI.getLangOpts(),
314 Module->IsExternC);
315 if (!Err)
316 Err = collectModuleHeaderIncludes(
317 CI.getLangOpts(), FileMgr,
318 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), Module,
319 HeaderContents);
320
321 if (Err) {
322 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
323 << Module->getFullModuleName() << Err.message();
324 return false;
325 }
Douglas Gregor4332b322011-11-16 17:04:00 +0000326
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000327 llvm::MemoryBuffer *InputBuffer =
328 llvm::MemoryBuffer::getMemBufferCopy(HeaderContents,
329 Module::getModuleInputBufferName());
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000330 // Ownership of InputBuffer will be transferred to the SourceManager.
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000331 setCurrentInput(FrontendInputFile(InputBuffer, getCurrentFileKind(),
Douglas Gregora686e1b2012-01-27 19:52:33 +0000332 Module->IsSystem));
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000333 return true;
334}
335
336bool GenerateModuleAction::ComputeASTConsumerArguments(CompilerInstance &CI,
337 StringRef InFile,
338 std::string &Sysroot,
339 std::string &OutputFile,
340 raw_ostream *&OS) {
341 // If no output file was provided, figure out where this module would go
342 // in the module cache.
343 if (CI.getFrontendOpts().OutputFile.empty()) {
344 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000345 CI.getFrontendOpts().OutputFile =
346 HS.getModuleFileName(CI.getLangOpts().CurrentModule,
347 ModuleMapForUniquing->getName());
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000348 }
349
350 // We use createOutputFile here because this is exposed via libclang, and we
351 // must disable the RemoveFileOnSignal behavior.
352 // We use a temporary to avoid race conditions.
353 OS = CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
354 /*RemoveFileOnSignal=*/false, InFile,
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000355 /*Extension=*/"", /*useTemporary=*/true,
356 /*CreateMissingDirectories=*/true);
Douglas Gregor2b20cb82011-11-16 00:09:06 +0000357 if (!OS)
358 return true;
359
360 OutputFile = CI.getFrontendOpts().OutputFile;
361 return false;
362}
363
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000364ASTConsumer *SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000365 StringRef InFile) {
Daniel Dunbar02bd2d72009-11-14 10:42:46 +0000366 return new ASTConsumer();
367}
368
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000369ASTConsumer *DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
370 StringRef InFile) {
371 return new ASTConsumer();
372}
373
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000374ASTConsumer *VerifyPCHAction::CreateASTConsumer(CompilerInstance &CI,
375 StringRef InFile) {
376 return new ASTConsumer();
377}
378
379void VerifyPCHAction::ExecuteAction() {
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000380 CompilerInstance &CI = getCompilerInstance();
381 bool Preamble = CI.getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
382 const std::string &Sysroot = CI.getHeaderSearchOpts().Sysroot;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000383 std::unique_ptr<ASTReader> Reader(
384 new ASTReader(CI.getPreprocessor(), CI.getASTContext(),
385 Sysroot.empty() ? "" : Sysroot.c_str(),
386 /*DisableValidation*/ false,
387 /*AllowPCHWithCompilerErrors*/ false,
388 /*AllowConfigurationMismatch*/ true,
389 /*ValidateSystemInputs*/ true));
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000390
391 Reader->ReadAST(getCurrentFile(),
392 Preamble ? serialization::MK_Preamble
393 : serialization::MK_PCH,
394 SourceLocation(),
395 ASTReader::ARR_ConfigurationMismatch);
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000396}
397
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000398namespace {
399 /// \brief AST reader listener that dumps module information for a module
400 /// file.
401 class DumpModuleInfoListener : public ASTReaderListener {
402 llvm::raw_ostream &Out;
403
404 public:
405 DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
406
407#define DUMP_BOOLEAN(Value, Text) \
408 Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
409
Craig Topperafa7cb32014-03-13 06:07:04 +0000410 bool ReadFullVersionInformation(StringRef FullVersion) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000411 Out.indent(2)
412 << "Generated by "
413 << (FullVersion == getClangFullRepositoryVersion()? "this"
414 : "a different")
415 << " Clang: " << FullVersion << "\n";
416 return ASTReaderListener::ReadFullVersionInformation(FullVersion);
417 }
418
Craig Topperafa7cb32014-03-13 06:07:04 +0000419 bool ReadLanguageOptions(const LangOptions &LangOpts,
420 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000421 Out.indent(2) << "Language options:\n";
422#define LANGOPT(Name, Bits, Default, Description) \
423 DUMP_BOOLEAN(LangOpts.Name, Description);
424#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
425 Out.indent(4) << Description << ": " \
426 << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
427#define VALUE_LANGOPT(Name, Bits, Default, Description) \
428 Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
429#define BENIGN_LANGOPT(Name, Bits, Default, Description)
430#define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
431#include "clang/Basic/LangOptions.def"
432 return false;
433 }
434
Craig Topperafa7cb32014-03-13 06:07:04 +0000435 bool ReadTargetOptions(const TargetOptions &TargetOpts,
436 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000437 Out.indent(2) << "Target options:\n";
438 Out.indent(4) << " Triple: " << TargetOpts.Triple << "\n";
439 Out.indent(4) << " CPU: " << TargetOpts.CPU << "\n";
440 Out.indent(4) << " ABI: " << TargetOpts.ABI << "\n";
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000441 Out.indent(4) << " Linker version: " << TargetOpts.LinkerVersion << "\n";
442
443 if (!TargetOpts.FeaturesAsWritten.empty()) {
444 Out.indent(4) << "Target features:\n";
445 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
446 I != N; ++I) {
447 Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
448 }
449 }
450
451 return false;
452 }
453
Craig Topperafa7cb32014-03-13 06:07:04 +0000454 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
455 bool Complain) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000456 Out.indent(2) << "Header search options:\n";
457 Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
458 DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
459 "Use builtin include directories [-nobuiltininc]");
460 DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
461 "Use standard system include directories [-nostdinc]");
462 DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
463 "Use standard C++ include directories [-nostdinc++]");
464 DUMP_BOOLEAN(HSOpts.UseLibcxx,
465 "Use libc++ (rather than libstdc++) [-stdlib=]");
466 return false;
467 }
468
Craig Topperafa7cb32014-03-13 06:07:04 +0000469 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
470 bool Complain,
471 std::string &SuggestedPredefines) override {
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000472 Out.indent(2) << "Preprocessor options:\n";
473 DUMP_BOOLEAN(PPOpts.UsePredefines,
474 "Uses compiler/target-specific predefines [-undef]");
475 DUMP_BOOLEAN(PPOpts.DetailedRecord,
476 "Uses detailed preprocessing record (for indexing)");
477
478 if (!PPOpts.Macros.empty()) {
479 Out.indent(4) << "Predefined macros:\n";
480 }
481
482 for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
483 I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
484 I != IEnd; ++I) {
485 Out.indent(6);
486 if (I->second)
487 Out << "-U";
488 else
489 Out << "-D";
490 Out << I->first << "\n";
491 }
492 return false;
493 }
494#undef DUMP_BOOLEAN
495 };
496}
497
498void DumpModuleInfoAction::ExecuteAction() {
499 // Set up the output file.
Ahmed Charlesb8984322014-03-07 20:03:18 +0000500 std::unique_ptr<llvm::raw_fd_ostream> OutFile;
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000501 StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
502 if (!OutputFileName.empty() && OutputFileName != "-") {
503 std::string ErrorInfo;
504 OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str().c_str(),
Rafael Espindola4fbd3732014-02-24 18:20:21 +0000505 ErrorInfo, llvm::sys::fs::F_Text));
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000506 }
507 llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
508
509 Out << "Information for module file '" << getCurrentFile() << "':\n";
510 DumpModuleInfoListener Listener(Out);
511 ASTReader::readASTFileControlBlock(getCurrentFile(),
512 getCompilerInstance().getFileManager(),
513 Listener);
514}
515
Daniel Dunbar88357802009-11-14 10:42:57 +0000516//===----------------------------------------------------------------------===//
517// Preprocessor Actions
518//===----------------------------------------------------------------------===//
519
520void DumpRawTokensAction::ExecuteAction() {
521 Preprocessor &PP = getCompilerInstance().getPreprocessor();
522 SourceManager &SM = PP.getSourceManager();
523
524 // Start lexing the specified input file.
Chris Lattner710bb872009-11-30 04:18:44 +0000525 const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
David Blaikiebbafb8a2012-03-11 07:00:24 +0000526 Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
Daniel Dunbar88357802009-11-14 10:42:57 +0000527 RawLex.SetKeepWhitespaceMode(true);
528
529 Token RawTok;
530 RawLex.LexFromRawLexer(RawTok);
531 while (RawTok.isNot(tok::eof)) {
532 PP.DumpToken(RawTok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000533 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000534 RawLex.LexFromRawLexer(RawTok);
535 }
536}
537
538void DumpTokensAction::ExecuteAction() {
539 Preprocessor &PP = getCompilerInstance().getPreprocessor();
540 // Start preprocessing the specified input file.
541 Token Tok;
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000542 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000543 do {
544 PP.Lex(Tok);
545 PP.DumpToken(Tok, true);
Daniel Dunbar75024622009-11-25 10:27:48 +0000546 llvm::errs() << "\n";
Daniel Dunbar88357802009-11-14 10:42:57 +0000547 } while (Tok.isNot(tok::eof));
548}
549
550void GeneratePTHAction::ExecuteAction() {
551 CompilerInstance &CI = getCompilerInstance();
552 if (CI.getFrontendOpts().OutputFile.empty() ||
553 CI.getFrontendOpts().OutputFile == "-") {
554 // FIXME: Don't fail this way.
555 // FIXME: Verify that we can actually seek in the given file.
Chris Lattner4b73cfa2010-04-07 22:58:06 +0000556 llvm::report_fatal_error("PTH requires a seekable file for output!");
Daniel Dunbar88357802009-11-14 10:42:57 +0000557 }
558 llvm::raw_fd_ostream *OS =
559 CI.createDefaultOutputFile(true, getCurrentFile());
Daniel Dunbar75546992009-12-03 09:13:30 +0000560 if (!OS) return;
561
Daniel Dunbar88357802009-11-14 10:42:57 +0000562 CacheTokens(CI.getPreprocessor(), OS);
563}
564
Daniel Dunbar88357802009-11-14 10:42:57 +0000565void PreprocessOnlyAction::ExecuteAction() {
566 Preprocessor &PP = getCompilerInstance().getPreprocessor();
567
Daniel Dunbard839e772010-06-11 20:10:12 +0000568 // Ignore unknown pragmas.
NAKAMURA Takumiddc86792013-12-04 11:12:26 +0000569 PP.AddPragmaHandler(new EmptyPragmaHandler());
Daniel Dunbard839e772010-06-11 20:10:12 +0000570
Daniel Dunbar88357802009-11-14 10:42:57 +0000571 Token Tok;
572 // Start parsing the specified input file.
Chris Lattnerfb24a3a2010-04-20 20:35:58 +0000573 PP.EnterMainSourceFile();
Daniel Dunbar88357802009-11-14 10:42:57 +0000574 do {
575 PP.Lex(Tok);
576 } while (Tok.isNot(tok::eof));
577}
578
Daniel Dunbar88357802009-11-14 10:42:57 +0000579void PrintPreprocessedAction::ExecuteAction() {
580 CompilerInstance &CI = getCompilerInstance();
Douglas Gregor52da28b2011-09-23 23:43:36 +0000581 // Output file may need to be set to 'Binary', to avoid converting Unix style
Steve Naroff3d38a682010-01-05 17:33:23 +0000582 // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
Douglas Gregor52da28b2011-09-23 23:43:36 +0000583 //
584 // Look to see what type of line endings the file uses. If there's a
585 // CRLF, then we won't open the file up in binary mode. If there is
586 // just an LF or CR, then we will open the file up in binary mode.
587 // In this fashion, the output format should match the input format, unless
588 // the input format has inconsistent line endings.
589 //
590 // This should be a relatively fast operation since most files won't have
591 // all of their source code on a single line. However, that is still a
592 // concern, so if we scan for too long, we'll just assume the file should
593 // be opened in binary mode.
594 bool BinaryMode = true;
595 bool InvalidFile = false;
596 const SourceManager& SM = CI.getSourceManager();
597 const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
598 &InvalidFile);
599 if (!InvalidFile) {
600 const char *cur = Buffer->getBufferStart();
601 const char *end = Buffer->getBufferEnd();
602 const char *next = (cur != end) ? cur + 1 : end;
603
604 // Limit ourselves to only scanning 256 characters into the source
605 // file. This is mostly a sanity check in case the file has no
606 // newlines whatsoever.
607 if (end - cur > 256) end = cur + 256;
608
609 while (next < end) {
610 if (*cur == 0x0D) { // CR
611 if (*next == 0x0A) // CRLF
612 BinaryMode = false;
613
614 break;
615 } else if (*cur == 0x0A) // LF
616 break;
617
618 ++cur, ++next;
619 }
620 }
621
622 raw_ostream *OS = CI.createDefaultOutputFile(BinaryMode, getCurrentFile());
Daniel Dunbar75546992009-12-03 09:13:30 +0000623 if (!OS) return;
624
Daniel Dunbar88357802009-11-14 10:42:57 +0000625 DoPrintPreprocessedInput(CI.getPreprocessor(), OS,
626 CI.getPreprocessorOutputOpts());
627}
Douglas Gregoraf82e352010-07-20 20:18:03 +0000628
629void PrintPreambleAction::ExecuteAction() {
630 switch (getCurrentFileKind()) {
631 case IK_C:
632 case IK_CXX:
633 case IK_ObjC:
634 case IK_ObjCXX:
635 case IK_OpenCL:
Peter Collingbourne62089b82010-12-01 03:15:20 +0000636 case IK_CUDA:
Douglas Gregoraf82e352010-07-20 20:18:03 +0000637 break;
638
639 case IK_None:
640 case IK_Asm:
641 case IK_PreprocessedC:
642 case IK_PreprocessedCXX:
643 case IK_PreprocessedObjC:
644 case IK_PreprocessedObjCXX:
645 case IK_AST:
646 case IK_LLVM_IR:
647 // We can't do anything with these.
648 return;
649 }
650
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000651 CompilerInstance &CI = getCompilerInstance();
652 llvm::MemoryBuffer *Buffer
Chris Lattner5159f612010-11-23 08:35:12 +0000653 = CI.getFileManager().getBufferForFile(getCurrentFile());
Douglas Gregoraf82e352010-07-20 20:18:03 +0000654 if (Buffer) {
Argyrios Kyrtzidis7aecbc72011-08-25 20:39:19 +0000655 unsigned Preamble = Lexer::ComputePreamble(Buffer, CI.getLangOpts()).first;
Douglas Gregoraf82e352010-07-20 20:18:03 +0000656 llvm::outs().write(Buffer->getBufferStart(), Preamble);
657 delete Buffer;
658 }
659}