Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 1 | //===--- PrintPreprocessedOutput.cpp - Implement the -E mode --------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 5b12ab8 | 2007-12-29 19:59:25 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 7 | // |
| 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 Friedman | 16b7b6f | 2009-05-19 04:14:29 +0000 | [diff] [blame] | 15 | #include "clang/Frontend/Utils.h" |
Jordan Rose | a7d0384 | 2013-02-08 22:30:41 +0000 | [diff] [blame] | 16 | #include "clang/Basic/CharInfo.h" |
Daniel Dunbar | 531f6c6 | 2009-11-11 10:07:22 +0000 | [diff] [blame] | 17 | #include "clang/Basic/Diagnostic.h" |
| 18 | #include "clang/Basic/SourceManager.h" |
| 19 | #include "clang/Frontend/PreprocessorOutputOptions.h" |
Chris Lattner | 1630c3c | 2009-02-06 06:45:26 +0000 | [diff] [blame] | 20 | #include "clang/Lex/MacroInfo.h" |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 21 | #include "clang/Lex/PPCallbacks.h" |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 22 | #include "clang/Lex/Pragma.h" |
Daniel Dunbar | 531f6c6 | 2009-11-11 10:07:22 +0000 | [diff] [blame] | 23 | #include "clang/Lex/Preprocessor.h" |
Chris Lattner | 644d452 | 2009-02-13 00:46:04 +0000 | [diff] [blame] | 24 | #include "clang/Lex/TokenConcatenation.h" |
Benjamin Kramer | fb5f40f | 2010-01-19 17:42:20 +0000 | [diff] [blame] | 25 | #include "llvm/ADT/STLExtras.h" |
Chandler Carruth | 3a02247 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 26 | #include "llvm/ADT/SmallString.h" |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 27 | #include "llvm/ADT/StringRef.h" |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 28 | #include "llvm/Support/ErrorHandling.h" |
Chandler Carruth | 3a02247 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 29 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | deb3701 | 2006-07-04 19:24:06 +0000 | [diff] [blame] | 30 | #include <cstdio> |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 31 | using namespace clang; |
| 32 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 33 | /// PrintMacroDefinition - Print a macro definition in a form that will be |
| 34 | /// properly accepted back as a definition. |
| 35 | static void PrintMacroDefinition(const IdentifierInfo &II, const MacroInfo &MI, |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 36 | Preprocessor &PP, raw_ostream &OS) { |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 37 | OS << "#define " << II.getName(); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 38 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 39 | if (MI.isFunctionLike()) { |
| 40 | OS << '('; |
Faisal Vali | ac506d7 | 2017-07-17 17:18:43 +0000 | [diff] [blame] | 41 | if (!MI.param_empty()) { |
| 42 | MacroInfo::param_iterator AI = MI.param_begin(), E = MI.param_end(); |
Chris Lattner | 53d80e2 | 2009-12-09 02:08:14 +0000 | [diff] [blame] | 43 | for (; AI+1 != E; ++AI) { |
| 44 | OS << (*AI)->getName(); |
Chris Lattner | 9dfed9f | 2009-12-07 01:58:34 +0000 | [diff] [blame] | 45 | OS << ','; |
Chris Lattner | 9dfed9f | 2009-12-07 01:58:34 +0000 | [diff] [blame] | 46 | } |
Chris Lattner | 53d80e2 | 2009-12-09 02:08:14 +0000 | [diff] [blame] | 47 | |
| 48 | // Last argument. |
| 49 | if ((*AI)->getName() == "__VA_ARGS__") |
| 50 | OS << "..."; |
| 51 | else |
| 52 | OS << (*AI)->getName(); |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 53 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 54 | |
Chris Lattner | 9dfed9f | 2009-12-07 01:58:34 +0000 | [diff] [blame] | 55 | if (MI.isGNUVarargs()) |
| 56 | OS << "..."; // #define foo(x...) |
Kovarththanan Rajaratnam | 752a124 | 2010-03-07 07:30:06 +0000 | [diff] [blame] | 57 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 58 | OS << ')'; |
| 59 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 60 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 61 | // 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 Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 65 | |
Dylan Noblesmith | 2c1dd27 | 2012-02-05 02:13:05 +0000 | [diff] [blame] | 66 | SmallString<128> SpellingBuffer; |
Daniel Marjamaki | ecb0e1b | 2015-05-11 08:25:54 +0000 | [diff] [blame] | 67 | for (const auto &T : MI.tokens()) { |
| 68 | if (T.hasLeadingSpace()) |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 69 | OS << ' '; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 70 | |
Daniel Marjamaki | ecb0e1b | 2015-05-11 08:25:54 +0000 | [diff] [blame] | 71 | OS << PP.getSpelling(T, SpellingBuffer); |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 72 | } |
| 73 | } |
| 74 | |
Chris Lattner | f46be6c | 2006-07-04 22:19:33 +0000 | [diff] [blame] | 75 | //===----------------------------------------------------------------------===// |
| 76 | // Preprocessed token printer |
| 77 | //===----------------------------------------------------------------------===// |
| 78 | |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 79 | namespace { |
| 80 | class PrintPPOutputPPCallbacks : public PPCallbacks { |
| 81 | Preprocessor &PP; |
Chris Lattner | 9d94f04 | 2010-04-13 00:06:42 +0000 | [diff] [blame] | 82 | SourceManager &SM; |
Chris Lattner | 644d452 | 2009-02-13 00:46:04 +0000 | [diff] [blame] | 83 | TokenConcatenation ConcatInfo; |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 84 | public: |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 85 | raw_ostream &OS; |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 86 | private: |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 87 | unsigned CurLine; |
Daniel Dunbar | d435275 | 2010-08-24 22:44:13 +0000 | [diff] [blame] | 88 | |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 89 | bool EmittedTokensOnThisLine; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 90 | bool EmittedDirectiveOnThisLine; |
Chris Lattner | 66a740e | 2008-10-27 01:19:25 +0000 | [diff] [blame] | 91 | SrcMgr::CharacteristicKind FileType; |
Dylan Noblesmith | 2c1dd27 | 2012-02-05 02:13:05 +0000 | [diff] [blame] | 92 | SmallString<512> CurFilename; |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 93 | bool Initialized; |
Eli Friedman | 6af494b | 2009-05-19 03:06:47 +0000 | [diff] [blame] | 94 | bool DisableLineMarkers; |
| 95 | bool DumpDefines; |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 96 | bool DumpIncludeDirectives; |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 97 | bool UseLineDirectives; |
Daniel Dunbar | 5d38875 | 2012-11-16 01:51:11 +0000 | [diff] [blame] | 98 | bool IsFirstFileEntered; |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 99 | public: |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 100 | PrintPPOutputPPCallbacks(Preprocessor &pp, raw_ostream &os, bool lineMarkers, |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 101 | bool defines, bool DumpIncludeDirectives, |
| 102 | bool UseLineDirectives) |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 103 | : PP(pp), SM(PP.getSourceManager()), ConcatInfo(PP), OS(os), |
| 104 | DisableLineMarkers(lineMarkers), DumpDefines(defines), |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 105 | DumpIncludeDirectives(DumpIncludeDirectives), |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 106 | UseLineDirectives(UseLineDirectives) { |
Daniel Dunbar | 27734fd | 2011-02-02 15:41:17 +0000 | [diff] [blame] | 107 | CurLine = 0; |
Chris Lattner | 4c4a245 | 2007-07-24 06:57:14 +0000 | [diff] [blame] | 108 | CurFilename += "<uninit>"; |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 109 | EmittedTokensOnThisLine = false; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 110 | EmittedDirectiveOnThisLine = false; |
Chris Lattner | b03dc76 | 2008-09-26 21:18:42 +0000 | [diff] [blame] | 111 | FileType = SrcMgr::C_User; |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 112 | Initialized = false; |
Daniel Dunbar | 5d38875 | 2012-11-16 01:51:11 +0000 | [diff] [blame] | 113 | IsFirstFileEntered = false; |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 114 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 115 | |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 116 | void setEmittedTokensOnThisLine() { EmittedTokensOnThisLine = true; } |
Chris Lattner | 4418ce1 | 2007-07-23 06:09:34 +0000 | [diff] [blame] | 117 | bool hasEmittedTokensOnThisLine() const { return EmittedTokensOnThisLine; } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 118 | |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 119 | void setEmittedDirectiveOnThisLine() { EmittedDirectiveOnThisLine = true; } |
| 120 | bool hasEmittedDirectiveOnThisLine() const { |
| 121 | return EmittedDirectiveOnThisLine; |
| 122 | } |
| 123 | |
| 124 | bool startNewLineIfNeeded(bool ShouldUpdateCurrentLine = true); |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 125 | |
| 126 | void FileChanged(SourceLocation Loc, FileChangeReason Reason, |
| 127 | SrcMgr::CharacteristicKind FileType, |
| 128 | FileID PrevFID) override; |
| 129 | void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, |
| 130 | StringRef FileName, bool IsAngled, |
| 131 | CharSourceRange FilenameRange, const FileEntry *File, |
| 132 | StringRef SearchPath, StringRef RelativePath, |
Julie Hockett | 96fbe58 | 2018-05-10 19:05:36 +0000 | [diff] [blame] | 133 | const Module *Imported, |
| 134 | SrcMgr::CharacteristicKind FileType) override; |
Rafael Espindola | c0f18a9 | 2015-06-01 20:00:16 +0000 | [diff] [blame] | 135 | void Ident(SourceLocation Loc, StringRef str) override; |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 136 | void PragmaMessage(SourceLocation Loc, StringRef Namespace, |
| 137 | PragmaMessageKind Kind, StringRef Str) override; |
| 138 | void PragmaDebug(SourceLocation Loc, StringRef DebugType) override; |
| 139 | void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override; |
| 140 | void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override; |
| 141 | void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace, |
Alp Toker | c726c36 | 2014-06-10 09:31:37 +0000 | [diff] [blame] | 142 | diag::Severity Map, StringRef Str) override; |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 143 | void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, |
| 144 | ArrayRef<int> Ids) override; |
| 145 | void PragmaWarningPush(SourceLocation Loc, int Level) override; |
| 146 | void PragmaWarningPop(SourceLocation Loc) override; |
Eli Friedman | 16fee08 | 2017-09-27 23:29:37 +0000 | [diff] [blame] | 147 | void PragmaAssumeNonNullBegin(SourceLocation Loc) override; |
| 148 | void PragmaAssumeNonNullEnd(SourceLocation Loc) override; |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 149 | |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 150 | bool HandleFirstTokOnLine(Token &Tok); |
Hal Finkel | 2109f23 | 2013-01-28 04:37:37 +0000 | [diff] [blame] | 151 | |
| 152 | /// Move to the line of the provided source location. This will |
| 153 | /// return true if the output stream required adjustment or if |
| 154 | /// the requested location is on the first line. |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 155 | bool MoveToLine(SourceLocation Loc) { |
Douglas Gregor | 453b012 | 2010-11-12 07:15:47 +0000 | [diff] [blame] | 156 | PresumedLoc PLoc = SM.getPresumedLoc(Loc); |
| 157 | if (PLoc.isInvalid()) |
| 158 | return false; |
Hal Finkel | 2109f23 | 2013-01-28 04:37:37 +0000 | [diff] [blame] | 159 | return MoveToLine(PLoc.getLine()) || (PLoc.getLine() == 1); |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 160 | } |
| 161 | bool MoveToLine(unsigned LineNo); |
| 162 | |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 163 | bool AvoidConcat(const Token &PrevPrevTok, const Token &PrevTok, |
Chris Lattner | 0384e635 | 2010-04-14 03:57:19 +0000 | [diff] [blame] | 164 | const Token &Tok) { |
| 165 | return ConcatInfo.AvoidConcat(PrevPrevTok, PrevTok, Tok); |
Chris Lattner | 644d452 | 2009-02-13 00:46:04 +0000 | [diff] [blame] | 166 | } |
Craig Topper | 49a2790 | 2014-05-22 04:46:25 +0000 | [diff] [blame] | 167 | void WriteLineInfo(unsigned LineNo, const char *Extra=nullptr, |
| 168 | unsigned ExtraLen=0); |
Douglas Gregor | c7d6576 | 2010-09-09 22:45:38 +0000 | [diff] [blame] | 169 | bool LineMarkersAreDisabled() const { return DisableLineMarkers; } |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 170 | void HandleNewlinesInToken(const char *TokStr, unsigned Len); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 171 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 172 | /// MacroDefined - This hook is called whenever a macro definition is seen. |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 173 | void MacroDefined(const Token &MacroNameTok, |
| 174 | const MacroDirective *MD) override; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 175 | |
Benjamin Kramer | d05f31d | 2010-08-07 22:27:00 +0000 | [diff] [blame] | 176 | /// MacroUndefined - This hook is called whenever a macro #undef is seen. |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 177 | void MacroUndefined(const Token &MacroNameTok, |
Vedant Kumar | 349a624 | 2017-04-26 21:05:44 +0000 | [diff] [blame] | 178 | const MacroDefinition &MD, |
| 179 | const MacroDirective *Undef) override; |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 180 | |
| 181 | void BeginModule(const Module *M); |
| 182 | void EndModule(const Module *M); |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 183 | }; |
Chris Lattner | 2163265 | 2008-04-08 04:16:20 +0000 | [diff] [blame] | 184 | } // end anonymous namespace |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 185 | |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 186 | void PrintPPOutputPPCallbacks::WriteLineInfo(unsigned LineNo, |
| 187 | const char *Extra, |
| 188 | unsigned ExtraLen) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 189 | startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false); |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 190 | |
Chris Lattner | 76b4445 | 2009-12-07 01:42:56 +0000 | [diff] [blame] | 191 | // Emit #line directives or GNU line markers depending on what mode we're in. |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 192 | if (UseLineDirectives) { |
Chris Lattner | 76b4445 | 2009-12-07 01:42:56 +0000 | [diff] [blame] | 193 | OS << "#line" << ' ' << LineNo << ' ' << '"'; |
Eli Friedman | 80e45b8 | 2013-08-29 01:42:42 +0000 | [diff] [blame] | 194 | OS.write_escaped(CurFilename); |
Chris Lattner | 76b4445 | 2009-12-07 01:42:56 +0000 | [diff] [blame] | 195 | OS << '"'; |
| 196 | } else { |
| 197 | OS << '#' << ' ' << LineNo << ' ' << '"'; |
Eli Friedman | 80e45b8 | 2013-08-29 01:42:42 +0000 | [diff] [blame] | 198 | OS.write_escaped(CurFilename); |
Chris Lattner | 76b4445 | 2009-12-07 01:42:56 +0000 | [diff] [blame] | 199 | OS << '"'; |
Kovarththanan Rajaratnam | 752a124 | 2010-03-07 07:30:06 +0000 | [diff] [blame] | 200 | |
Steve Naroff | 66aaa39 | 2009-12-06 01:02:14 +0000 | [diff] [blame] | 201 | if (ExtraLen) |
| 202 | OS.write(Extra, ExtraLen); |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 203 | |
Steve Naroff | 66aaa39 | 2009-12-06 01:02:14 +0000 | [diff] [blame] | 204 | if (FileType == SrcMgr::C_System) |
| 205 | OS.write(" 3", 2); |
| 206 | else if (FileType == SrcMgr::C_ExternCSystem) |
| 207 | OS.write(" 3 4", 4); |
| 208 | } |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 209 | OS << '\n'; |
| 210 | } |
| 211 | |
Chris Lattner | 728b4dc | 2006-07-04 21:28:37 +0000 | [diff] [blame] | 212 | /// MoveToLine - Move the output to the source line specified by the location |
| 213 | /// object. We can do this by emitting some number of \n's, or be emitting a |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 214 | /// #line directive. This returns false if already at the specified line, true |
| 215 | /// if some newlines were emitted. |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 216 | bool PrintPPOutputPPCallbacks::MoveToLine(unsigned LineNo) { |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 217 | // If this line is "close enough" to the original line, just print newlines, |
| 218 | // otherwise print a #line directive. |
Daniel Dunbar | e778131 | 2008-09-26 01:13:35 +0000 | [diff] [blame] | 219 | if (LineNo-CurLine <= 8) { |
Chris Lattner | 5f07582 | 2007-07-23 05:14:05 +0000 | [diff] [blame] | 220 | if (LineNo-CurLine == 1) |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 221 | OS << '\n'; |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 222 | else if (LineNo == CurLine) |
Chandler Carruth | 46a32c2 | 2011-07-14 16:14:52 +0000 | [diff] [blame] | 223 | return false; // Spelling line moved, but expansion line didn't. |
Chris Lattner | 5f07582 | 2007-07-23 05:14:05 +0000 | [diff] [blame] | 224 | else { |
| 225 | const char *NewLines = "\n\n\n\n\n\n\n\n"; |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 226 | OS.write(NewLines, LineNo-CurLine); |
Chris Lattner | 5f07582 | 2007-07-23 05:14:05 +0000 | [diff] [blame] | 227 | } |
Chris Lattner | bc6bcab | 2010-06-12 16:20:56 +0000 | [diff] [blame] | 228 | } else if (!DisableLineMarkers) { |
| 229 | // Emit a #line or line marker. |
Craig Topper | 49a2790 | 2014-05-22 04:46:25 +0000 | [diff] [blame] | 230 | WriteLineInfo(LineNo, nullptr, 0); |
Chris Lattner | bc6bcab | 2010-06-12 16:20:56 +0000 | [diff] [blame] | 231 | } else { |
| 232 | // Okay, we're in -P mode, which turns off line markers. However, we still |
| 233 | // need to emit a newline between tokens on different lines. |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 234 | startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 235 | } |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 236 | |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 237 | CurLine = LineNo; |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 238 | return true; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 239 | } |
| 240 | |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 241 | bool |
| 242 | PrintPPOutputPPCallbacks::startNewLineIfNeeded(bool ShouldUpdateCurrentLine) { |
| 243 | if (EmittedTokensOnThisLine || EmittedDirectiveOnThisLine) { |
Douglas Gregor | c7d6576 | 2010-09-09 22:45:38 +0000 | [diff] [blame] | 244 | OS << '\n'; |
| 245 | EmittedTokensOnThisLine = false; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 246 | EmittedDirectiveOnThisLine = false; |
| 247 | if (ShouldUpdateCurrentLine) |
| 248 | ++CurLine; |
Douglas Gregor | c7d6576 | 2010-09-09 22:45:38 +0000 | [diff] [blame] | 249 | return true; |
| 250 | } |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 251 | |
Douglas Gregor | c7d6576 | 2010-09-09 22:45:38 +0000 | [diff] [blame] | 252 | return false; |
| 253 | } |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 254 | |
| 255 | /// FileChanged - Whenever the preprocessor enters or exits a #include file |
| 256 | /// it invokes this handler. Update our conception of the current source |
| 257 | /// position. |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 258 | void PrintPPOutputPPCallbacks::FileChanged(SourceLocation Loc, |
| 259 | FileChangeReason Reason, |
Argyrios Kyrtzidis | 7a70d2f | 2011-10-11 17:29:44 +0000 | [diff] [blame] | 260 | SrcMgr::CharacteristicKind NewFileType, |
| 261 | FileID PrevFID) { |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 262 | // Unless we are exiting a #include, make sure to skip ahead to the line the |
| 263 | // #include directive was at. |
Chris Lattner | 9d94f04 | 2010-04-13 00:06:42 +0000 | [diff] [blame] | 264 | SourceManager &SourceMgr = SM; |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 265 | |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 266 | PresumedLoc UserLoc = SourceMgr.getPresumedLoc(Loc); |
Douglas Gregor | 453b012 | 2010-11-12 07:15:47 +0000 | [diff] [blame] | 267 | if (UserLoc.isInvalid()) |
| 268 | return; |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 269 | |
Chris Lattner | c745cec | 2010-04-14 04:28:50 +0000 | [diff] [blame] | 270 | unsigned NewLine = UserLoc.getLine(); |
Daniel Dunbar | d435275 | 2010-08-24 22:44:13 +0000 | [diff] [blame] | 271 | |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 272 | if (Reason == PPCallbacks::EnterFile) { |
Douglas Gregor | 453b012 | 2010-11-12 07:15:47 +0000 | [diff] [blame] | 273 | SourceLocation IncludeLoc = UserLoc.getIncludeLoc(); |
Chris Lattner | d8cc884 | 2009-01-30 18:44:17 +0000 | [diff] [blame] | 274 | if (IncludeLoc.isValid()) |
| 275 | MoveToLine(IncludeLoc); |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 276 | } else if (Reason == PPCallbacks::SystemHeaderPragma) { |
Jordan Rose | 111c4a6 | 2013-04-17 19:09:18 +0000 | [diff] [blame] | 277 | // GCC emits the # directive for this directive on the line AFTER the |
| 278 | // directive and emits a bunch of spaces that aren't needed. This is because |
| 279 | // otherwise we will emit a line marker for THIS line, which requires an |
| 280 | // extra blank line after the directive to avoid making all following lines |
| 281 | // off by one. We can do better by simply incrementing NewLine here. |
| 282 | NewLine += 1; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 283 | } |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 284 | |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 285 | CurLine = NewLine; |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 286 | |
Chris Lattner | 4c4a245 | 2007-07-24 06:57:14 +0000 | [diff] [blame] | 287 | CurFilename.clear(); |
Chris Lattner | 5dbefc6 | 2010-04-13 00:01:41 +0000 | [diff] [blame] | 288 | CurFilename += UserLoc.getFilename(); |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 289 | FileType = NewFileType; |
| 290 | |
Eli Friedman | c52435b | 2013-01-09 03:16:42 +0000 | [diff] [blame] | 291 | if (DisableLineMarkers) { |
| 292 | startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false); |
| 293 | return; |
| 294 | } |
Fangrui Song | 6907ce2 | 2018-07-30 19:24:48 +0000 | [diff] [blame] | 295 | |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 296 | if (!Initialized) { |
| 297 | WriteLineInfo(CurLine); |
| 298 | Initialized = true; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 299 | } |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 300 | |
Daniel Dunbar | 5d38875 | 2012-11-16 01:51:11 +0000 | [diff] [blame] | 301 | // 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 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 310 | switch (Reason) { |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 311 | case PPCallbacks::EnterFile: |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 312 | WriteLineInfo(CurLine, " 1", 2); |
Chris Lattner | 3338ba8 | 2006-07-04 21:19:39 +0000 | [diff] [blame] | 313 | break; |
Chris Lattner | b8d6d5a | 2006-11-21 04:09:30 +0000 | [diff] [blame] | 314 | case PPCallbacks::ExitFile: |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 315 | WriteLineInfo(CurLine, " 2", 2); |
Chris Lattner | 3338ba8 | 2006-07-04 21:19:39 +0000 | [diff] [blame] | 316 | break; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 317 | case PPCallbacks::SystemHeaderPragma: |
| 318 | case PPCallbacks::RenameFile: |
Daniel Dunbar | 98e0e53 | 2008-09-05 03:22:57 +0000 | [diff] [blame] | 319 | WriteLineInfo(CurLine); |
| 320 | break; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 321 | } |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 322 | } |
| 323 | |
Julie Hockett | 96fbe58 | 2018-05-10 19:05:36 +0000 | [diff] [blame] | 324 | void PrintPPOutputPPCallbacks::InclusionDirective( |
| 325 | SourceLocation HashLoc, |
| 326 | const Token &IncludeTok, |
| 327 | StringRef FileName, |
| 328 | bool IsAngled, |
| 329 | CharSourceRange FilenameRange, |
| 330 | const FileEntry *File, |
| 331 | StringRef SearchPath, |
| 332 | StringRef RelativePath, |
| 333 | const Module *Imported, |
| 334 | SrcMgr::CharacteristicKind FileType) { |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 335 | // In -dI mode, dump #include directives prior to dumping their content or |
| 336 | // interpretation. |
| 337 | if (DumpIncludeDirectives) { |
Argyrios Kyrtzidis | a6444b1 | 2013-04-10 01:53:46 +0000 | [diff] [blame] | 338 | startNewLineIfNeeded(); |
| 339 | MoveToLine(HashLoc); |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 340 | const std::string TokenText = PP.getSpelling(IncludeTok); |
| 341 | assert(!TokenText.empty()); |
| 342 | OS << "#" << TokenText << " " |
| 343 | << (IsAngled ? '<' : '"') << FileName << (IsAngled ? '>' : '"') |
| 344 | << " /* clang -E -dI */"; |
| 345 | setEmittedDirectiveOnThisLine(); |
Ben Langmuir | 5418f40 | 2014-09-10 21:29:41 +0000 | [diff] [blame] | 346 | startNewLineIfNeeded(); |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 347 | } |
| 348 | |
| 349 | // When preprocessing, turn implicit imports into module import pragmas. |
| 350 | if (Imported) { |
| 351 | switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) { |
| 352 | case tok::pp_include: |
| 353 | case tok::pp_import: |
| 354 | case tok::pp_include_next: |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 355 | startNewLineIfNeeded(); |
| 356 | MoveToLine(HashLoc); |
Richard Smith | 9565c75b | 2017-06-19 23:09:36 +0000 | [diff] [blame] | 357 | OS << "#pragma clang module import " << Imported->getFullModuleName(true) |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 358 | << " /* clang -E: implicit import for " |
| 359 | << "#" << PP.getSpelling(IncludeTok) << " " |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 360 | << (IsAngled ? '<' : '"') << FileName << (IsAngled ? '>' : '"') |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 361 | << " */"; |
| 362 | // Since we want a newline after the pragma, but not a #<line>, start a |
| 363 | // new line immediately. |
| 364 | EmittedTokensOnThisLine = true; |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 365 | startNewLineIfNeeded(); |
Richard Smith | c51c38b | 2017-04-29 00:34:47 +0000 | [diff] [blame] | 366 | break; |
| 367 | |
| 368 | case tok::pp___include_macros: |
| 369 | // #__include_macros has no effect on a user of a preprocessed source |
| 370 | // file; the only effect is on preprocessing. |
| 371 | // |
| 372 | // FIXME: That's not *quite* true: it causes the module in question to |
| 373 | // be loaded, which can affect downstream diagnostics. |
| 374 | break; |
| 375 | |
| 376 | default: |
| 377 | llvm_unreachable("unknown include directive kind"); |
| 378 | break; |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 379 | } |
Argyrios Kyrtzidis | a6444b1 | 2013-04-10 01:53:46 +0000 | [diff] [blame] | 380 | } |
| 381 | } |
| 382 | |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 383 | /// Handle entering the scope of a module during a module compilation. |
| 384 | void PrintPPOutputPPCallbacks::BeginModule(const Module *M) { |
| 385 | startNewLineIfNeeded(); |
Richard Smith | 9565c75b | 2017-06-19 23:09:36 +0000 | [diff] [blame] | 386 | OS << "#pragma clang module begin " << M->getFullModuleName(true); |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 387 | setEmittedDirectiveOnThisLine(); |
| 388 | } |
| 389 | |
| 390 | /// Handle leaving the scope of a module during a module compilation. |
| 391 | void PrintPPOutputPPCallbacks::EndModule(const Module *M) { |
| 392 | startNewLineIfNeeded(); |
Richard Smith | 9565c75b | 2017-06-19 23:09:36 +0000 | [diff] [blame] | 393 | OS << "#pragma clang module end /*" << M->getFullModuleName(true) << "*/"; |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 394 | setEmittedDirectiveOnThisLine(); |
| 395 | } |
| 396 | |
Chris Lattner | 5eef507 | 2009-01-16 19:25:54 +0000 | [diff] [blame] | 397 | /// Ident - Handle #ident directives when read by the preprocessor. |
Chris Lattner | 728b4dc | 2006-07-04 21:28:37 +0000 | [diff] [blame] | 398 | /// |
Rafael Espindola | c0f18a9 | 2015-06-01 20:00:16 +0000 | [diff] [blame] | 399 | void PrintPPOutputPPCallbacks::Ident(SourceLocation Loc, StringRef S) { |
Chris Lattner | 3338ba8 | 2006-07-04 21:19:39 +0000 | [diff] [blame] | 400 | MoveToLine(Loc); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 401 | |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 402 | OS.write("#ident ", strlen("#ident ")); |
Rafael Espindola | c0f18a9 | 2015-06-01 20:00:16 +0000 | [diff] [blame] | 403 | OS.write(S.begin(), S.size()); |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 404 | EmittedTokensOnThisLine = true; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 405 | } |
| 406 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 407 | /// MacroDefined - This hook is called whenever a macro definition is seen. |
Craig Silverstein | 1a9ca21 | 2010-11-19 21:33:15 +0000 | [diff] [blame] | 408 | void PrintPPOutputPPCallbacks::MacroDefined(const Token &MacroNameTok, |
Argyrios Kyrtzidis | fead64b | 2013-02-24 00:05:14 +0000 | [diff] [blame] | 409 | const MacroDirective *MD) { |
Argyrios Kyrtzidis | b6210df | 2013-03-26 17:17:01 +0000 | [diff] [blame] | 410 | const MacroInfo *MI = MD->getMacroInfo(); |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 411 | // Only print out macro definitions in -dD mode. |
| 412 | if (!DumpDefines || |
| 413 | // Ignore __FILE__ etc. |
| 414 | MI->isBuiltinMacro()) return; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 415 | |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 416 | MoveToLine(MI->getDefinitionLoc()); |
Craig Silverstein | 1a9ca21 | 2010-11-19 21:33:15 +0000 | [diff] [blame] | 417 | PrintMacroDefinition(*MacroNameTok.getIdentifierInfo(), *MI, PP, OS); |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 418 | setEmittedDirectiveOnThisLine(); |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 419 | } |
| 420 | |
Craig Silverstein | 1a9ca21 | 2010-11-19 21:33:15 +0000 | [diff] [blame] | 421 | void PrintPPOutputPPCallbacks::MacroUndefined(const Token &MacroNameTok, |
Vedant Kumar | 349a624 | 2017-04-26 21:05:44 +0000 | [diff] [blame] | 422 | const MacroDefinition &MD, |
| 423 | const MacroDirective *Undef) { |
Benjamin Kramer | d05f31d | 2010-08-07 22:27:00 +0000 | [diff] [blame] | 424 | // Only print out macro definitions in -dD mode. |
| 425 | if (!DumpDefines) return; |
| 426 | |
Craig Silverstein | 1a9ca21 | 2010-11-19 21:33:15 +0000 | [diff] [blame] | 427 | MoveToLine(MacroNameTok.getLocation()); |
| 428 | OS << "#undef " << MacroNameTok.getIdentifierInfo()->getName(); |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 429 | setEmittedDirectiveOnThisLine(); |
Benjamin Kramer | d05f31d | 2010-08-07 22:27:00 +0000 | [diff] [blame] | 430 | } |
Chris Lattner | cac63f3 | 2009-04-12 01:56:53 +0000 | [diff] [blame] | 431 | |
Benjamin Kramer | 0772c42 | 2016-02-13 13:42:54 +0000 | [diff] [blame] | 432 | static void outputPrintable(raw_ostream &OS, StringRef Str) { |
| 433 | for (unsigned char Char : Str) { |
| 434 | if (isPrintable(Char) && Char != '\\' && Char != '"') |
| 435 | OS << (char)Char; |
| 436 | else // Output anything hard as an octal escape. |
| 437 | OS << '\\' |
| 438 | << (char)('0' + ((Char >> 6) & 7)) |
| 439 | << (char)('0' + ((Char >> 3) & 7)) |
| 440 | << (char)('0' + ((Char >> 0) & 7)); |
| 441 | } |
Aaron Ballman | 5d041be | 2013-06-04 02:07:14 +0000 | [diff] [blame] | 442 | } |
| 443 | |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 444 | void PrintPPOutputPPCallbacks::PragmaMessage(SourceLocation Loc, |
Andy Gibbs | 9c2ccd6 | 2013-04-17 16:16:16 +0000 | [diff] [blame] | 445 | StringRef Namespace, |
| 446 | PragmaMessageKind Kind, |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 447 | StringRef Str) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 448 | startNewLineIfNeeded(); |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 449 | MoveToLine(Loc); |
Andy Gibbs | 9c2ccd6 | 2013-04-17 16:16:16 +0000 | [diff] [blame] | 450 | OS << "#pragma "; |
| 451 | if (!Namespace.empty()) |
| 452 | OS << Namespace << ' '; |
| 453 | switch (Kind) { |
| 454 | case PMK_Message: |
Andy Gibbs | aa0b94a | 2013-04-19 17:13:17 +0000 | [diff] [blame] | 455 | OS << "message(\""; |
Andy Gibbs | 9c2ccd6 | 2013-04-17 16:16:16 +0000 | [diff] [blame] | 456 | break; |
| 457 | case PMK_Warning: |
Andy Gibbs | 96d9390 | 2013-04-18 16:49:37 +0000 | [diff] [blame] | 458 | OS << "warning \""; |
Andy Gibbs | 9c2ccd6 | 2013-04-17 16:16:16 +0000 | [diff] [blame] | 459 | break; |
| 460 | case PMK_Error: |
Andy Gibbs | 96d9390 | 2013-04-18 16:49:37 +0000 | [diff] [blame] | 461 | OS << "error \""; |
Andy Gibbs | 9c2ccd6 | 2013-04-17 16:16:16 +0000 | [diff] [blame] | 462 | break; |
| 463 | } |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 464 | |
Aaron Ballman | 5d041be | 2013-06-04 02:07:14 +0000 | [diff] [blame] | 465 | outputPrintable(OS, Str); |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 466 | OS << '"'; |
Andy Gibbs | aa0b94a | 2013-04-19 17:13:17 +0000 | [diff] [blame] | 467 | if (Kind == PMK_Message) |
| 468 | OS << ')'; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 469 | setEmittedDirectiveOnThisLine(); |
Chris Lattner | 30c924b | 2010-06-26 17:11:39 +0000 | [diff] [blame] | 470 | } |
| 471 | |
Tareq A. Siraj | 0de0dd4 | 2013-04-16 18:41:26 +0000 | [diff] [blame] | 472 | void PrintPPOutputPPCallbacks::PragmaDebug(SourceLocation Loc, |
| 473 | StringRef DebugType) { |
| 474 | startNewLineIfNeeded(); |
| 475 | MoveToLine(Loc); |
| 476 | |
| 477 | OS << "#pragma clang __debug "; |
| 478 | OS << DebugType; |
| 479 | |
| 480 | setEmittedDirectiveOnThisLine(); |
| 481 | } |
| 482 | |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 483 | void PrintPPOutputPPCallbacks:: |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 484 | PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 485 | startNewLineIfNeeded(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 486 | MoveToLine(Loc); |
| 487 | OS << "#pragma " << Namespace << " diagnostic push"; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 488 | setEmittedDirectiveOnThisLine(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 489 | } |
| 490 | |
| 491 | void PrintPPOutputPPCallbacks:: |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 492 | PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 493 | startNewLineIfNeeded(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 494 | MoveToLine(Loc); |
| 495 | OS << "#pragma " << Namespace << " diagnostic pop"; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 496 | setEmittedDirectiveOnThisLine(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 497 | } |
| 498 | |
Alp Toker | c726c36 | 2014-06-10 09:31:37 +0000 | [diff] [blame] | 499 | void PrintPPOutputPPCallbacks::PragmaDiagnostic(SourceLocation Loc, |
| 500 | StringRef Namespace, |
| 501 | diag::Severity Map, |
| 502 | StringRef Str) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 503 | startNewLineIfNeeded(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 504 | MoveToLine(Loc); |
| 505 | OS << "#pragma " << Namespace << " diagnostic "; |
Benjamin Kramer | 7ec12c9 | 2012-02-07 22:29:24 +0000 | [diff] [blame] | 506 | switch (Map) { |
Alp Toker | 46df1c0 | 2014-06-12 10:15:20 +0000 | [diff] [blame] | 507 | case diag::Severity::Remark: |
Tobias Grosser | 7416024 | 2014-02-28 09:11:08 +0000 | [diff] [blame] | 508 | OS << "remark"; |
| 509 | break; |
Alp Toker | 46df1c0 | 2014-06-12 10:15:20 +0000 | [diff] [blame] | 510 | case diag::Severity::Warning: |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 511 | OS << "warning"; |
| 512 | break; |
Alp Toker | 46df1c0 | 2014-06-12 10:15:20 +0000 | [diff] [blame] | 513 | case diag::Severity::Error: |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 514 | OS << "error"; |
| 515 | break; |
Alp Toker | 46df1c0 | 2014-06-12 10:15:20 +0000 | [diff] [blame] | 516 | case diag::Severity::Ignored: |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 517 | OS << "ignored"; |
| 518 | break; |
Alp Toker | 46df1c0 | 2014-06-12 10:15:20 +0000 | [diff] [blame] | 519 | case diag::Severity::Fatal: |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 520 | OS << "fatal"; |
| 521 | break; |
| 522 | } |
| 523 | OS << " \"" << Str << '"'; |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 524 | setEmittedDirectiveOnThisLine(); |
Douglas Gregor | 3bde9b1 | 2011-06-22 19:41:48 +0000 | [diff] [blame] | 525 | } |
Chris Lattner | 5eef507 | 2009-01-16 19:25:54 +0000 | [diff] [blame] | 526 | |
Reid Kleckner | 881dff3 | 2013-09-13 22:00:30 +0000 | [diff] [blame] | 527 | void PrintPPOutputPPCallbacks::PragmaWarning(SourceLocation Loc, |
| 528 | StringRef WarningSpec, |
| 529 | ArrayRef<int> Ids) { |
| 530 | startNewLineIfNeeded(); |
| 531 | MoveToLine(Loc); |
| 532 | OS << "#pragma warning(" << WarningSpec << ':'; |
| 533 | for (ArrayRef<int>::iterator I = Ids.begin(), E = Ids.end(); I != E; ++I) |
| 534 | OS << ' ' << *I; |
| 535 | OS << ')'; |
| 536 | setEmittedDirectiveOnThisLine(); |
| 537 | } |
| 538 | |
| 539 | void PrintPPOutputPPCallbacks::PragmaWarningPush(SourceLocation Loc, |
| 540 | int Level) { |
| 541 | startNewLineIfNeeded(); |
| 542 | MoveToLine(Loc); |
| 543 | OS << "#pragma warning(push"; |
Reid Kleckner | 4d18510 | 2013-10-02 15:19:23 +0000 | [diff] [blame] | 544 | if (Level >= 0) |
Reid Kleckner | 881dff3 | 2013-09-13 22:00:30 +0000 | [diff] [blame] | 545 | OS << ", " << Level; |
| 546 | OS << ')'; |
| 547 | setEmittedDirectiveOnThisLine(); |
| 548 | } |
| 549 | |
| 550 | void PrintPPOutputPPCallbacks::PragmaWarningPop(SourceLocation Loc) { |
| 551 | startNewLineIfNeeded(); |
| 552 | MoveToLine(Loc); |
| 553 | OS << "#pragma warning(pop)"; |
| 554 | setEmittedDirectiveOnThisLine(); |
| 555 | } |
| 556 | |
Eli Friedman | 16fee08 | 2017-09-27 23:29:37 +0000 | [diff] [blame] | 557 | void PrintPPOutputPPCallbacks:: |
| 558 | PragmaAssumeNonNullBegin(SourceLocation Loc) { |
| 559 | startNewLineIfNeeded(); |
| 560 | MoveToLine(Loc); |
| 561 | OS << "#pragma clang assume_nonnull begin"; |
| 562 | setEmittedDirectiveOnThisLine(); |
| 563 | } |
| 564 | |
| 565 | void PrintPPOutputPPCallbacks:: |
| 566 | PragmaAssumeNonNullEnd(SourceLocation Loc) { |
| 567 | startNewLineIfNeeded(); |
| 568 | MoveToLine(Loc); |
| 569 | OS << "#pragma clang assume_nonnull end"; |
| 570 | setEmittedDirectiveOnThisLine(); |
| 571 | } |
| 572 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 573 | /// HandleFirstTokOnLine - When emitting a preprocessed file in -E mode, this |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 574 | /// is called for the first token on each new line. If this really is the start |
| 575 | /// of a new logical line, handle it and return true, otherwise return false. |
| 576 | /// This may not be the start of a logical line because the "start of line" |
Chandler Carruth | 46a32c2 | 2011-07-14 16:14:52 +0000 | [diff] [blame] | 577 | /// marker is set for spelling lines, not expansion ones. |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 578 | bool PrintPPOutputPPCallbacks::HandleFirstTokOnLine(Token &Tok) { |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 579 | // Figure out what line we went to and insert the appropriate number of |
| 580 | // newline characters. |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 581 | if (!MoveToLine(Tok.getLocation())) |
| 582 | return false; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 583 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 584 | // Print out space characters so that the first token on a line is |
| 585 | // indented for easy reading. |
Chandler Carruth | 42f35f9 | 2011-07-25 20:57:57 +0000 | [diff] [blame] | 586 | unsigned ColNo = SM.getExpansionColumnNumber(Tok.getLocation()); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 587 | |
Richard Smith | 5b2f7c5 | 2014-02-24 20:50:36 +0000 | [diff] [blame] | 588 | // The first token on a line can have a column number of 1, yet still expect |
| 589 | // leading white space, if a macro expansion in column 1 starts with an empty |
| 590 | // macro argument, or an empty nested macro expansion. In this case, move the |
| 591 | // token to column 2. |
| 592 | if (ColNo == 1 && Tok.hasLeadingSpace()) |
| 593 | ColNo = 2; |
| 594 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 595 | // This hack prevents stuff like: |
| 596 | // #define HASH # |
| 597 | // HASH define foo bar |
| 598 | // From having the # character end up at column 1, which makes it so it |
| 599 | // is not handled as a #define next time through the preprocessor if in |
| 600 | // -fpreprocessed mode. |
Chris Lattner | 3c69f12 | 2007-10-09 18:03:42 +0000 | [diff] [blame] | 601 | if (ColNo <= 1 && Tok.is(tok::hash)) |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 602 | OS << ' '; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 603 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 604 | // Otherwise, indent the appropriate number of spaces. |
| 605 | for (; ColNo > 1; --ColNo) |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 606 | OS << ' '; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 607 | |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 608 | return true; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 609 | } |
| 610 | |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 611 | void PrintPPOutputPPCallbacks::HandleNewlinesInToken(const char *TokStr, |
| 612 | unsigned Len) { |
| 613 | unsigned NumNewlines = 0; |
| 614 | for (; Len; --Len, ++TokStr) { |
| 615 | if (*TokStr != '\n' && |
| 616 | *TokStr != '\r') |
| 617 | continue; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 618 | |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 619 | ++NumNewlines; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 620 | |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 621 | // If we have \n\r or \r\n, skip both and count as one line. |
| 622 | if (Len != 1 && |
| 623 | (TokStr[1] == '\n' || TokStr[1] == '\r') && |
Richard Trieu | cc3949d | 2016-02-18 22:34:54 +0000 | [diff] [blame] | 624 | TokStr[0] != TokStr[1]) { |
| 625 | ++TokStr; |
| 626 | --Len; |
| 627 | } |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 628 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 629 | |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 630 | if (NumNewlines == 0) return; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 631 | |
Chris Lattner | a5e6775 | 2009-06-15 04:08:28 +0000 | [diff] [blame] | 632 | CurLine += NumNewlines; |
Chris Lattner | f2d49da9 | 2009-06-15 01:25:23 +0000 | [diff] [blame] | 633 | } |
| 634 | |
| 635 | |
Chris Lattner | 5de858c | 2006-07-04 19:04:44 +0000 | [diff] [blame] | 636 | namespace { |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 637 | struct UnknownPragmaHandler : public PragmaHandler { |
| 638 | const char *Prefix; |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 639 | PrintPPOutputPPCallbacks *Callbacks; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 640 | |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 641 | // Set to true if tokens should be expanded |
| 642 | bool ShouldExpandTokens; |
| 643 | |
| 644 | UnknownPragmaHandler(const char *prefix, PrintPPOutputPPCallbacks *callbacks, |
| 645 | bool RequireTokenExpansion) |
| 646 | : Prefix(prefix), Callbacks(callbacks), |
| 647 | ShouldExpandTokens(RequireTokenExpansion) {} |
Craig Topper | afa7cb3 | 2014-03-13 06:07:04 +0000 | [diff] [blame] | 648 | void HandlePragma(Preprocessor &PP, PragmaIntroducerKind Introducer, |
| 649 | Token &PragmaTok) override { |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 650 | // Figure out what line we went to and insert the appropriate number of |
| 651 | // newline characters. |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 652 | Callbacks->startNewLineIfNeeded(); |
Chris Lattner | 87f267e | 2006-11-21 05:02:33 +0000 | [diff] [blame] | 653 | Callbacks->MoveToLine(PragmaTok.getLocation()); |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 654 | Callbacks->OS.write(Prefix, strlen(Prefix)); |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 655 | |
Alexey Bataev | 56f5ad1 | 2016-02-09 11:01:58 +0000 | [diff] [blame] | 656 | if (ShouldExpandTokens) { |
| 657 | // The first token does not have expanded macros. Expand them, if |
| 658 | // required. |
David Blaikie | 2eabcc9 | 2016-02-09 18:52:09 +0000 | [diff] [blame] | 659 | auto Toks = llvm::make_unique<Token[]>(1); |
Alexey Bataev | 56f5ad1 | 2016-02-09 11:01:58 +0000 | [diff] [blame] | 660 | Toks[0] = PragmaTok; |
David Blaikie | 2eabcc9 | 2016-02-09 18:52:09 +0000 | [diff] [blame] | 661 | PP.EnterTokenStream(std::move(Toks), /*NumToks=*/1, |
| 662 | /*DisableMacroExpansion=*/false); |
Alexey Bataev | 56f5ad1 | 2016-02-09 11:01:58 +0000 | [diff] [blame] | 663 | PP.Lex(PragmaTok); |
| 664 | } |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 665 | Token PrevToken; |
| 666 | Token PrevPrevToken; |
| 667 | PrevToken.startToken(); |
| 668 | PrevPrevToken.startToken(); |
| 669 | |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 670 | // Read and print all of the pragma tokens. |
Peter Collingbourne | 2f1e36b | 2011-02-28 02:37:51 +0000 | [diff] [blame] | 671 | while (PragmaTok.isNot(tok::eod)) { |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 672 | if (PragmaTok.hasLeadingSpace() || |
| 673 | Callbacks->AvoidConcat(PrevPrevToken, PrevToken, PragmaTok)) |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 674 | Callbacks->OS << ' '; |
Chris Lattner | f46be6c | 2006-07-04 22:19:33 +0000 | [diff] [blame] | 675 | std::string TokSpell = PP.getSpelling(PragmaTok); |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 676 | Callbacks->OS.write(&TokSpell[0], TokSpell.size()); |
Reid Kleckner | 0e73ec4 | 2014-02-20 22:59:51 +0000 | [diff] [blame] | 677 | |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 678 | PrevPrevToken = PrevToken; |
| 679 | PrevToken = PragmaTok; |
| 680 | |
| 681 | if (ShouldExpandTokens) |
Reid Kleckner | 0e73ec4 | 2014-02-20 22:59:51 +0000 | [diff] [blame] | 682 | PP.Lex(PragmaTok); |
| 683 | else |
| 684 | PP.LexUnexpandedToken(PragmaTok); |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 685 | } |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 686 | Callbacks->setEmittedDirectiveOnThisLine(); |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 687 | } |
| 688 | }; |
Chris Lattner | 5de858c | 2006-07-04 19:04:44 +0000 | [diff] [blame] | 689 | } // end anonymous namespace |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 690 | |
Chris Lattner | 4418ce1 | 2007-07-23 06:09:34 +0000 | [diff] [blame] | 691 | |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 692 | static void PrintPreprocessedTokens(Preprocessor &PP, Token &Tok, |
| 693 | PrintPPOutputPPCallbacks *Callbacks, |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 694 | raw_ostream &OS) { |
Jordan Rose | 67b6623 | 2013-03-05 23:54:55 +0000 | [diff] [blame] | 695 | bool DropComments = PP.getLangOpts().TraditionalCPP && |
| 696 | !PP.getCommentRetentionState(); |
| 697 | |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 698 | char Buffer[256]; |
Chris Lattner | bba37f4 | 2010-06-15 21:06:38 +0000 | [diff] [blame] | 699 | Token PrevPrevTok, PrevTok; |
| 700 | PrevPrevTok.startToken(); |
| 701 | PrevTok.startToken(); |
Chris Lattner | 3ff2e69 | 2007-10-10 20:45:16 +0000 | [diff] [blame] | 702 | while (1) { |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 703 | if (Callbacks->hasEmittedDirectiveOnThisLine()) { |
| 704 | Callbacks->startNewLineIfNeeded(); |
| 705 | Callbacks->MoveToLine(Tok.getLocation()); |
| 706 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 707 | |
Chris Lattner | 67c3848 | 2006-07-04 23:24:26 +0000 | [diff] [blame] | 708 | // If this token is at the start of a line, emit newlines if needed. |
Chris Lattner | 3ed83c1 | 2007-12-09 21:11:08 +0000 | [diff] [blame] | 709 | if (Tok.isAtStartOfLine() && Callbacks->HandleFirstTokOnLine(Tok)) { |
| 710 | // done. |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 711 | } else if (Tok.hasLeadingSpace() || |
Chris Lattner | 4418ce1 | 2007-07-23 06:09:34 +0000 | [diff] [blame] | 712 | // If we haven't emitted a token on this line yet, PrevTok isn't |
| 713 | // useful to look at and no concatenation could happen anyway. |
Chris Lattner | d63c8a5 | 2007-07-23 23:21:34 +0000 | [diff] [blame] | 714 | (Callbacks->hasEmittedTokensOnThisLine() && |
Chris Lattner | 4418ce1 | 2007-07-23 06:09:34 +0000 | [diff] [blame] | 715 | // Don't print "-" next to "-", it would form "--". |
Chris Lattner | 0384e635 | 2010-04-14 03:57:19 +0000 | [diff] [blame] | 716 | Callbacks->AvoidConcat(PrevPrevTok, PrevTok, Tok))) { |
Chris Lattner | 068529a | 2008-08-17 03:12:02 +0000 | [diff] [blame] | 717 | OS << ' '; |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 718 | } |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 719 | |
Jordan Rose | 67b6623 | 2013-03-05 23:54:55 +0000 | [diff] [blame] | 720 | if (DropComments && Tok.is(tok::comment)) { |
| 721 | // Skip comments. Normally the preprocessor does not generate |
| 722 | // tok::comment nodes at all when not keeping comments, but under |
| 723 | // -traditional-cpp the lexer keeps /all/ whitespace, including comments. |
| 724 | SourceLocation StartLoc = Tok.getLocation(); |
| 725 | Callbacks->MoveToLine(StartLoc.getLocWithOffset(Tok.getLength())); |
Reid Kleckner | 400a64e | 2017-10-16 23:07:15 +0000 | [diff] [blame] | 726 | } else if (Tok.is(tok::eod)) { |
| 727 | // Don't print end of directive tokens, since they are typically newlines |
| 728 | // that mess up our line tracking. These come from unknown pre-processor |
| 729 | // directives or hash-prefixed comments in standalone assembly files. |
| 730 | PP.Lex(Tok); |
| 731 | continue; |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 732 | } else if (Tok.is(tok::annot_module_include)) { |
Ben Langmuir | 5eb7cb7 | 2014-01-30 21:50:18 +0000 | [diff] [blame] | 733 | // PrintPPOutputPPCallbacks::InclusionDirective handles producing |
| 734 | // appropriate output here. Ignore this token entirely. |
Richard Smith | ce587f5 | 2013-11-15 04:24:58 +0000 | [diff] [blame] | 735 | PP.Lex(Tok); |
| 736 | continue; |
Richard Smith | d138630 | 2017-05-04 00:29:54 +0000 | [diff] [blame] | 737 | } else if (Tok.is(tok::annot_module_begin)) { |
| 738 | // FIXME: We retrieve this token after the FileChanged callback, and |
| 739 | // retrieve the module_end token before the FileChanged callback, so |
| 740 | // we render this within the file and render the module end outside the |
| 741 | // file, but this is backwards from the token locations: the module_begin |
| 742 | // token is at the include location (outside the file) and the module_end |
| 743 | // token is at the EOF location (within the file). |
| 744 | Callbacks->BeginModule( |
| 745 | reinterpret_cast<Module *>(Tok.getAnnotationValue())); |
| 746 | PP.Lex(Tok); |
| 747 | continue; |
| 748 | } else if (Tok.is(tok::annot_module_end)) { |
| 749 | Callbacks->EndModule( |
| 750 | reinterpret_cast<Module *>(Tok.getAnnotationValue())); |
| 751 | PP.Lex(Tok); |
| 752 | continue; |
David Blaikie | 1013fe7 | 2018-11-15 03:04:21 +0000 | [diff] [blame] | 753 | } else if (Tok.isAnnotation()) { |
| 754 | // Ignore annotation tokens created by pragmas - the pragmas themselves |
| 755 | // will be reproduced in the preprocessed output. |
| 756 | PP.Lex(Tok); |
| 757 | continue; |
Jordan Rose | 67b6623 | 2013-03-05 23:54:55 +0000 | [diff] [blame] | 758 | } else if (IdentifierInfo *II = Tok.getIdentifierInfo()) { |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 759 | OS << II->getName(); |
| 760 | } else if (Tok.isLiteral() && !Tok.needsCleaning() && |
| 761 | Tok.getLiteralData()) { |
| 762 | OS.write(Tok.getLiteralData(), Tok.getLength()); |
Paul Robinson | 4bb85ac | 2018-01-03 20:29:49 +0000 | [diff] [blame] | 763 | } else if (Tok.getLength() < llvm::array_lengthof(Buffer)) { |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 764 | const char *TokPtr = Buffer; |
| 765 | unsigned Len = PP.getSpelling(Tok, TokPtr); |
| 766 | OS.write(TokPtr, Len); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 767 | |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 768 | // Tokens that can contain embedded newlines need to adjust our current |
| 769 | // line number. |
Jordan Rose | cb8a1ac | 2013-02-21 18:53:19 +0000 | [diff] [blame] | 770 | if (Tok.getKind() == tok::comment || Tok.getKind() == tok::unknown) |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 771 | Callbacks->HandleNewlinesInToken(TokPtr, Len); |
| 772 | } else { |
| 773 | std::string S = PP.getSpelling(Tok); |
| 774 | OS.write(&S[0], S.size()); |
| 775 | |
| 776 | // Tokens that can contain embedded newlines need to adjust our current |
| 777 | // line number. |
Jordan Rose | cb8a1ac | 2013-02-21 18:53:19 +0000 | [diff] [blame] | 778 | if (Tok.getKind() == tok::comment || Tok.getKind() == tok::unknown) |
Benjamin Kramer | 718f722 | 2010-02-27 18:02:51 +0000 | [diff] [blame] | 779 | Callbacks->HandleNewlinesInToken(&S[0], S.size()); |
| 780 | } |
Jordan Rose | 127f6ee | 2012-06-15 23:33:51 +0000 | [diff] [blame] | 781 | Callbacks->setEmittedTokensOnThisLine(); |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 782 | |
Chris Lattner | 3ff2e69 | 2007-10-10 20:45:16 +0000 | [diff] [blame] | 783 | if (Tok.is(tok::eof)) break; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 784 | |
Chris Lattner | 0384e635 | 2010-04-14 03:57:19 +0000 | [diff] [blame] | 785 | PrevPrevTok = PrevTok; |
Chris Lattner | 3ff2e69 | 2007-10-10 20:45:16 +0000 | [diff] [blame] | 786 | PrevTok = Tok; |
| 787 | PP.Lex(Tok); |
| 788 | } |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 789 | } |
| 790 | |
Benjamin Kramer | 4cadf29 | 2014-03-07 21:51:58 +0000 | [diff] [blame] | 791 | typedef std::pair<const IdentifierInfo *, MacroInfo *> id_macro_pair; |
| 792 | static int MacroIDCompare(const id_macro_pair *LHS, const id_macro_pair *RHS) { |
| 793 | return LHS->first->getName().compare(RHS->first->getName()); |
| 794 | } |
| 795 | |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 796 | static void DoPrintMacros(Preprocessor &PP, raw_ostream *OS) { |
Daniel Dunbar | d839e77 | 2010-06-11 20:10:12 +0000 | [diff] [blame] | 797 | // Ignore unknown pragmas. |
Lubos Lunak | 576a041 | 2014-05-01 12:54:03 +0000 | [diff] [blame] | 798 | PP.IgnorePragmas(); |
Daniel Dunbar | d839e77 | 2010-06-11 20:10:12 +0000 | [diff] [blame] | 799 | |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 800 | // -dM mode just scans and ignores all tokens in the files, then dumps out |
| 801 | // the macro table at the end. |
Chris Lattner | fb24a3a | 2010-04-20 20:35:58 +0000 | [diff] [blame] | 802 | PP.EnterMainSourceFile(); |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 803 | |
| 804 | Token Tok; |
| 805 | do PP.Lex(Tok); |
| 806 | while (Tok.isNot(tok::eof)); |
| 807 | |
Alexander Kornienko | 8b3f623 | 2012-08-29 00:20:03 +0000 | [diff] [blame] | 808 | SmallVector<id_macro_pair, 128> MacrosByID; |
| 809 | for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end(); |
| 810 | I != E; ++I) { |
Richard Smith | 20e883e | 2015-04-29 23:20:19 +0000 | [diff] [blame] | 811 | auto *MD = I->second.getLatest(); |
| 812 | if (MD && MD->isDefined()) |
| 813 | MacrosByID.push_back(id_macro_pair(I->first, MD->getMacroInfo())); |
Alexander Kornienko | 8b3f623 | 2012-08-29 00:20:03 +0000 | [diff] [blame] | 814 | } |
Benjamin Kramer | 4cadf29 | 2014-03-07 21:51:58 +0000 | [diff] [blame] | 815 | llvm::array_pod_sort(MacrosByID.begin(), MacrosByID.end(), MacroIDCompare); |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 816 | |
| 817 | for (unsigned i = 0, e = MacrosByID.size(); i != e; ++i) { |
| 818 | MacroInfo &MI = *MacrosByID[i].second; |
Mike Stump | 11289f4 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 819 | // Ignore computed macros like __LINE__ and friends. |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 820 | if (MI.isBuiltinMacro()) continue; |
| 821 | |
| 822 | PrintMacroDefinition(*MacrosByID[i].first, MI, PP, *OS); |
Benjamin Kramer | fb5f40f | 2010-01-19 17:42:20 +0000 | [diff] [blame] | 823 | *OS << '\n'; |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 824 | } |
| 825 | } |
| 826 | |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 827 | /// DoPrintPreprocessedInput - This implements -E mode. |
| 828 | /// |
Chris Lattner | 0e62c1c | 2011-07-23 10:55:15 +0000 | [diff] [blame] | 829 | void clang::DoPrintPreprocessedInput(Preprocessor &PP, raw_ostream *OS, |
Daniel Dunbar | 22bdabf | 2009-11-11 10:07:44 +0000 | [diff] [blame] | 830 | const PreprocessorOutputOptions &Opts) { |
Daniel Dunbar | 531f6c6 | 2009-11-11 10:07:22 +0000 | [diff] [blame] | 831 | // Show macros with no output is handled specially. |
| 832 | if (!Opts.ShowCPP) { |
| 833 | assert(Opts.ShowMacros && "Not yet implemented!"); |
| 834 | DoPrintMacros(PP, OS); |
| 835 | return; |
| 836 | } |
| 837 | |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 838 | // Inform the preprocessor whether we want it to retain comments or not, due |
| 839 | // to -C or -CC. |
Daniel Dunbar | 531f6c6 | 2009-11-11 10:07:22 +0000 | [diff] [blame] | 840 | PP.SetCommentRetentionState(Opts.ShowComments, Opts.ShowMacroComments); |
Eli Friedman | fcb57d5 | 2009-05-19 01:02:07 +0000 | [diff] [blame] | 841 | |
Reid Kleckner | 1df0fea | 2015-02-26 00:17:25 +0000 | [diff] [blame] | 842 | PrintPPOutputPPCallbacks *Callbacks = new PrintPPOutputPPCallbacks( |
Bruno Cardoso Lopes | 6fa3b74 | 2016-11-17 22:45:31 +0000 | [diff] [blame] | 843 | PP, *OS, !Opts.ShowLineMarkers, Opts.ShowMacros, |
| 844 | Opts.ShowIncludeDirectives, Opts.UseLineDirectives); |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 845 | |
| 846 | // Expand macros in pragmas with -fms-extensions. The assumption is that |
| 847 | // the majority of pragmas in such a file will be Microsoft pragmas. |
Vassil Vassilev | 2b676cf | 2017-04-27 16:58:33 +0000 | [diff] [blame] | 848 | // Remember the handlers we will add so that we can remove them later. |
| 849 | std::unique_ptr<UnknownPragmaHandler> MicrosoftExtHandler( |
| 850 | new UnknownPragmaHandler( |
| 851 | "#pragma", Callbacks, |
| 852 | /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt)); |
| 853 | |
| 854 | std::unique_ptr<UnknownPragmaHandler> GCCHandler(new UnknownPragmaHandler( |
| 855 | "#pragma GCC", Callbacks, |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 856 | /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt)); |
Vassil Vassilev | 2b676cf | 2017-04-27 16:58:33 +0000 | [diff] [blame] | 857 | |
| 858 | std::unique_ptr<UnknownPragmaHandler> ClangHandler(new UnknownPragmaHandler( |
| 859 | "#pragma clang", Callbacks, |
| 860 | /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt)); |
| 861 | |
| 862 | PP.AddPragmaHandler(MicrosoftExtHandler.get()); |
| 863 | PP.AddPragmaHandler("GCC", GCCHandler.get()); |
| 864 | PP.AddPragmaHandler("clang", ClangHandler.get()); |
Samuel Antao | eab747b | 2015-06-15 23:44:27 +0000 | [diff] [blame] | 865 | |
| 866 | // The tokens after pragma omp need to be expanded. |
| 867 | // |
| 868 | // OpenMP [2.1, Directive format] |
| 869 | // Preprocessing tokens following the #pragma omp are subject to macro |
| 870 | // replacement. |
Vassil Vassilev | 2b676cf | 2017-04-27 16:58:33 +0000 | [diff] [blame] | 871 | std::unique_ptr<UnknownPragmaHandler> OpenMPHandler( |
| 872 | new UnknownPragmaHandler("#pragma omp", Callbacks, |
| 873 | /*RequireTokenExpansion=*/true)); |
| 874 | PP.AddPragmaHandler("omp", OpenMPHandler.get()); |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 875 | |
Craig Topper | b8a7053 | 2014-09-10 04:53:53 +0000 | [diff] [blame] | 876 | PP.addPPCallbacks(std::unique_ptr<PPCallbacks>(Callbacks)); |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 877 | |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 878 | // After we have configured the preprocessor, enter the main file. |
Chris Lattner | fb24a3a | 2010-04-20 20:35:58 +0000 | [diff] [blame] | 879 | PP.EnterMainSourceFile(); |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 880 | |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 881 | // Consume all of the tokens that come from the predefines buffer. Those |
| 882 | // should not be emitted into the output and are guaranteed to be at the |
| 883 | // start. |
| 884 | const SourceManager &SourceMgr = PP.getSourceManager(); |
| 885 | Token Tok; |
Douglas Gregor | 453b012 | 2010-11-12 07:15:47 +0000 | [diff] [blame] | 886 | do { |
| 887 | PP.Lex(Tok); |
| 888 | if (Tok.is(tok::eof) || !Tok.getLocation().isFileID()) |
| 889 | break; |
| 890 | |
| 891 | PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation()); |
| 892 | if (PLoc.isInvalid()) |
| 893 | break; |
| 894 | |
| 895 | if (strcmp(PLoc.getFilename(), "<built-in>")) |
| 896 | break; |
| 897 | } while (true); |
Chris Lattner | fc001b0 | 2009-02-06 05:56:11 +0000 | [diff] [blame] | 898 | |
Eli Friedman | 26c672b | 2009-05-19 01:32:34 +0000 | [diff] [blame] | 899 | // Read all the preprocessed tokens, printing them out to the stream. |
| 900 | PrintPreprocessedTokens(PP, Tok, Callbacks, *OS); |
| 901 | *OS << '\n'; |
Vassil Vassilev | 2b676cf | 2017-04-27 16:58:33 +0000 | [diff] [blame] | 902 | |
| 903 | // Remove the handlers we just added to leave the preprocessor in a sane state |
| 904 | // so that it can be reused (for example by a clang::Parser instance). |
| 905 | PP.RemovePragmaHandler(MicrosoftExtHandler.get()); |
| 906 | PP.RemovePragmaHandler("GCC", GCCHandler.get()); |
| 907 | PP.RemovePragmaHandler("clang", ClangHandler.get()); |
| 908 | PP.RemovePragmaHandler("omp", OpenMPHandler.get()); |
Chris Lattner | 09e3cdf | 2006-07-04 19:04:05 +0000 | [diff] [blame] | 909 | } |