Coverage Report

Created: 2020-02-18 08:44

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Frontend/PrintPreprocessedOutput.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- PrintPreprocessedOutput.cpp - Implement the -E mode --------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
// This code simply runs the preprocessor on the input file and prints out the
10
// result.  This is the traditional behavior of the -E option.
11
//
12
//===----------------------------------------------------------------------===//
13
14
#include "clang/Frontend/Utils.h"
15
#include "clang/Basic/CharInfo.h"
16
#include "clang/Basic/Diagnostic.h"
17
#include "clang/Basic/SourceManager.h"
18
#include "clang/Frontend/PreprocessorOutputOptions.h"
19
#include "clang/Lex/MacroInfo.h"
20
#include "clang/Lex/PPCallbacks.h"
21
#include "clang/Lex/Pragma.h"
22
#include "clang/Lex/Preprocessor.h"
23
#include "clang/Lex/TokenConcatenation.h"
24
#include "llvm/ADT/STLExtras.h"
25
#include "llvm/ADT/SmallString.h"
26
#include "llvm/ADT/StringRef.h"
27
#include "llvm/Support/ErrorHandling.h"
28
#include "llvm/Support/raw_ostream.h"
29
#include <cstdio>
30
using namespace clang;
31
32
/// PrintMacroDefinition - Print a macro definition in a form that will be
33
/// properly accepted back as a definition.
34
static void PrintMacroDefinition(const IdentifierInfo &II, const MacroInfo &MI,
35
432k
                                 Preprocessor &PP, raw_ostream &OS) {
36
432k
  OS << "#define " << II.getName();
37
432k
38
432k
  if (MI.isFunctionLike()) {
39
35
    OS << '(';
40
35
    if (!MI.param_empty()) {
41
34
      MacroInfo::param_iterator AI = MI.param_begin(), E = MI.param_end();
42
37
      for (; AI+1 != E; 
++AI3
) {
43
3
        OS << (*AI)->getName();
44
3
        OS << ',';
45
3
      }
46
34
47
34
      // Last argument.
48
34
      if ((*AI)->getName() == "__VA_ARGS__")
49
2
        OS << "...";
50
32
      else
51
32
        OS << (*AI)->getName();
52
34
    }
53
35
54
35
    if (MI.isGNUVarargs())
55
1
      OS << "...";  // #define foo(x...)
56
35
57
35
    OS << ')';
58
35
  }
59
432k
60
432k
  // GCC always emits a space, even if the macro body is empty.  However, do not
61
432k
  // want to emit two spaces if the first token has a leading space.
62
432k
  if (MI.tokens_empty() || 
!MI.tokens_begin()->hasLeadingSpace()424k
)
63
432k
    OS << ' ';
64
432k
65
432k
  SmallString<128> SpellingBuffer;
66
507k
  for (const auto &T : MI.tokens()) {
67
507k
    if (T.hasLeadingSpace())
68
46.7k
      OS << ' ';
69
507k
70
507k
    OS << PP.getSpelling(T, SpellingBuffer);
71
507k
  }
72
432k
}
73
74
//===----------------------------------------------------------------------===//
75
// Preprocessed token printer
76
//===----------------------------------------------------------------------===//
77
78
namespace {
79
class PrintPPOutputPPCallbacks : public PPCallbacks {
80
  Preprocessor &PP;
81
  SourceManager &SM;
82
  TokenConcatenation ConcatInfo;
83
public:
84
  raw_ostream &OS;
85
private:
86
  unsigned CurLine;
87
88
  bool EmittedTokensOnThisLine;
89
  bool EmittedDirectiveOnThisLine;
90
  SrcMgr::CharacteristicKind FileType;
91
  SmallString<512> CurFilename;
92
  bool Initialized;
93
  bool DisableLineMarkers;
94
  bool DumpDefines;
95
  bool DumpIncludeDirectives;
96
  bool UseLineDirectives;
97
  bool IsFirstFileEntered;
98
public:
99
  PrintPPOutputPPCallbacks(Preprocessor &pp, raw_ostream &os, bool lineMarkers,
100
                           bool defines, bool DumpIncludeDirectives,
101
                           bool UseLineDirectives)
102
      : PP(pp), SM(PP.getSourceManager()), ConcatInfo(PP), OS(os),
103
        DisableLineMarkers(lineMarkers), DumpDefines(defines),
104
        DumpIncludeDirectives(DumpIncludeDirectives),
105
487
        UseLineDirectives(UseLineDirectives) {
106
487
    CurLine = 0;
107
487
    CurFilename += "<uninit>";
108
487
    EmittedTokensOnThisLine = false;
109
487
    EmittedDirectiveOnThisLine = false;
110
487
    FileType = SrcMgr::C_User;
111
487
    Initialized = false;
112
487
    IsFirstFileEntered = false;
113
487
  }
114
115
622k
  void setEmittedTokensOnThisLine() { EmittedTokensOnThisLine = true; }
116
310k
  bool hasEmittedTokensOnThisLine() const { return EmittedTokensOnThisLine; }
117
118
1.24k
  void setEmittedDirectiveOnThisLine() { EmittedDirectiveOnThisLine = true; }
119
622k
  bool hasEmittedDirectiveOnThisLine() const {
120
622k
    return EmittedDirectiveOnThisLine;
121
622k
  }
122
123
  bool startNewLineIfNeeded(bool ShouldUpdateCurrentLine = true);
124
125
  void FileChanged(SourceLocation Loc, FileChangeReason Reason,
126
                   SrcMgr::CharacteristicKind FileType,
127
                   FileID PrevFID) override;
128
  void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
129
                          StringRef FileName, bool IsAngled,
130
                          CharSourceRange FilenameRange, const FileEntry *File,
131
                          StringRef SearchPath, StringRef RelativePath,
132
                          const Module *Imported,
133
                          SrcMgr::CharacteristicKind FileType) override;
134
  void Ident(SourceLocation Loc, StringRef str) override;
135
  void PragmaMessage(SourceLocation Loc, StringRef Namespace,
136
                     PragmaMessageKind Kind, StringRef Str) override;
137
  void PragmaDebug(SourceLocation Loc, StringRef DebugType) override;
138
  void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override;
139
  void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override;
140
  void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace,
141
                        diag::Severity Map, StringRef Str) override;
142
  void PragmaWarning(SourceLocation Loc, StringRef WarningSpec,
143
                     ArrayRef<int> Ids) override;
144
  void PragmaWarningPush(SourceLocation Loc, int Level) override;
145
  void PragmaWarningPop(SourceLocation Loc) override;
146
  void PragmaExecCharsetPush(SourceLocation Loc, StringRef Str) override;
147
  void PragmaExecCharsetPop(SourceLocation Loc) override;
148
  void PragmaAssumeNonNullBegin(SourceLocation Loc) override;
149
  void PragmaAssumeNonNullEnd(SourceLocation Loc) override;
150
151
  bool HandleFirstTokOnLine(Token &Tok);
152
153
  /// Move to the line of the provided source location. This will
154
  /// return true if the output stream required adjustment or if
155
  /// the requested location is on the first line.
156
6.38k
  bool MoveToLine(SourceLocation Loc) {
157
6.38k
    PresumedLoc PLoc = SM.getPresumedLoc(Loc);
158
6.38k
    if (PLoc.isInvalid())
159
1
      return false;
160
6.38k
    return MoveToLine(PLoc.getLine()) || 
(PLoc.getLine() == 1)482
;
161
6.38k
  }
162
  bool MoveToLine(unsigned LineNo);
163
164
  bool AvoidConcat(const Token &PrevPrevTok, const Token &PrevTok,
165
310k
                   const Token &Tok) {
166
310k
    return ConcatInfo.AvoidConcat(PrevPrevTok, PrevTok, Tok);
167
310k
  }
168
  void WriteLineInfo(unsigned LineNo, const char *Extra=nullptr,
169
                     unsigned ExtraLen=0);
170
0
  bool LineMarkersAreDisabled() const { return DisableLineMarkers; }
171
  void HandleNewlinesInToken(const char *TokStr, unsigned Len);
172
173
  /// MacroDefined - This hook is called whenever a macro definition is seen.
174
  void MacroDefined(const Token &MacroNameTok,
175
                    const MacroDirective *MD) override;
176
177
  /// MacroUndefined - This hook is called whenever a macro #undef is seen.
178
  void MacroUndefined(const Token &MacroNameTok,
179
                      const MacroDefinition &MD,
180
                      const MacroDirective *Undef) override;
181
182
  void BeginModule(const Module *M);
183
  void EndModule(const Module *M);
184
};
185
}  // end anonymous namespace
186
187
void PrintPPOutputPPCallbacks::WriteLineInfo(unsigned LineNo,
188
                                             const char *Extra,
189
4.62k
                                             unsigned ExtraLen) {
190
4.62k
  startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
191
4.62k
192
4.62k
  // Emit #line directives or GNU line markers depending on what mode we're in.
193
4.62k
  if (UseLineDirectives) {
194
21
    OS << "#line" << ' ' << LineNo << ' ' << '"';
195
21
    OS.write_escaped(CurFilename);
196
21
    OS << '"';
197
4.60k
  } else {
198
4.60k
    OS << '#' << ' ' << LineNo << ' ' << '"';
199
4.60k
    OS.write_escaped(CurFilename);
200
4.60k
    OS << '"';
201
4.60k
202
4.60k
    if (ExtraLen)
203
2.51k
      OS.write(Extra, ExtraLen);
204
4.60k
205
4.60k
    if (FileType == SrcMgr::C_System)
206
1.09k
      OS.write(" 3", 2);
207
3.51k
    else if (FileType == SrcMgr::C_ExternCSystem)
208
6
      OS.write(" 3 4", 4);
209
4.60k
  }
210
4.62k
  OS << '\n';
211
4.62k
}
212
213
/// MoveToLine - Move the output to the source line specified by the location
214
/// object.  We can do this by emitting some number of \n's, or be emitting a
215
/// #line directive.  This returns false if already at the specified line, true
216
/// if some newlines were emitted.
217
6.38k
bool PrintPPOutputPPCallbacks::MoveToLine(unsigned LineNo) {
218
6.38k
  // If this line is "close enough" to the original line, just print newlines,
219
6.38k
  // otherwise print a #line directive.
220
6.38k
  if (LineNo-CurLine <= 8) {
221
5.24k
    if (LineNo-CurLine == 1)
222
3.36k
      OS << '\n';
223
1.88k
    else if (LineNo == CurLine)
224
482
      return false;    // Spelling line moved, but expansion line didn't.
225
1.39k
    else {
226
1.39k
      const char *NewLines = "\n\n\n\n\n\n\n\n";
227
1.39k
      OS.write(NewLines, LineNo-CurLine);
228
1.39k
    }
229
5.24k
  } else 
if (1.13k
!DisableLineMarkers1.13k
) {
230
1.11k
    // Emit a #line or line marker.
231
1.11k
    WriteLineInfo(LineNo, nullptr, 0);
232
1.11k
  } else {
233
21
    // Okay, we're in -P mode, which turns off line markers.  However, we still
234
21
    // need to emit a newline between tokens on different lines.
235
21
    startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
236
21
  }
237
6.38k
238
6.38k
  CurLine = LineNo;
239
5.90k
  return true;
240
6.38k
}
241
242
bool
243
5.15k
PrintPPOutputPPCallbacks::startNewLineIfNeeded(bool ShouldUpdateCurrentLine) {
244
5.15k
  if (EmittedTokensOnThisLine || 
EmittedDirectiveOnThisLine4.58k
) {
245
835
    OS << '\n';
246
835
    EmittedTokensOnThisLine = false;
247
835
    EmittedDirectiveOnThisLine = false;
248
835
    if (ShouldUpdateCurrentLine)
249
295
      ++CurLine;
250
835
    return true;
251
835
  }
252
4.32k
253
4.32k
  return false;
254
4.32k
}
255
256
/// FileChanged - Whenever the preprocessor enters or exits a #include file
257
/// it invokes this handler.  Update our conception of the current source
258
/// position.
259
void PrintPPOutputPPCallbacks::FileChanged(SourceLocation Loc,
260
                                           FileChangeReason Reason,
261
                                       SrcMgr::CharacteristicKind NewFileType,
262
3.60k
                                       FileID PrevFID) {
263
3.60k
  // Unless we are exiting a #include, make sure to skip ahead to the line the
264
3.60k
  // #include directive was at.
265
3.60k
  SourceManager &SourceMgr = SM;
266
3.60k
267
3.60k
  PresumedLoc UserLoc = SourceMgr.getPresumedLoc(Loc);
268
3.60k
  if (UserLoc.isInvalid())
269
0
    return;
270
3.60k
271
3.60k
  unsigned NewLine = UserLoc.getLine();
272
3.60k
273
3.60k
  if (Reason == PPCallbacks::EnterFile) {
274
1.78k
    SourceLocation IncludeLoc = UserLoc.getIncludeLoc();
275
1.78k
    if (IncludeLoc.isValid())
276
806
      MoveToLine(IncludeLoc);
277
1.82k
  } else if (Reason == PPCallbacks::SystemHeaderPragma) {
278
3
    // GCC emits the # directive for this directive on the line AFTER the
279
3
    // directive and emits a bunch of spaces that aren't needed. This is because
280
3
    // otherwise we will emit a line marker for THIS line, which requires an
281
3
    // extra blank line after the directive to avoid making all following lines
282
3
    // off by one. We can do better by simply incrementing NewLine here.
283
3
    NewLine += 1;
284
3
  }
285
3.60k
286
3.60k
  CurLine = NewLine;
287
3.60k
288
3.60k
  CurFilename.clear();
289
3.60k
  CurFilename += UserLoc.getFilename();
290
3.60k
  FileType = NewFileType;
291
3.60k
292
3.60k
  if (DisableLineMarkers) {
293
93
    startNewLineIfNeeded(/*ShouldUpdateCurrentLine=*/false);
294
93
    return;
295
93
  }
296
3.51k
297
3.51k
  if (!Initialized) {
298
474
    WriteLineInfo(CurLine);
299
474
    Initialized = true;
300
474
  }
301
3.51k
302
3.51k
  // Do not emit an enter marker for the main file (which we expect is the first
303
3.51k
  // entered file). This matches gcc, and improves compatibility with some tools
304
3.51k
  // which track the # line markers as a way to determine when the preprocessed
305
3.51k
  // output is in the context of the main file.
306
3.51k
  if (Reason == PPCallbacks::EnterFile && 
!IsFirstFileEntered1.73k
) {
307
474
    IsFirstFileEntered = true;
308
474
    return;
309
474
  }
310
3.04k
311
3.04k
  switch (Reason) {
312
1.26k
  case PPCallbacks::EnterFile:
313
1.26k
    WriteLineInfo(CurLine, " 1", 2);
314
1.26k
    break;
315
1.26k
  case PPCallbacks::ExitFile:
316
1.26k
    WriteLineInfo(CurLine, " 2", 2);
317
1.26k
    break;
318
518
  case PPCallbacks::SystemHeaderPragma:
319
518
  case PPCallbacks::RenameFile:
320
518
    WriteLineInfo(CurLine);
321
518
    break;
322
3.04k
  }
323
3.04k
}
324
325
void PrintPPOutputPPCallbacks::InclusionDirective(
326
    SourceLocation HashLoc,
327
    const Token &IncludeTok,
328
    StringRef FileName,
329
    bool IsAngled,
330
    CharSourceRange FilenameRange,
331
    const FileEntry *File,
332
    StringRef SearchPath,
333
    StringRef RelativePath,
334
    const Module *Imported,
335
483
    SrcMgr::CharacteristicKind FileType) {
336
483
  // In -dI mode, dump #include directives prior to dumping their content or
337
483
  // interpretation.
338
483
  if (DumpIncludeDirectives) {
339
5
    startNewLineIfNeeded();
340
5
    MoveToLine(HashLoc);
341
5
    const std::string TokenText = PP.getSpelling(IncludeTok);
342
5
    assert(!TokenText.empty());
343
5
    OS << "#" << TokenText << " "
344
5
       << (IsAngled ? 
'<'1
:
'"'4
) << FileName << (IsAngled ?
'>'1
:
'"'4
)
345
5
       << " /* clang -E -dI */";
346
5
    setEmittedDirectiveOnThisLine();
347
5
    startNewLineIfNeeded();
348
5
  }
349
483
350
483
  // When preprocessing, turn implicit imports into module import pragmas.
351
483
  if (Imported) {
352
39
    switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) {
353
39
    case tok::pp_include:
354
39
    case tok::pp_import:
355
39
    case tok::pp_include_next:
356
39
      startNewLineIfNeeded();
357
39
      MoveToLine(HashLoc);
358
39
      OS << "#pragma clang module import " << Imported->getFullModuleName(true)
359
39
         << " /* clang -E: implicit import for "
360
39
         << "#" << PP.getSpelling(IncludeTok) << " "
361
39
         << (IsAngled ? 
'<'8
:
'"'31
) << FileName << (IsAngled ?
'>'8
:
'"'31
)
362
39
         << " */";
363
39
      // Since we want a newline after the pragma, but not a #<line>, start a
364
39
      // new line immediately.
365
39
      EmittedTokensOnThisLine = true;
366
39
      startNewLineIfNeeded();
367
39
      break;
368
39
369
39
    case tok::pp___include_macros:
370
0
      // #__include_macros has no effect on a user of a preprocessed source
371
0
      // file; the only effect is on preprocessing.
372
0
      //
373
0
      // FIXME: That's not *quite* true: it causes the module in question to
374
0
      // be loaded, which can affect downstream diagnostics.
375
0
      break;
376
39
377
39
    default:
378
0
      llvm_unreachable("unknown include directive kind");
379
39
      
break0
;
380
39
    }
381
39
  }
382
483
}
383
384
/// Handle entering the scope of a module during a module compilation.
385
37
void PrintPPOutputPPCallbacks::BeginModule(const Module *M) {
386
37
  startNewLineIfNeeded();
387
37
  OS << "#pragma clang module begin " << M->getFullModuleName(true);
388
37
  setEmittedDirectiveOnThisLine();
389
37
}
390
391
/// Handle leaving the scope of a module during a module compilation.
392
37
void PrintPPOutputPPCallbacks::EndModule(const Module *M) {
393
37
  startNewLineIfNeeded();
394
37
  OS << "#pragma clang module end /*" << M->getFullModuleName(true) << "*/";
395
37
  setEmittedDirectiveOnThisLine();
396
37
}
397
398
/// Ident - Handle #ident directives when read by the preprocessor.
399
///
400
0
void PrintPPOutputPPCallbacks::Ident(SourceLocation Loc, StringRef S) {
401
0
  MoveToLine(Loc);
402
0
403
0
  OS.write("#ident ", strlen("#ident "));
404
0
  OS.write(S.begin(), S.size());
405
0
  EmittedTokensOnThisLine = true;
406
0
}
407
408
/// MacroDefined - This hook is called whenever a macro definition is seen.
409
void PrintPPOutputPPCallbacks::MacroDefined(const Token &MacroNameTok,
410
471k
                                            const MacroDirective *MD) {
411
471k
  const MacroInfo *MI = MD->getMacroInfo();
412
471k
  // Only print out macro definitions in -dD mode.
413
471k
  if (!DumpDefines ||
414
471k
      // Ignore __FILE__ etc.
415
471k
      
MI->isBuiltinMacro()995
)
return470k
;
416
995
417
995
  MoveToLine(MI->getDefinitionLoc());
418
995
  PrintMacroDefinition(*MacroNameTok.getIdentifierInfo(), *MI, PP, OS);
419
995
  setEmittedDirectiveOnThisLine();
420
995
}
421
422
void PrintPPOutputPPCallbacks::MacroUndefined(const Token &MacroNameTok,
423
                                              const MacroDefinition &MD,
424
92
                                              const MacroDirective *Undef) {
425
92
  // Only print out macro definitions in -dD mode.
426
92
  if (!DumpDefines) 
return91
;
427
1
428
1
  MoveToLine(MacroNameTok.getLocation());
429
1
  OS << "#undef " << MacroNameTok.getIdentifierInfo()->getName();
430
1
  setEmittedDirectiveOnThisLine();
431
1
}
432
433
7
static void outputPrintable(raw_ostream &OS, StringRef Str) {
434
43
  for (unsigned char Char : Str) {
435
43
    if (isPrintable(Char) && 
Char != '\\'41
&&
Char != '"'39
)
436
33
      OS << (char)Char;
437
10
    else // Output anything hard as an octal escape.
438
10
      OS << '\\'
439
10
         << (char)('0' + ((Char >> 6) & 7))
440
10
         << (char)('0' + ((Char >> 3) & 7))
441
10
         << (char)('0' + ((Char >> 0) & 7));
442
43
  }
443
7
}
444
445
void PrintPPOutputPPCallbacks::PragmaMessage(SourceLocation Loc,
446
                                             StringRef Namespace,
447
                                             PragmaMessageKind Kind,
448
7
                                             StringRef Str) {
449
7
  startNewLineIfNeeded();
450
7
  MoveToLine(Loc);
451
7
  OS << "#pragma ";
452
7
  if (!Namespace.empty())
453
4
    OS << Namespace << ' ';
454
7
  switch (Kind) {
455
3
    case PMK_Message:
456
3
      OS << "message(\"";
457
3
      break;
458
2
    case PMK_Warning:
459
2
      OS << "warning \"";
460
2
      break;
461
2
    case PMK_Error:
462
2
      OS << "error \"";
463
2
      break;
464
7
  }
465
7
466
7
  outputPrintable(OS, Str);
467
7
  OS << '"';
468
7
  if (Kind == PMK_Message)
469
3
    OS << ')';
470
7
  setEmittedDirectiveOnThisLine();
471
7
}
472
473
void PrintPPOutputPPCallbacks::PragmaDebug(SourceLocation Loc,
474
5
                                           StringRef DebugType) {
475
5
  startNewLineIfNeeded();
476
5
  MoveToLine(Loc);
477
5
478
5
  OS << "#pragma clang __debug ";
479
5
  OS << DebugType;
480
5
481
5
  setEmittedDirectiveOnThisLine();
482
5
}
483
484
void PrintPPOutputPPCallbacks::
485
9
PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) {
486
9
  startNewLineIfNeeded();
487
9
  MoveToLine(Loc);
488
9
  OS << "#pragma " << Namespace << " diagnostic push";
489
9
  setEmittedDirectiveOnThisLine();
490
9
}
491
492
void PrintPPOutputPPCallbacks::
493
9
PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) {
494
9
  startNewLineIfNeeded();
495
9
  MoveToLine(Loc);
496
9
  OS << "#pragma " << Namespace << " diagnostic pop";
497
9
  setEmittedDirectiveOnThisLine();
498
9
}
499
500
void PrintPPOutputPPCallbacks::PragmaDiagnostic(SourceLocation Loc,
501
                                                StringRef Namespace,
502
                                                diag::Severity Map,
503
17
                                                StringRef Str) {
504
17
  startNewLineIfNeeded();
505
17
  MoveToLine(Loc);
506
17
  OS << "#pragma " << Namespace << " diagnostic ";
507
17
  switch (Map) {
508
0
  case diag::Severity::Remark:
509
0
    OS << "remark";
510
0
    break;
511
2
  case diag::Severity::Warning:
512
2
    OS << "warning";
513
2
    break;
514
3
  case diag::Severity::Error:
515
3
    OS << "error";
516
3
    break;
517
10
  case diag::Severity::Ignored:
518
10
    OS << "ignored";
519
10
    break;
520
2
  case diag::Severity::Fatal:
521
2
    OS << "fatal";
522
2
    break;
523
17
  }
524
17
  OS << " \"" << Str << '"';
525
17
  setEmittedDirectiveOnThisLine();
526
17
}
527
528
void PrintPPOutputPPCallbacks::PragmaWarning(SourceLocation Loc,
529
                                             StringRef WarningSpec,
530
15
                                             ArrayRef<int> Ids) {
531
15
  startNewLineIfNeeded();
532
15
  MoveToLine(Loc);
533
15
  OS << "#pragma warning(" << WarningSpec << ':';
534
39
  for (ArrayRef<int>::iterator I = Ids.begin(), E = Ids.end(); I != E; 
++I24
)
535
24
    OS << ' ' << *I;
536
15
  OS << ')';
537
15
  setEmittedDirectiveOnThisLine();
538
15
}
539
540
void PrintPPOutputPPCallbacks::PragmaWarningPush(SourceLocation Loc,
541
17
                                                 int Level) {
542
17
  startNewLineIfNeeded();
543
17
  MoveToLine(Loc);
544
17
  OS << "#pragma warning(push";
545
17
  if (Level >= 0)
546
9
    OS << ", " << Level;
547
17
  OS << ')';
548
17
  setEmittedDirectiveOnThisLine();
549
17
}
550
551
6
void PrintPPOutputPPCallbacks::PragmaWarningPop(SourceLocation Loc) {
552
6
  startNewLineIfNeeded();
553
6
  MoveToLine(Loc);
554
6
  OS << "#pragma warning(pop)";
555
6
  setEmittedDirectiveOnThisLine();
556
6
}
557
558
void PrintPPOutputPPCallbacks::PragmaExecCharsetPush(SourceLocation Loc,
559
4
                                                     StringRef Str) {
560
4
  startNewLineIfNeeded();
561
4
  MoveToLine(Loc);
562
4
  OS << "#pragma character_execution_set(push";
563
4
  if (!Str.empty())
564
4
    OS << ", " << Str;
565
4
  OS << ')';
566
4
  setEmittedDirectiveOnThisLine();
567
4
}
568
569
3
void PrintPPOutputPPCallbacks::PragmaExecCharsetPop(SourceLocation Loc) {
570
3
  startNewLineIfNeeded();
571
3
  MoveToLine(Loc);
572
3
  OS << "#pragma character_execution_set(pop)";
573
3
  setEmittedDirectiveOnThisLine();
574
3
}
575
576
void PrintPPOutputPPCallbacks::
577
1
PragmaAssumeNonNullBegin(SourceLocation Loc) {
578
1
  startNewLineIfNeeded();
579
1
  MoveToLine(Loc);
580
1
  OS << "#pragma clang assume_nonnull begin";
581
1
  setEmittedDirectiveOnThisLine();
582
1
}
583
584
void PrintPPOutputPPCallbacks::
585
1
PragmaAssumeNonNullEnd(SourceLocation Loc) {
586
1
  startNewLineIfNeeded();
587
1
  MoveToLine(Loc);
588
1
  OS << "#pragma clang assume_nonnull end";
589
1
  setEmittedDirectiveOnThisLine();
590
1
}
591
592
/// HandleFirstTokOnLine - When emitting a preprocessed file in -E mode, this
593
/// is called for the first token on each new line.  If this really is the start
594
/// of a new logical line, handle it and return true, otherwise return false.
595
/// This may not be the start of a logical line because the "start of line"
596
/// marker is set for spelling lines, not expansion ones.
597
4.23k
bool PrintPPOutputPPCallbacks::HandleFirstTokOnLine(Token &Tok) {
598
4.23k
  // Figure out what line we went to and insert the appropriate number of
599
4.23k
  // newline characters.
600
4.23k
  if (!MoveToLine(Tok.getLocation()))
601
157
    return false;
602
4.07k
603
4.07k
  // Print out space characters so that the first token on a line is
604
4.07k
  // indented for easy reading.
605
4.07k
  unsigned ColNo = SM.getExpansionColumnNumber(Tok.getLocation());
606
4.07k
607
4.07k
  // The first token on a line can have a column number of 1, yet still expect
608
4.07k
  // leading white space, if a macro expansion in column 1 starts with an empty
609
4.07k
  // macro argument, or an empty nested macro expansion. In this case, move the
610
4.07k
  // token to column 2.
611
4.07k
  if (ColNo == 1 && 
Tok.hasLeadingSpace()3.48k
)
612
1
    ColNo = 2;
613
4.07k
614
4.07k
  // This hack prevents stuff like:
615
4.07k
  // #define HASH #
616
4.07k
  // HASH define foo bar
617
4.07k
  // From having the # character end up at column 1, which makes it so it
618
4.07k
  // is not handled as a #define next time through the preprocessor if in
619
4.07k
  // -fpreprocessed mode.
620
4.07k
  if (ColNo <= 1 && 
Tok.is(tok::hash)3.48k
)
621
15
    OS << ' ';
622
4.07k
623
4.07k
  // Otherwise, indent the appropriate number of spaces.
624
6.38k
  for (; ColNo > 1; 
--ColNo2.30k
)
625
2.30k
    OS << ' ';
626
4.07k
627
4.07k
  return true;
628
4.07k
}
629
630
void PrintPPOutputPPCallbacks::HandleNewlinesInToken(const char *TokStr,
631
321
                                                     unsigned Len) {
632
321
  unsigned NumNewlines = 0;
633
5.73k
  for (; Len; 
--Len, ++TokStr5.40k
) {
634
5.40k
    if (*TokStr != '\n' &&
635
5.40k
        
*TokStr != '\r'5.19k
)
636
5.19k
      continue;
637
214
638
214
    ++NumNewlines;
639
214
640
214
    // If we have \n\r or \r\n, skip both and count as one line.
641
214
    if (Len != 1 &&
642
214
        
(104
TokStr[1] == '\n'104
||
TokStr[1] == '\r'50
) &&
643
214
        
TokStr[0] != TokStr[1]54
) {
644
0
      ++TokStr;
645
0
      --Len;
646
0
    }
647
214
  }
648
321
649
321
  if (NumNewlines == 0) 
return180
;
650
141
651
141
  CurLine += NumNewlines;
652
141
}
653
654
655
namespace {
656
struct UnknownPragmaHandler : public PragmaHandler {
657
  const char *Prefix;
658
  PrintPPOutputPPCallbacks *Callbacks;
659
660
  // Set to true if tokens should be expanded
661
  bool ShouldExpandTokens;
662
663
  UnknownPragmaHandler(const char *prefix, PrintPPOutputPPCallbacks *callbacks,
664
                       bool RequireTokenExpansion)
665
      : Prefix(prefix), Callbacks(callbacks),
666
1.94k
        ShouldExpandTokens(RequireTokenExpansion) {}
667
  void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
668
79
                    Token &PragmaTok) override {
669
79
    // Figure out what line we went to and insert the appropriate number of
670
79
    // newline characters.
671
79
    Callbacks->startNewLineIfNeeded();
672
79
    Callbacks->MoveToLine(PragmaTok.getLocation());
673
79
    Callbacks->OS.write(Prefix, strlen(Prefix));
674
79
675
79
    if (ShouldExpandTokens) {
676
53
      // The first token does not have expanded macros. Expand them, if
677
53
      // required.
678
53
      auto Toks = std::make_unique<Token[]>(1);
679
53
      Toks[0] = PragmaTok;
680
53
      PP.EnterTokenStream(std::move(Toks), /*NumToks=*/1,
681
53
                          /*DisableMacroExpansion=*/false,
682
53
                          /*IsReinject=*/false);
683
53
      PP.Lex(PragmaTok);
684
53
    }
685
79
    Token PrevToken;
686
79
    Token PrevPrevToken;
687
79
    PrevToken.startToken();
688
79
    PrevPrevToken.startToken();
689
79
690
79
    // Read and print all of the pragma tokens.
691
434
    while (PragmaTok.isNot(tok::eod)) {
692
355
      if (PragmaTok.hasLeadingSpace() ||
693
355
          
Callbacks->AvoidConcat(PrevPrevToken, PrevToken, PragmaTok)198
)
694
158
        Callbacks->OS << ' ';
695
355
      std::string TokSpell = PP.getSpelling(PragmaTok);
696
355
      Callbacks->OS.write(&TokSpell[0], TokSpell.size());
697
355
698
355
      PrevPrevToken = PrevToken;
699
355
      PrevToken = PragmaTok;
700
355
701
355
      if (ShouldExpandTokens)
702
282
        PP.Lex(PragmaTok);
703
73
      else
704
73
        PP.LexUnexpandedToken(PragmaTok);
705
355
    }
706
79
    Callbacks->setEmittedDirectiveOnThisLine();
707
79
  }
708
};
709
} // end anonymous namespace
710
711
712
static void PrintPreprocessedTokens(Preprocessor &PP, Token &Tok,
713
                                    PrintPPOutputPPCallbacks *Callbacks,
714
487
                                    raw_ostream &OS) {
715
487
  bool DropComments = PP.getLangOpts().TraditionalCPP &&
716
487
                      
!PP.getCommentRetentionState()3
;
717
487
718
487
  char Buffer[256];
719
487
  Token PrevPrevTok, PrevTok;
720
487
  PrevPrevTok.startToken();
721
487
  PrevTok.startToken();
722
622k
  while (1) {
723
622k
    if (Callbacks->hasEmittedDirectiveOnThisLine()) {
724
79
      Callbacks->startNewLineIfNeeded();
725
79
      Callbacks->MoveToLine(Tok.getLocation());
726
79
    }
727
622k
728
622k
    // If this token is at the start of a line, emit newlines if needed.
729
622k
    if (Tok.isAtStartOfLine() && 
Callbacks->HandleFirstTokOnLine(Tok)4.23k
) {
730
4.07k
      // done.
731
618k
    } else if (Tok.hasLeadingSpace() ||
732
618k
               // If we haven't emitted a token on this line yet, PrevTok isn't
733
618k
               // useful to look at and no concatenation could happen anyway.
734
618k
               
(310k
Callbacks->hasEmittedTokensOnThisLine()310k
&&
735
310k
                // Don't print "-" next to "-", it would form "--".
736
310k
                
Callbacks->AvoidConcat(PrevPrevTok, PrevTok, Tok)310k
)) {
737
307k
      OS << ' ';
738
307k
    }
739
622k
740
622k
    if (DropComments && 
Tok.is(tok::comment)275
) {
741
50
      // Skip comments. Normally the preprocessor does not generate
742
50
      // tok::comment nodes at all when not keeping comments, but under
743
50
      // -traditional-cpp the lexer keeps /all/ whitespace, including comments.
744
50
      SourceLocation StartLoc = Tok.getLocation();
745
50
      Callbacks->MoveToLine(StartLoc.getLocWithOffset(Tok.getLength()));
746
622k
    } else if (Tok.is(tok::eod)) {
747
27
      // Don't print end of directive tokens, since they are typically newlines
748
27
      // that mess up our line tracking. These come from unknown pre-processor
749
27
      // directives or hash-prefixed comments in standalone assembly files.
750
27
      PP.Lex(Tok);
751
27
      continue;
752
622k
    } else if (Tok.is(tok::annot_module_include)) {
753
47
      // PrintPPOutputPPCallbacks::InclusionDirective handles producing
754
47
      // appropriate output here. Ignore this token entirely.
755
47
      PP.Lex(Tok);
756
47
      continue;
757
622k
    } else if (Tok.is(tok::annot_module_begin)) {
758
37
      // FIXME: We retrieve this token after the FileChanged callback, and
759
37
      // retrieve the module_end token before the FileChanged callback, so
760
37
      // we render this within the file and render the module end outside the
761
37
      // file, but this is backwards from the token locations: the module_begin
762
37
      // token is at the include location (outside the file) and the module_end
763
37
      // token is at the EOF location (within the file).
764
37
      Callbacks->BeginModule(
765
37
          reinterpret_cast<Module *>(Tok.getAnnotationValue()));
766
37
      PP.Lex(Tok);
767
37
      continue;
768
622k
    } else if (Tok.is(tok::annot_module_end)) {
769
37
      Callbacks->EndModule(
770
37
          reinterpret_cast<Module *>(Tok.getAnnotationValue()));
771
37
      PP.Lex(Tok);
772
37
      continue;
773
622k
    } else if (Tok.is(tok::annot_header_unit)) {
774
5
      // This is a header-name that has been (effectively) converted into a
775
5
      // module-name.
776
5
      // FIXME: The module name could contain non-identifier module name
777
5
      // components. We don't have a good way to round-trip those.
778
5
      Module *M = reinterpret_cast<Module *>(Tok.getAnnotationValue());
779
5
      std::string Name = M->getFullModuleName();
780
5
      OS.write(Name.data(), Name.size());
781
5
      Callbacks->HandleNewlinesInToken(Name.data(), Name.size());
782
622k
    } else if (Tok.isAnnotation()) {
783
3
      // Ignore annotation tokens created by pragmas - the pragmas themselves
784
3
      // will be reproduced in the preprocessed output.
785
3
      PP.Lex(Tok);
786
3
      continue;
787
622k
    } else if (IdentifierInfo *II = Tok.getIdentifierInfo()) {
788
308k
      OS << II->getName();
789
313k
    } else if (Tok.isLiteral() && 
!Tok.needsCleaning()2.57k
&&
790
313k
               
Tok.getLiteralData()2.57k
) {
791
2.55k
      OS.write(Tok.getLiteralData(), Tok.getLength());
792
311k
    } else if (Tok.getLength() < llvm::array_lengthof(Buffer)) {
793
311k
      const char *TokPtr = Buffer;
794
311k
      unsigned Len = PP.getSpelling(Tok, TokPtr);
795
311k
      OS.write(TokPtr, Len);
796
311k
797
311k
      // Tokens that can contain embedded newlines need to adjust our current
798
311k
      // line number.
799
311k
      if (Tok.getKind() == tok::comment || 
Tok.getKind() == tok::unknown310k
)
800
316
        Callbacks->HandleNewlinesInToken(TokPtr, Len);
801
311k
    } else {
802
0
      std::string S = PP.getSpelling(Tok);
803
0
      OS.write(S.data(), S.size());
804
0
805
0
      // Tokens that can contain embedded newlines need to adjust our current
806
0
      // line number.
807
0
      if (Tok.getKind() == tok::comment || Tok.getKind() == tok::unknown)
808
0
        Callbacks->HandleNewlinesInToken(S.data(), S.size());
809
0
    }
810
622k
    Callbacks->setEmittedTokensOnThisLine();
811
622k
812
622k
    if (Tok.is(tok::eof)) 
break487
;
813
621k
814
621k
    PrevPrevTok = PrevTok;
815
621k
    PrevTok = Tok;
816
621k
    PP.Lex(Tok);
817
621k
  }
818
487
}
819
820
typedef std::pair<const IdentifierInfo *, MacroInfo *> id_macro_pair;
821
3.90M
static int MacroIDCompare(const id_macro_pair *LHS, const id_macro_pair *RHS) {
822
3.90M
  return LHS->first->getName().compare(RHS->first->getName());
823
3.90M
}
824
825
1.26k
static void DoPrintMacros(Preprocessor &PP, raw_ostream *OS) {
826
1.26k
  // Ignore unknown pragmas.
827
1.26k
  PP.IgnorePragmas();
828
1.26k
829
1.26k
  // -dM mode just scans and ignores all tokens in the files, then dumps out
830
1.26k
  // the macro table at the end.
831
1.26k
  PP.EnterMainSourceFile();
832
1.26k
833
1.26k
  Token Tok;
834
1.42k
  do PP.Lex(Tok);
835
1.42k
  while (Tok.isNot(tok::eof));
836
1.26k
837
1.26k
  SmallVector<id_macro_pair, 128> MacrosByID;
838
1.26k
  for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
839
464k
       I != E; 
++I463k
) {
840
463k
    auto *MD = I->second.getLatest();
841
463k
    if (MD && MD->isDefined())
842
463k
      MacrosByID.push_back(id_macro_pair(I->first, MD->getMacroInfo()));
843
463k
  }
844
1.26k
  llvm::array_pod_sort(MacrosByID.begin(), MacrosByID.end(), MacroIDCompare);
845
1.26k
846
464k
  for (unsigned i = 0, e = MacrosByID.size(); i != e; 
++i463k
) {
847
463k
    MacroInfo &MI = *MacrosByID[i].second;
848
463k
    // Ignore computed macros like __LINE__ and friends.
849
463k
    if (MI.isBuiltinMacro()) 
continue31.7k
;
850
431k
851
431k
    PrintMacroDefinition(*MacrosByID[i].first, MI, PP, *OS);
852
431k
    *OS << '\n';
853
431k
  }
854
1.26k
}
855
856
/// DoPrintPreprocessedInput - This implements -E mode.
857
///
858
void clang::DoPrintPreprocessedInput(Preprocessor &PP, raw_ostream *OS,
859
1.75k
                                     const PreprocessorOutputOptions &Opts) {
860
1.75k
  // Show macros with no output is handled specially.
861
1.75k
  if (!Opts.ShowCPP) {
862
1.26k
    assert(Opts.ShowMacros && "Not yet implemented!");
863
1.26k
    DoPrintMacros(PP, OS);
864
1.26k
    return;
865
1.26k
  }
866
487
867
487
  // Inform the preprocessor whether we want it to retain comments or not, due
868
487
  // to -C or -CC.
869
487
  PP.SetCommentRetentionState(Opts.ShowComments, Opts.ShowMacroComments);
870
487
871
487
  PrintPPOutputPPCallbacks *Callbacks = new PrintPPOutputPPCallbacks(
872
487
      PP, *OS, !Opts.ShowLineMarkers, Opts.ShowMacros,
873
487
      Opts.ShowIncludeDirectives, Opts.UseLineDirectives);
874
487
875
487
  // Expand macros in pragmas with -fms-extensions.  The assumption is that
876
487
  // the majority of pragmas in such a file will be Microsoft pragmas.
877
487
  // Remember the handlers we will add so that we can remove them later.
878
487
  std::unique_ptr<UnknownPragmaHandler> MicrosoftExtHandler(
879
487
      new UnknownPragmaHandler(
880
487
          "#pragma", Callbacks,
881
487
          /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt));
882
487
883
487
  std::unique_ptr<UnknownPragmaHandler> GCCHandler(new UnknownPragmaHandler(
884
487
      "#pragma GCC", Callbacks,
885
487
      /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt));
886
487
887
487
  std::unique_ptr<UnknownPragmaHandler> ClangHandler(new UnknownPragmaHandler(
888
487
      "#pragma clang", Callbacks,
889
487
      /*RequireTokenExpansion=*/PP.getLangOpts().MicrosoftExt));
890
487
891
487
  PP.AddPragmaHandler(MicrosoftExtHandler.get());
892
487
  PP.AddPragmaHandler("GCC", GCCHandler.get());
893
487
  PP.AddPragmaHandler("clang", ClangHandler.get());
894
487
895
487
  // The tokens after pragma omp need to be expanded.
896
487
  //
897
487
  //  OpenMP [2.1, Directive format]
898
487
  //  Preprocessing tokens following the #pragma omp are subject to macro
899
487
  //  replacement.
900
487
  std::unique_ptr<UnknownPragmaHandler> OpenMPHandler(
901
487
      new UnknownPragmaHandler("#pragma omp", Callbacks,
902
487
                               /*RequireTokenExpansion=*/true));
903
487
  PP.AddPragmaHandler("omp", OpenMPHandler.get());
904
487
905
487
  PP.addPPCallbacks(std::unique_ptr<PPCallbacks>(Callbacks));
906
487
907
487
  // After we have configured the preprocessor, enter the main file.
908
487
  PP.EnterMainSourceFile();
909
487
910
487
  // Consume all of the tokens that come from the predefines buffer.  Those
911
487
  // should not be emitted into the output and are guaranteed to be at the
912
487
  // start.
913
487
  const SourceManager &SourceMgr = PP.getSourceManager();
914
487
  Token Tok;
915
487
  do {
916
487
    PP.Lex(Tok);
917
487
    if (Tok.is(tok::eof) || 
!Tok.getLocation().isFileID()397
)
918
133
      break;
919
354
920
354
    PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation());
921
354
    if (PLoc.isInvalid())
922
0
      break;
923
354
924
354
    if (strcmp(PLoc.getFilename(), "<built-in>"))
925
354
      break;
926
0
  } while (true);
927
487
928
487
  // Read all the preprocessed tokens, printing them out to the stream.
929
487
  PrintPreprocessedTokens(PP, Tok, Callbacks, *OS);
930
487
  *OS << '\n';
931
487
932
487
  // Remove the handlers we just added to leave the preprocessor in a sane state
933
487
  // so that it can be reused (for example by a clang::Parser instance).
934
487
  PP.RemovePragmaHandler(MicrosoftExtHandler.get());
935
487
  PP.RemovePragmaHandler("GCC", GCCHandler.get());
936
487
  PP.RemovePragmaHandler("clang", ClangHandler.get());
937
487
  PP.RemovePragmaHandler("omp", OpenMPHandler.get());
938
487
}