blob: 83b2a271ec360e63542ad2578c1758bf8f68ecaa [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- PrintPreprocessedOutput.cpp - Implement the -E mode --------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This code simply runs the preprocessor on the input file and prints out the
11// result. This is the traditional behavior of the -E option.
12//
13//===----------------------------------------------------------------------===//
14
Eli Friedmanb09f6e12009-05-19 04:14:29 +000015#include "clang/Frontend/Utils.h"
Jordan Rose3f6f51e2013-02-08 22:30:41 +000016#include "clang/Basic/CharInfo.h"
Daniel Dunbar775bee72009-11-11 10:07:22 +000017#include "clang/Basic/Diagnostic.h"
18#include "clang/Basic/SourceManager.h"
19#include "clang/Frontend/PreprocessorOutputOptions.h"
Chris Lattnerf73903a2009-02-06 06:45:26 +000020#include "clang/Lex/MacroInfo.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000021#include "clang/Lex/PPCallbacks.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000022#include "clang/Lex/Pragma.h"
Daniel Dunbar775bee72009-11-11 10:07:22 +000023#include "clang/Lex/Preprocessor.h"
Chris Lattnerd7038e12009-02-13 00:46:04 +000024#include "clang/Lex/TokenConcatenation.h"
Benjamin Kramer3ff2a4b2010-01-19 17:42:20 +000025#include "llvm/ADT/STLExtras.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000026#include "llvm/ADT/SmallString.h"
Chris Lattnerabfe0942010-06-26 17:11:39 +000027#include "llvm/ADT/StringRef.h"
Douglas Gregorc09ce122011-06-22 19:41:48 +000028#include "llvm/Support/ErrorHandling.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000029#include "llvm/Support/raw_ostream.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000030#include <cstdio>
31using namespace clang;
32
Chris Lattnerd82df3a2009-04-12 01:56:53 +000033/// PrintMacroDefinition - Print a macro definition in a form that will be
34/// properly accepted back as a definition.
35static void PrintMacroDefinition(const IdentifierInfo &II, const MacroInfo &MI,
Chris Lattner5f9e2722011-07-23 10:55:15 +000036 Preprocessor &PP, raw_ostream &OS) {
Chris Lattnerd82df3a2009-04-12 01:56:53 +000037 OS << "#define " << II.getName();
Mike Stump1eb44332009-09-09 15:08:12 +000038
Chris Lattnerd82df3a2009-04-12 01:56:53 +000039 if (MI.isFunctionLike()) {
40 OS << '(';
Chris Lattner13d55582009-12-09 02:08:14 +000041 if (!MI.arg_empty()) {
Chris Lattnerd82df3a2009-04-12 01:56:53 +000042 MacroInfo::arg_iterator AI = MI.arg_begin(), E = MI.arg_end();
Chris Lattner13d55582009-12-09 02:08:14 +000043 for (; AI+1 != E; ++AI) {
44 OS << (*AI)->getName();
Chris Lattner807b93e2009-12-07 01:58:34 +000045 OS << ',';
Chris Lattner807b93e2009-12-07 01:58:34 +000046 }
Chris Lattner13d55582009-12-09 02:08:14 +000047
48 // Last argument.
49 if ((*AI)->getName() == "__VA_ARGS__")
50 OS << "...";
51 else
52 OS << (*AI)->getName();
Chris Lattnerd82df3a2009-04-12 01:56:53 +000053 }
Mike Stump1eb44332009-09-09 15:08:12 +000054
Chris Lattner807b93e2009-12-07 01:58:34 +000055 if (MI.isGNUVarargs())
56 OS << "..."; // #define foo(x...)
Kovarththanan Rajaratnama5d10c42010-03-07 07:30:06 +000057
Chris Lattnerd82df3a2009-04-12 01:56:53 +000058 OS << ')';
59 }
Mike Stump1eb44332009-09-09 15:08:12 +000060
Chris Lattnerd82df3a2009-04-12 01:56:53 +000061 // GCC always emits a space, even if the macro body is empty. However, do not
62 // want to emit two spaces if the first token has a leading space.
63 if (MI.tokens_empty() || !MI.tokens_begin()->hasLeadingSpace())
64 OS << ' ';
Mike Stump1eb44332009-09-09 15:08:12 +000065
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +000066 SmallString<128> SpellingBuffer;
Chris Lattnerd82df3a2009-04-12 01:56:53 +000067 for (MacroInfo::tokens_iterator I = MI.tokens_begin(), E = MI.tokens_end();
68 I != E; ++I) {
69 if (I->hasLeadingSpace())
70 OS << ' ';
Mike Stump1eb44332009-09-09 15:08:12 +000071
Benjamin Kramerddeea562010-02-27 13:44:12 +000072 OS << PP.getSpelling(*I, SpellingBuffer);
Chris Lattnerd82df3a2009-04-12 01:56:53 +000073 }
74}
75
Reid Spencer5f016e22007-07-11 17:01:13 +000076//===----------------------------------------------------------------------===//
77// Preprocessed token printer
78//===----------------------------------------------------------------------===//
79
Reid Spencer5f016e22007-07-11 17:01:13 +000080namespace {
81class PrintPPOutputPPCallbacks : public PPCallbacks {
82 Preprocessor &PP;
Chris Lattnerdf721402010-04-13 00:06:42 +000083 SourceManager &SM;
Chris Lattnerd7038e12009-02-13 00:46:04 +000084 TokenConcatenation ConcatInfo;
Chris Lattnere96de3e2008-08-17 03:12:02 +000085public:
Chris Lattner5f9e2722011-07-23 10:55:15 +000086 raw_ostream &OS;
Chris Lattnere96de3e2008-08-17 03:12:02 +000087private:
Reid Spencer5f016e22007-07-11 17:01:13 +000088 unsigned CurLine;
Daniel Dunbarf7c16d92010-08-24 22:44:13 +000089
Reid Spencer5f016e22007-07-11 17:01:13 +000090 bool EmittedTokensOnThisLine;
Jordan Rose0cdd1fe2012-06-15 23:33:51 +000091 bool EmittedDirectiveOnThisLine;
Chris Lattner9d728512008-10-27 01:19:25 +000092 SrcMgr::CharacteristicKind FileType;
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +000093 SmallString<512> CurFilename;
Daniel Dunbar737bdb42008-09-05 03:22:57 +000094 bool Initialized;
Eli Friedman12d3b1d2009-05-19 03:06:47 +000095 bool DisableLineMarkers;
96 bool DumpDefines;
Chris Lattnerf7449342009-12-07 01:42:56 +000097 bool UseLineDirective;
Daniel Dunbar2a9be3e2012-11-16 01:51:11 +000098 bool IsFirstFileEntered;
Reid Spencer5f016e22007-07-11 17:01:13 +000099public:
Chris Lattner5f9e2722011-07-23 10:55:15 +0000100 PrintPPOutputPPCallbacks(Preprocessor &pp, raw_ostream &os,
Daniel Dunbareef63e02011-02-02 15:41:17 +0000101 bool lineMarkers, bool defines)
Chris Lattnerdf721402010-04-13 00:06:42 +0000102 : PP(pp), SM(PP.getSourceManager()),
103 ConcatInfo(PP), OS(os), DisableLineMarkers(lineMarkers),
Daniel Dunbareef63e02011-02-02 15:41:17 +0000104 DumpDefines(defines) {
105 CurLine = 0;
Chris Lattnerd8e30832007-07-24 06:57:14 +0000106 CurFilename += "<uninit>";
Reid Spencer5f016e22007-07-11 17:01:13 +0000107 EmittedTokensOnThisLine = false;
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000108 EmittedDirectiveOnThisLine = false;
Chris Lattner0b9e7362008-09-26 21:18:42 +0000109 FileType = SrcMgr::C_User;
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000110 Initialized = false;
Daniel Dunbar2a9be3e2012-11-16 01:51:11 +0000111 IsFirstFileEntered = false;
Kovarththanan Rajaratnama5d10c42010-03-07 07:30:06 +0000112
Chris Lattnerf7449342009-12-07 01:42:56 +0000113 // If we're in microsoft mode, use normal #line instead of line markers.
David Blaikie4e4d0842012-03-11 07:00:24 +0000114 UseLineDirective = PP.getLangOpts().MicrosoftExt;
Reid Spencer5f016e22007-07-11 17:01:13 +0000115 }
Mike Stump1eb44332009-09-09 15:08:12 +0000116
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000117 void setEmittedTokensOnThisLine() { EmittedTokensOnThisLine = true; }
Chris Lattnerf0f2b292007-07-23 06:09:34 +0000118 bool hasEmittedTokensOnThisLine() const { return EmittedTokensOnThisLine; }
Mike Stump1eb44332009-09-09 15:08:12 +0000119
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000120 void setEmittedDirectiveOnThisLine() { EmittedDirectiveOnThisLine = true; }
121 bool hasEmittedDirectiveOnThisLine() const {
122 return EmittedDirectiveOnThisLine;
123 }
124
125 bool startNewLineIfNeeded(bool ShouldUpdateCurrentLine = true);
Douglas Gregor80c60f72010-09-09 22:45:38 +0000126
Reid Spencer5f016e22007-07-11 17:01:13 +0000127 virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason,
Argyrios Kyrtzidisc892c5f2011-10-11 17:29:44 +0000128 SrcMgr::CharacteristicKind FileType,
129 FileID PrevFID);
Argyrios Kyrtzidis15aa81a2013-04-10 01:53:46 +0000130 virtual void InclusionDirective(SourceLocation HashLoc,
131 const Token &IncludeTok,
132 StringRef FileName,
133 bool IsAngled,
134 CharSourceRange FilenameRange,
135 const FileEntry *File,
136 StringRef SearchPath,
137 StringRef RelativePath,
138 const Module *Imported);
Reid Spencer5f016e22007-07-11 17:01:13 +0000139 virtual void Ident(SourceLocation Loc, const std::string &str);
Tareq A. Siraj6afcf882013-04-16 19:37:38 +0000140 virtual void PragmaCaptured(SourceLocation Loc, StringRef Str);
Mike Stump1eb44332009-09-09 15:08:12 +0000141 virtual void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind,
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000142 const std::string &Str);
Aaron Ballmana7ff62f2013-06-04 02:07:14 +0000143 virtual void PragmaDetectMismatch(SourceLocation Loc,
144 const std::string &Name,
145 const std::string &Value);
Andy Gibbs076eea22013-04-17 16:16:16 +0000146 virtual void PragmaMessage(SourceLocation Loc, StringRef Namespace,
147 PragmaMessageKind Kind, StringRef Str);
Tareq A. Siraj85192c72013-04-16 18:41:26 +0000148 virtual void PragmaDebug(SourceLocation Loc, StringRef DebugType);
Douglas Gregorc09ce122011-06-22 19:41:48 +0000149 virtual void PragmaDiagnosticPush(SourceLocation Loc,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000150 StringRef Namespace);
Douglas Gregorc09ce122011-06-22 19:41:48 +0000151 virtual void PragmaDiagnosticPop(SourceLocation Loc,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000152 StringRef Namespace);
153 virtual void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
Benjamin Kramerd7a3e2c2012-02-07 22:29:24 +0000154 diag::Mapping Map, StringRef Str);
Reid Spencer5f016e22007-07-11 17:01:13 +0000155
Chris Lattner5f180322007-12-09 21:11:08 +0000156 bool HandleFirstTokOnLine(Token &Tok);
Hal Finkel43bb45d2013-01-28 04:37:37 +0000157
158 /// Move to the line of the provided source location. This will
159 /// return true if the output stream required adjustment or if
160 /// the requested location is on the first line.
Chris Lattner88aae912010-04-13 00:01:41 +0000161 bool MoveToLine(SourceLocation Loc) {
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000162 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
163 if (PLoc.isInvalid())
164 return false;
Hal Finkel43bb45d2013-01-28 04:37:37 +0000165 return MoveToLine(PLoc.getLine()) || (PLoc.getLine() == 1);
Chris Lattner88aae912010-04-13 00:01:41 +0000166 }
167 bool MoveToLine(unsigned LineNo);
168
Chris Lattner88773212010-04-14 03:57:19 +0000169 bool AvoidConcat(const Token &PrevPrevTok, const Token &PrevTok,
170 const Token &Tok) {
171 return ConcatInfo.AvoidConcat(PrevPrevTok, PrevTok, Tok);
Chris Lattnerd7038e12009-02-13 00:46:04 +0000172 }
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000173 void WriteLineInfo(unsigned LineNo, const char *Extra=0, unsigned ExtraLen=0);
Douglas Gregor80c60f72010-09-09 22:45:38 +0000174 bool LineMarkersAreDisabled() const { return DisableLineMarkers; }
Chris Lattner3ee211f2009-06-15 01:25:23 +0000175 void HandleNewlinesInToken(const char *TokStr, unsigned Len);
Mike Stump1eb44332009-09-09 15:08:12 +0000176
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000177 /// MacroDefined - This hook is called whenever a macro definition is seen.
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000178 void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD);
Mike Stump1eb44332009-09-09 15:08:12 +0000179
Benjamin Kramer2f054492010-08-07 22:27:00 +0000180 /// MacroUndefined - This hook is called whenever a macro #undef is seen.
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000181 void MacroUndefined(const Token &MacroNameTok, const MacroDirective *MD);
Reid Spencer5f016e22007-07-11 17:01:13 +0000182};
Chris Lattner5db17c92008-04-08 04:16:20 +0000183} // end anonymous namespace
Reid Spencer5f016e22007-07-11 17:01:13 +0000184
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000185void PrintPPOutputPPCallbacks::WriteLineInfo(unsigned LineNo,
186 const char *Extra,
187 unsigned ExtraLen) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000188 startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000189
Chris Lattnerf7449342009-12-07 01:42:56 +0000190 // Emit #line directives or GNU line markers depending on what mode we're in.
191 if (UseLineDirective) {
192 OS << "#line" << ' ' << LineNo << ' ' << '"';
Ted Kremenek23465132010-09-17 00:41:18 +0000193 OS.write(CurFilename.data(), CurFilename.size());
Chris Lattnerf7449342009-12-07 01:42:56 +0000194 OS << '"';
195 } else {
196 OS << '#' << ' ' << LineNo << ' ' << '"';
Ted Kremenek23465132010-09-17 00:41:18 +0000197 OS.write(CurFilename.data(), CurFilename.size());
Chris Lattnerf7449342009-12-07 01:42:56 +0000198 OS << '"';
Kovarththanan Rajaratnama5d10c42010-03-07 07:30:06 +0000199
Steve Naroffd76fbda2009-12-06 01:02:14 +0000200 if (ExtraLen)
201 OS.write(Extra, ExtraLen);
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000202
Steve Naroffd76fbda2009-12-06 01:02:14 +0000203 if (FileType == SrcMgr::C_System)
204 OS.write(" 3", 2);
205 else if (FileType == SrcMgr::C_ExternCSystem)
206 OS.write(" 3 4", 4);
207 }
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000208 OS << '\n';
209}
210
Reid Spencer5f016e22007-07-11 17:01:13 +0000211/// MoveToLine - Move the output to the source line specified by the location
212/// object. We can do this by emitting some number of \n's, or be emitting a
Chris Lattner5f180322007-12-09 21:11:08 +0000213/// #line directive. This returns false if already at the specified line, true
214/// if some newlines were emitted.
Chris Lattner88aae912010-04-13 00:01:41 +0000215bool PrintPPOutputPPCallbacks::MoveToLine(unsigned LineNo) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000216 // If this line is "close enough" to the original line, just print newlines,
217 // otherwise print a #line directive.
Daniel Dunbarfd966842008-09-26 01:13:35 +0000218 if (LineNo-CurLine <= 8) {
Chris Lattner822f9402007-07-23 05:14:05 +0000219 if (LineNo-CurLine == 1)
Chris Lattnere96de3e2008-08-17 03:12:02 +0000220 OS << '\n';
Chris Lattner5f180322007-12-09 21:11:08 +0000221 else if (LineNo == CurLine)
Chandler Carruth9f79a1f2011-07-14 16:14:52 +0000222 return false; // Spelling line moved, but expansion line didn't.
Chris Lattner822f9402007-07-23 05:14:05 +0000223 else {
224 const char *NewLines = "\n\n\n\n\n\n\n\n";
Chris Lattnere96de3e2008-08-17 03:12:02 +0000225 OS.write(NewLines, LineNo-CurLine);
Chris Lattner822f9402007-07-23 05:14:05 +0000226 }
Chris Lattner6133aeb2010-06-12 16:20:56 +0000227 } else if (!DisableLineMarkers) {
228 // Emit a #line or line marker.
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000229 WriteLineInfo(LineNo, 0, 0);
Chris Lattner6133aeb2010-06-12 16:20:56 +0000230 } else {
231 // Okay, we're in -P mode, which turns off line markers. However, we still
232 // need to emit a newline between tokens on different lines.
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000233 startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
Mike Stump1eb44332009-09-09 15:08:12 +0000234 }
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000235
Mike Stump1eb44332009-09-09 15:08:12 +0000236 CurLine = LineNo;
Chris Lattner5f180322007-12-09 21:11:08 +0000237 return true;
Reid Spencer5f016e22007-07-11 17:01:13 +0000238}
239
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000240bool
241PrintPPOutputPPCallbacks::startNewLineIfNeeded(bool ShouldUpdateCurrentLine) {
242 if (EmittedTokensOnThisLine || EmittedDirectiveOnThisLine) {
Douglas Gregor80c60f72010-09-09 22:45:38 +0000243 OS << '\n';
244 EmittedTokensOnThisLine = false;
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000245 EmittedDirectiveOnThisLine = false;
246 if (ShouldUpdateCurrentLine)
247 ++CurLine;
Douglas Gregor80c60f72010-09-09 22:45:38 +0000248 return true;
249 }
250
251 return false;
252}
Reid Spencer5f016e22007-07-11 17:01:13 +0000253
254/// FileChanged - Whenever the preprocessor enters or exits a #include file
255/// it invokes this handler. Update our conception of the current source
256/// position.
257void PrintPPOutputPPCallbacks::FileChanged(SourceLocation Loc,
258 FileChangeReason Reason,
Argyrios Kyrtzidisc892c5f2011-10-11 17:29:44 +0000259 SrcMgr::CharacteristicKind NewFileType,
260 FileID PrevFID) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000261 // Unless we are exiting a #include, make sure to skip ahead to the line the
262 // #include directive was at.
Chris Lattnerdf721402010-04-13 00:06:42 +0000263 SourceManager &SourceMgr = SM;
Chris Lattner88aae912010-04-13 00:01:41 +0000264
265 PresumedLoc UserLoc = SourceMgr.getPresumedLoc(Loc);
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000266 if (UserLoc.isInvalid())
267 return;
268
Chris Lattner86d0ef72010-04-14 04:28:50 +0000269 unsigned NewLine = UserLoc.getLine();
Daniel Dunbarf7c16d92010-08-24 22:44:13 +0000270
Reid Spencer5f016e22007-07-11 17:01:13 +0000271 if (Reason == PPCallbacks::EnterFile) {
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000272 SourceLocation IncludeLoc = UserLoc.getIncludeLoc();
Chris Lattner71d8bfb2009-01-30 18:44:17 +0000273 if (IncludeLoc.isValid())
274 MoveToLine(IncludeLoc);
Reid Spencer5f016e22007-07-11 17:01:13 +0000275 } else if (Reason == PPCallbacks::SystemHeaderPragma) {
Jordan Rose142b35e2013-04-17 19:09:18 +0000276 // GCC emits the # directive for this directive on the line AFTER the
277 // directive and emits a bunch of spaces that aren't needed. This is because
278 // otherwise we will emit a line marker for THIS line, which requires an
279 // extra blank line after the directive to avoid making all following lines
280 // off by one. We can do better by simply incrementing NewLine here.
281 NewLine += 1;
Reid Spencer5f016e22007-07-11 17:01:13 +0000282 }
Chris Lattner88aae912010-04-13 00:01:41 +0000283
284 CurLine = NewLine;
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000285
Chris Lattnerd8e30832007-07-24 06:57:14 +0000286 CurFilename.clear();
Chris Lattner88aae912010-04-13 00:01:41 +0000287 CurFilename += UserLoc.getFilename();
Chris Lattnerd8e30832007-07-24 06:57:14 +0000288 Lexer::Stringify(CurFilename);
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000289 FileType = NewFileType;
290
Eli Friedman086cc832013-01-09 03:16:42 +0000291 if (DisableLineMarkers) {
292 startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
293 return;
294 }
Daniel Dunbarf7c16d92010-08-24 22:44:13 +0000295
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000296 if (!Initialized) {
297 WriteLineInfo(CurLine);
298 Initialized = true;
Reid Spencer5f016e22007-07-11 17:01:13 +0000299 }
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000300
Daniel Dunbar2a9be3e2012-11-16 01:51:11 +0000301 // Do not emit an enter marker for the main file (which we expect is the first
302 // entered file). This matches gcc, and improves compatibility with some tools
303 // which track the # line markers as a way to determine when the preprocessed
304 // output is in the context of the main file.
305 if (Reason == PPCallbacks::EnterFile && !IsFirstFileEntered) {
306 IsFirstFileEntered = true;
307 return;
308 }
309
Reid Spencer5f016e22007-07-11 17:01:13 +0000310 switch (Reason) {
311 case PPCallbacks::EnterFile:
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000312 WriteLineInfo(CurLine, " 1", 2);
Reid Spencer5f016e22007-07-11 17:01:13 +0000313 break;
314 case PPCallbacks::ExitFile:
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000315 WriteLineInfo(CurLine, " 2", 2);
Reid Spencer5f016e22007-07-11 17:01:13 +0000316 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000317 case PPCallbacks::SystemHeaderPragma:
318 case PPCallbacks::RenameFile:
Daniel Dunbar737bdb42008-09-05 03:22:57 +0000319 WriteLineInfo(CurLine);
320 break;
Reid Spencer5f016e22007-07-11 17:01:13 +0000321 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000322}
323
Argyrios Kyrtzidis15aa81a2013-04-10 01:53:46 +0000324void PrintPPOutputPPCallbacks::InclusionDirective(SourceLocation HashLoc,
325 const Token &IncludeTok,
326 StringRef FileName,
327 bool IsAngled,
328 CharSourceRange FilenameRange,
329 const FileEntry *File,
330 StringRef SearchPath,
331 StringRef RelativePath,
332 const Module *Imported) {
333 // When preprocessing, turn implicit imports into @imports.
334 // FIXME: This is a stop-gap until a more comprehensive "preprocessing with
335 // modules" solution is introduced.
336 if (Imported) {
337 startNewLineIfNeeded();
338 MoveToLine(HashLoc);
339 OS << "@import " << Imported->getFullModuleName() << ";"
340 << " /* clang -E: implicit import for \"" << File->getName() << "\" */";
Argyrios Kyrtzidis56f6e092013-04-29 17:26:22 +0000341 EmittedTokensOnThisLine = true;
Argyrios Kyrtzidis15aa81a2013-04-10 01:53:46 +0000342 }
343}
344
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000345/// Ident - Handle #ident directives when read by the preprocessor.
Reid Spencer5f016e22007-07-11 17:01:13 +0000346///
347void PrintPPOutputPPCallbacks::Ident(SourceLocation Loc, const std::string &S) {
348 MoveToLine(Loc);
Mike Stump1eb44332009-09-09 15:08:12 +0000349
Chris Lattnere96de3e2008-08-17 03:12:02 +0000350 OS.write("#ident ", strlen("#ident "));
351 OS.write(&S[0], S.size());
Reid Spencer5f016e22007-07-11 17:01:13 +0000352 EmittedTokensOnThisLine = true;
353}
354
Tareq A. Siraj6afcf882013-04-16 19:37:38 +0000355void PrintPPOutputPPCallbacks::PragmaCaptured(SourceLocation Loc,
356 StringRef Str) {
357 startNewLineIfNeeded();
358 MoveToLine(Loc);
359 OS << "#pragma captured";
360
361 setEmittedDirectiveOnThisLine();
362}
363
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000364/// MacroDefined - This hook is called whenever a macro definition is seen.
Craig Silverstein2aa92672010-11-19 21:33:15 +0000365void PrintPPOutputPPCallbacks::MacroDefined(const Token &MacroNameTok,
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000366 const MacroDirective *MD) {
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +0000367 const MacroInfo *MI = MD->getMacroInfo();
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000368 // Only print out macro definitions in -dD mode.
369 if (!DumpDefines ||
370 // Ignore __FILE__ etc.
371 MI->isBuiltinMacro()) return;
Mike Stump1eb44332009-09-09 15:08:12 +0000372
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000373 MoveToLine(MI->getDefinitionLoc());
Craig Silverstein2aa92672010-11-19 21:33:15 +0000374 PrintMacroDefinition(*MacroNameTok.getIdentifierInfo(), *MI, PP, OS);
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000375 setEmittedDirectiveOnThisLine();
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000376}
377
Craig Silverstein2aa92672010-11-19 21:33:15 +0000378void PrintPPOutputPPCallbacks::MacroUndefined(const Token &MacroNameTok,
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000379 const MacroDirective *MD) {
Benjamin Kramer2f054492010-08-07 22:27:00 +0000380 // Only print out macro definitions in -dD mode.
381 if (!DumpDefines) return;
382
Craig Silverstein2aa92672010-11-19 21:33:15 +0000383 MoveToLine(MacroNameTok.getLocation());
384 OS << "#undef " << MacroNameTok.getIdentifierInfo()->getName();
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000385 setEmittedDirectiveOnThisLine();
Benjamin Kramer2f054492010-08-07 22:27:00 +0000386}
Chris Lattnerd82df3a2009-04-12 01:56:53 +0000387
Aaron Ballmana7ff62f2013-06-04 02:07:14 +0000388static void outputPrintable(llvm::raw_ostream& OS,
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000389 const std::string &Str) {
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000390 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
391 unsigned char Char = Str[i];
Jordan Rose3f6f51e2013-02-08 22:30:41 +0000392 if (isPrintable(Char) && Char != '\\' && Char != '"')
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000393 OS << (char)Char;
394 else // Output anything hard as an octal escape.
395 OS << '\\'
396 << (char)('0'+ ((Char >> 6) & 7))
397 << (char)('0'+ ((Char >> 3) & 7))
398 << (char)('0'+ ((Char >> 0) & 7));
399 }
Aaron Ballmana7ff62f2013-06-04 02:07:14 +0000400}
401
402void PrintPPOutputPPCallbacks::PragmaComment(SourceLocation Loc,
403 const IdentifierInfo *Kind,
404 const std::string &Str) {
405 startNewLineIfNeeded();
406 MoveToLine(Loc);
407 OS << "#pragma comment(" << Kind->getName();
408
409 if (!Str.empty()) {
410 OS << ", \"";
411 outputPrintable(OS, Str);
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000412 OS << '"';
413 }
Mike Stump1eb44332009-09-09 15:08:12 +0000414
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000415 OS << ')';
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000416 setEmittedDirectiveOnThisLine();
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000417}
418
Aaron Ballmana7ff62f2013-06-04 02:07:14 +0000419void PrintPPOutputPPCallbacks::PragmaDetectMismatch(SourceLocation Loc,
420 const std::string &Name,
421 const std::string &Value) {
422 startNewLineIfNeeded();
423 MoveToLine(Loc);
424 OS << "#pragma detect_mismatch(\"" << Name << '"';
425 outputPrintable(OS, Name);
426 OS << "\", \"";
427 outputPrintable(OS, Value);
428 OS << "\")";
429 setEmittedDirectiveOnThisLine();
430}
431
Chris Lattnerabfe0942010-06-26 17:11:39 +0000432void PrintPPOutputPPCallbacks::PragmaMessage(SourceLocation Loc,
Andy Gibbs076eea22013-04-17 16:16:16 +0000433 StringRef Namespace,
434 PragmaMessageKind Kind,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000435 StringRef Str) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000436 startNewLineIfNeeded();
Chris Lattnerabfe0942010-06-26 17:11:39 +0000437 MoveToLine(Loc);
Andy Gibbs076eea22013-04-17 16:16:16 +0000438 OS << "#pragma ";
439 if (!Namespace.empty())
440 OS << Namespace << ' ';
441 switch (Kind) {
442 case PMK_Message:
Andy Gibbsf5ae4dd2013-04-19 17:13:17 +0000443 OS << "message(\"";
Andy Gibbs076eea22013-04-17 16:16:16 +0000444 break;
445 case PMK_Warning:
Andy Gibbs688f2a12013-04-18 16:49:37 +0000446 OS << "warning \"";
Andy Gibbs076eea22013-04-17 16:16:16 +0000447 break;
448 case PMK_Error:
Andy Gibbs688f2a12013-04-18 16:49:37 +0000449 OS << "error \"";
Andy Gibbs076eea22013-04-17 16:16:16 +0000450 break;
451 }
Chris Lattnerabfe0942010-06-26 17:11:39 +0000452
Aaron Ballmana7ff62f2013-06-04 02:07:14 +0000453 outputPrintable(OS, Str);
Chris Lattnerabfe0942010-06-26 17:11:39 +0000454 OS << '"';
Andy Gibbsf5ae4dd2013-04-19 17:13:17 +0000455 if (Kind == PMK_Message)
456 OS << ')';
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000457 setEmittedDirectiveOnThisLine();
Chris Lattnerabfe0942010-06-26 17:11:39 +0000458}
459
Tareq A. Siraj85192c72013-04-16 18:41:26 +0000460void PrintPPOutputPPCallbacks::PragmaDebug(SourceLocation Loc,
461 StringRef DebugType) {
462 startNewLineIfNeeded();
463 MoveToLine(Loc);
464
465 OS << "#pragma clang __debug ";
466 OS << DebugType;
467
468 setEmittedDirectiveOnThisLine();
469}
470
Douglas Gregorc09ce122011-06-22 19:41:48 +0000471void PrintPPOutputPPCallbacks::
Chris Lattner5f9e2722011-07-23 10:55:15 +0000472PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000473 startNewLineIfNeeded();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000474 MoveToLine(Loc);
475 OS << "#pragma " << Namespace << " diagnostic push";
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000476 setEmittedDirectiveOnThisLine();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000477}
478
479void PrintPPOutputPPCallbacks::
Chris Lattner5f9e2722011-07-23 10:55:15 +0000480PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000481 startNewLineIfNeeded();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000482 MoveToLine(Loc);
483 OS << "#pragma " << Namespace << " diagnostic pop";
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000484 setEmittedDirectiveOnThisLine();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000485}
486
487void PrintPPOutputPPCallbacks::
Chris Lattner5f9e2722011-07-23 10:55:15 +0000488PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
Benjamin Kramerd7a3e2c2012-02-07 22:29:24 +0000489 diag::Mapping Map, StringRef Str) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000490 startNewLineIfNeeded();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000491 MoveToLine(Loc);
492 OS << "#pragma " << Namespace << " diagnostic ";
Benjamin Kramerd7a3e2c2012-02-07 22:29:24 +0000493 switch (Map) {
Douglas Gregorc09ce122011-06-22 19:41:48 +0000494 case diag::MAP_WARNING:
495 OS << "warning";
496 break;
497 case diag::MAP_ERROR:
498 OS << "error";
499 break;
500 case diag::MAP_IGNORE:
501 OS << "ignored";
502 break;
503 case diag::MAP_FATAL:
504 OS << "fatal";
505 break;
506 }
507 OS << " \"" << Str << '"';
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000508 setEmittedDirectiveOnThisLine();
Douglas Gregorc09ce122011-06-22 19:41:48 +0000509}
Chris Lattnerc7d945d2009-01-16 19:25:54 +0000510
Reid Spencer5f016e22007-07-11 17:01:13 +0000511/// HandleFirstTokOnLine - When emitting a preprocessed file in -E mode, this
Chris Lattner5f180322007-12-09 21:11:08 +0000512/// is called for the first token on each new line. If this really is the start
513/// of a new logical line, handle it and return true, otherwise return false.
514/// This may not be the start of a logical line because the "start of line"
Chandler Carruth9f79a1f2011-07-14 16:14:52 +0000515/// marker is set for spelling lines, not expansion ones.
Chris Lattner5f180322007-12-09 21:11:08 +0000516bool PrintPPOutputPPCallbacks::HandleFirstTokOnLine(Token &Tok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000517 // Figure out what line we went to and insert the appropriate number of
518 // newline characters.
Chris Lattner5f180322007-12-09 21:11:08 +0000519 if (!MoveToLine(Tok.getLocation()))
520 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000521
Reid Spencer5f016e22007-07-11 17:01:13 +0000522 // Print out space characters so that the first token on a line is
523 // indented for easy reading.
Chandler Carrutha77c0312011-07-25 20:57:57 +0000524 unsigned ColNo = SM.getExpansionColumnNumber(Tok.getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +0000525
Reid Spencer5f016e22007-07-11 17:01:13 +0000526 // This hack prevents stuff like:
527 // #define HASH #
528 // HASH define foo bar
529 // From having the # character end up at column 1, which makes it so it
530 // is not handled as a #define next time through the preprocessor if in
531 // -fpreprocessed mode.
Chris Lattner057aaf62007-10-09 18:03:42 +0000532 if (ColNo <= 1 && Tok.is(tok::hash))
Chris Lattnere96de3e2008-08-17 03:12:02 +0000533 OS << ' ';
Mike Stump1eb44332009-09-09 15:08:12 +0000534
Reid Spencer5f016e22007-07-11 17:01:13 +0000535 // Otherwise, indent the appropriate number of spaces.
536 for (; ColNo > 1; --ColNo)
Chris Lattnere96de3e2008-08-17 03:12:02 +0000537 OS << ' ';
Mike Stump1eb44332009-09-09 15:08:12 +0000538
Chris Lattner5f180322007-12-09 21:11:08 +0000539 return true;
Reid Spencer5f016e22007-07-11 17:01:13 +0000540}
541
Chris Lattner3ee211f2009-06-15 01:25:23 +0000542void PrintPPOutputPPCallbacks::HandleNewlinesInToken(const char *TokStr,
543 unsigned Len) {
544 unsigned NumNewlines = 0;
545 for (; Len; --Len, ++TokStr) {
546 if (*TokStr != '\n' &&
547 *TokStr != '\r')
548 continue;
Mike Stump1eb44332009-09-09 15:08:12 +0000549
Chris Lattner3ee211f2009-06-15 01:25:23 +0000550 ++NumNewlines;
Mike Stump1eb44332009-09-09 15:08:12 +0000551
Chris Lattner3ee211f2009-06-15 01:25:23 +0000552 // If we have \n\r or \r\n, skip both and count as one line.
553 if (Len != 1 &&
554 (TokStr[1] == '\n' || TokStr[1] == '\r') &&
555 TokStr[0] != TokStr[1])
556 ++TokStr, --Len;
557 }
Mike Stump1eb44332009-09-09 15:08:12 +0000558
Chris Lattner3ee211f2009-06-15 01:25:23 +0000559 if (NumNewlines == 0) return;
Mike Stump1eb44332009-09-09 15:08:12 +0000560
Chris Lattnered2d7c42009-06-15 04:08:28 +0000561 CurLine += NumNewlines;
Chris Lattner3ee211f2009-06-15 01:25:23 +0000562}
563
564
Reid Spencer5f016e22007-07-11 17:01:13 +0000565namespace {
566struct UnknownPragmaHandler : public PragmaHandler {
567 const char *Prefix;
568 PrintPPOutputPPCallbacks *Callbacks;
Mike Stump1eb44332009-09-09 15:08:12 +0000569
Reid Spencer5f016e22007-07-11 17:01:13 +0000570 UnknownPragmaHandler(const char *prefix, PrintPPOutputPPCallbacks *callbacks)
Argyrios Kyrtzidis9b36c3f2010-07-13 09:07:17 +0000571 : Prefix(prefix), Callbacks(callbacks) {}
Douglas Gregor80c60f72010-09-09 22:45:38 +0000572 virtual void HandlePragma(Preprocessor &PP, PragmaIntroducerKind Introducer,
573 Token &PragmaTok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000574 // Figure out what line we went to and insert the appropriate number of
575 // newline characters.
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000576 Callbacks->startNewLineIfNeeded();
Reid Spencer5f016e22007-07-11 17:01:13 +0000577 Callbacks->MoveToLine(PragmaTok.getLocation());
Chris Lattnere96de3e2008-08-17 03:12:02 +0000578 Callbacks->OS.write(Prefix, strlen(Prefix));
Reid Spencer5f016e22007-07-11 17:01:13 +0000579 // Read and print all of the pragma tokens.
Peter Collingbourne84021552011-02-28 02:37:51 +0000580 while (PragmaTok.isNot(tok::eod)) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000581 if (PragmaTok.hasLeadingSpace())
Chris Lattnere96de3e2008-08-17 03:12:02 +0000582 Callbacks->OS << ' ';
Reid Spencer5f016e22007-07-11 17:01:13 +0000583 std::string TokSpell = PP.getSpelling(PragmaTok);
Chris Lattnere96de3e2008-08-17 03:12:02 +0000584 Callbacks->OS.write(&TokSpell[0], TokSpell.size());
Reid Spencer5f016e22007-07-11 17:01:13 +0000585 PP.LexUnexpandedToken(PragmaTok);
586 }
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000587 Callbacks->setEmittedDirectiveOnThisLine();
Reid Spencer5f016e22007-07-11 17:01:13 +0000588 }
589};
590} // end anonymous namespace
591
Chris Lattnerf0f2b292007-07-23 06:09:34 +0000592
Chris Lattner59076ab2009-02-06 05:56:11 +0000593static void PrintPreprocessedTokens(Preprocessor &PP, Token &Tok,
594 PrintPPOutputPPCallbacks *Callbacks,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000595 raw_ostream &OS) {
Jordan Rosecf2c2e92013-03-05 23:54:55 +0000596 bool DropComments = PP.getLangOpts().TraditionalCPP &&
597 !PP.getCommentRetentionState();
598
Benjamin Kramere3960072010-02-27 18:02:51 +0000599 char Buffer[256];
Chris Lattnerc54539c2010-06-15 21:06:38 +0000600 Token PrevPrevTok, PrevTok;
601 PrevPrevTok.startToken();
602 PrevTok.startToken();
Chris Lattner6f688e12007-10-10 20:45:16 +0000603 while (1) {
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000604 if (Callbacks->hasEmittedDirectiveOnThisLine()) {
605 Callbacks->startNewLineIfNeeded();
606 Callbacks->MoveToLine(Tok.getLocation());
607 }
Mike Stump1eb44332009-09-09 15:08:12 +0000608
Reid Spencer5f016e22007-07-11 17:01:13 +0000609 // If this token is at the start of a line, emit newlines if needed.
Chris Lattner5f180322007-12-09 21:11:08 +0000610 if (Tok.isAtStartOfLine() && Callbacks->HandleFirstTokOnLine(Tok)) {
611 // done.
Mike Stump1eb44332009-09-09 15:08:12 +0000612 } else if (Tok.hasLeadingSpace() ||
Chris Lattnerf0f2b292007-07-23 06:09:34 +0000613 // If we haven't emitted a token on this line yet, PrevTok isn't
614 // useful to look at and no concatenation could happen anyway.
Chris Lattnerb638a302007-07-23 23:21:34 +0000615 (Callbacks->hasEmittedTokensOnThisLine() &&
Chris Lattnerf0f2b292007-07-23 06:09:34 +0000616 // Don't print "-" next to "-", it would form "--".
Chris Lattner88773212010-04-14 03:57:19 +0000617 Callbacks->AvoidConcat(PrevPrevTok, PrevTok, Tok))) {
Chris Lattnere96de3e2008-08-17 03:12:02 +0000618 OS << ' ';
Reid Spencer5f016e22007-07-11 17:01:13 +0000619 }
Mike Stump1eb44332009-09-09 15:08:12 +0000620
Jordan Rosecf2c2e92013-03-05 23:54:55 +0000621 if (DropComments && Tok.is(tok::comment)) {
622 // Skip comments. Normally the preprocessor does not generate
623 // tok::comment nodes at all when not keeping comments, but under
624 // -traditional-cpp the lexer keeps /all/ whitespace, including comments.
625 SourceLocation StartLoc = Tok.getLocation();
626 Callbacks->MoveToLine(StartLoc.getLocWithOffset(Tok.getLength()));
627 } else if (IdentifierInfo *II = Tok.getIdentifierInfo()) {
Benjamin Kramere3960072010-02-27 18:02:51 +0000628 OS << II->getName();
629 } else if (Tok.isLiteral() && !Tok.needsCleaning() &&
630 Tok.getLiteralData()) {
631 OS.write(Tok.getLiteralData(), Tok.getLength());
632 } else if (Tok.getLength() < 256) {
633 const char *TokPtr = Buffer;
634 unsigned Len = PP.getSpelling(Tok, TokPtr);
635 OS.write(TokPtr, Len);
Mike Stump1eb44332009-09-09 15:08:12 +0000636
Benjamin Kramere3960072010-02-27 18:02:51 +0000637 // Tokens that can contain embedded newlines need to adjust our current
638 // line number.
Jordan Rose6aad4a32013-02-21 18:53:19 +0000639 if (Tok.getKind() == tok::comment || Tok.getKind() == tok::unknown)
Benjamin Kramere3960072010-02-27 18:02:51 +0000640 Callbacks->HandleNewlinesInToken(TokPtr, Len);
641 } else {
642 std::string S = PP.getSpelling(Tok);
643 OS.write(&S[0], S.size());
644
645 // Tokens that can contain embedded newlines need to adjust our current
646 // line number.
Jordan Rose6aad4a32013-02-21 18:53:19 +0000647 if (Tok.getKind() == tok::comment || Tok.getKind() == tok::unknown)
Benjamin Kramere3960072010-02-27 18:02:51 +0000648 Callbacks->HandleNewlinesInToken(&S[0], S.size());
649 }
Jordan Rose0cdd1fe2012-06-15 23:33:51 +0000650 Callbacks->setEmittedTokensOnThisLine();
Mike Stump1eb44332009-09-09 15:08:12 +0000651
Chris Lattner6f688e12007-10-10 20:45:16 +0000652 if (Tok.is(tok::eof)) break;
Mike Stump1eb44332009-09-09 15:08:12 +0000653
Chris Lattner88773212010-04-14 03:57:19 +0000654 PrevPrevTok = PrevTok;
Chris Lattner6f688e12007-10-10 20:45:16 +0000655 PrevTok = Tok;
656 PP.Lex(Tok);
657 }
Chris Lattner59076ab2009-02-06 05:56:11 +0000658}
659
Dmitri Gribenkob3958472013-01-14 00:36:42 +0000660typedef std::pair<const IdentifierInfo *, MacroInfo *> id_macro_pair;
Benjamin Kramer3ff2a4b2010-01-19 17:42:20 +0000661static int MacroIDCompare(const void* a, const void* b) {
662 const id_macro_pair *LHS = static_cast<const id_macro_pair*>(a);
663 const id_macro_pair *RHS = static_cast<const id_macro_pair*>(b);
664 return LHS->first->getName().compare(RHS->first->getName());
Chris Lattner2a2bb182009-02-10 22:28:19 +0000665}
Chris Lattner59076ab2009-02-06 05:56:11 +0000666
Chris Lattner5f9e2722011-07-23 10:55:15 +0000667static void DoPrintMacros(Preprocessor &PP, raw_ostream *OS) {
Daniel Dunbarc72cc502010-06-11 20:10:12 +0000668 // Ignore unknown pragmas.
Argyrios Kyrtzidis9b36c3f2010-07-13 09:07:17 +0000669 PP.AddPragmaHandler(new EmptyPragmaHandler());
Daniel Dunbarc72cc502010-06-11 20:10:12 +0000670
Eli Friedmanf1db5852009-05-19 01:32:34 +0000671 // -dM mode just scans and ignores all tokens in the files, then dumps out
672 // the macro table at the end.
Chris Lattnere127a0d2010-04-20 20:35:58 +0000673 PP.EnterMainSourceFile();
Eli Friedmanf1db5852009-05-19 01:32:34 +0000674
675 Token Tok;
676 do PP.Lex(Tok);
677 while (Tok.isNot(tok::eof));
678
Alexander Kornienko8a64bb52012-08-29 00:20:03 +0000679 SmallVector<id_macro_pair, 128> MacrosByID;
680 for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
681 I != E; ++I) {
682 if (I->first->hasMacroDefinition())
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +0000683 MacrosByID.push_back(id_macro_pair(I->first, I->second->getMacroInfo()));
Alexander Kornienko8a64bb52012-08-29 00:20:03 +0000684 }
Benjamin Kramer3ff2a4b2010-01-19 17:42:20 +0000685 llvm::array_pod_sort(MacrosByID.begin(), MacrosByID.end(), MacroIDCompare);
Eli Friedmanf1db5852009-05-19 01:32:34 +0000686
687 for (unsigned i = 0, e = MacrosByID.size(); i != e; ++i) {
688 MacroInfo &MI = *MacrosByID[i].second;
Mike Stump1eb44332009-09-09 15:08:12 +0000689 // Ignore computed macros like __LINE__ and friends.
Eli Friedmanf1db5852009-05-19 01:32:34 +0000690 if (MI.isBuiltinMacro()) continue;
691
692 PrintMacroDefinition(*MacrosByID[i].first, MI, PP, *OS);
Benjamin Kramer3ff2a4b2010-01-19 17:42:20 +0000693 *OS << '\n';
Eli Friedmanf1db5852009-05-19 01:32:34 +0000694 }
695}
696
Chris Lattner59076ab2009-02-06 05:56:11 +0000697/// DoPrintPreprocessedInput - This implements -E mode.
698///
Chris Lattner5f9e2722011-07-23 10:55:15 +0000699void clang::DoPrintPreprocessedInput(Preprocessor &PP, raw_ostream *OS,
Daniel Dunbar29cf7462009-11-11 10:07:44 +0000700 const PreprocessorOutputOptions &Opts) {
Daniel Dunbar775bee72009-11-11 10:07:22 +0000701 // Show macros with no output is handled specially.
702 if (!Opts.ShowCPP) {
703 assert(Opts.ShowMacros && "Not yet implemented!");
704 DoPrintMacros(PP, OS);
705 return;
706 }
707
Chris Lattner59076ab2009-02-06 05:56:11 +0000708 // Inform the preprocessor whether we want it to retain comments or not, due
709 // to -C or -CC.
Daniel Dunbar775bee72009-11-11 10:07:22 +0000710 PP.SetCommentRetentionState(Opts.ShowComments, Opts.ShowMacroComments);
Eli Friedmanf54fce82009-05-19 01:02:07 +0000711
Eli Friedman12d3b1d2009-05-19 03:06:47 +0000712 PrintPPOutputPPCallbacks *Callbacks =
Daniel Dunbar775bee72009-11-11 10:07:22 +0000713 new PrintPPOutputPPCallbacks(PP, *OS, !Opts.ShowLineMarkers,
Daniel Dunbareef63e02011-02-02 15:41:17 +0000714 Opts.ShowMacros);
Argyrios Kyrtzidis9b36c3f2010-07-13 09:07:17 +0000715 PP.AddPragmaHandler(new UnknownPragmaHandler("#pragma", Callbacks));
Chris Lattner13973992010-11-10 01:00:49 +0000716 PP.AddPragmaHandler("GCC", new UnknownPragmaHandler("#pragma GCC",Callbacks));
717 PP.AddPragmaHandler("clang",
718 new UnknownPragmaHandler("#pragma clang", Callbacks));
Chris Lattner59076ab2009-02-06 05:56:11 +0000719
Kovarththanan Rajaratnama5d10c42010-03-07 07:30:06 +0000720 PP.addPPCallbacks(Callbacks);
Chris Lattner59076ab2009-02-06 05:56:11 +0000721
Eli Friedmanf1db5852009-05-19 01:32:34 +0000722 // After we have configured the preprocessor, enter the main file.
Chris Lattnere127a0d2010-04-20 20:35:58 +0000723 PP.EnterMainSourceFile();
Chris Lattner59076ab2009-02-06 05:56:11 +0000724
Eli Friedmanf1db5852009-05-19 01:32:34 +0000725 // Consume all of the tokens that come from the predefines buffer. Those
726 // should not be emitted into the output and are guaranteed to be at the
727 // start.
728 const SourceManager &SourceMgr = PP.getSourceManager();
729 Token Tok;
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000730 do {
731 PP.Lex(Tok);
732 if (Tok.is(tok::eof) || !Tok.getLocation().isFileID())
733 break;
734
735 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation());
736 if (PLoc.isInvalid())
737 break;
738
739 if (strcmp(PLoc.getFilename(), "<built-in>"))
740 break;
741 } while (true);
Chris Lattner59076ab2009-02-06 05:56:11 +0000742
Eli Friedmanf1db5852009-05-19 01:32:34 +0000743 // Read all the preprocessed tokens, printing them out to the stream.
744 PrintPreprocessedTokens(PP, Tok, Callbacks, *OS);
745 *OS << '\n';
Reid Spencer5f016e22007-07-11 17:01:13 +0000746}