summaryrefslogtreecommitdiffstats
path: root/clang/Driver/PrintPreprocessedOutput.cpp
blob: f54e52cf9b0513c31b03c500942c9e22457b36cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
//===--- PrintPreprocessedOutput.cpp - Implement the -E mode --------------===//
//
//                     The LLVM Compiler Infrastructure
//
// This file was developed by Chris Lattner and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This code simply runs the preprocessor on the input file and prints out the
// result.  This is the traditional behavior of the -E option.
//
//===----------------------------------------------------------------------===//

#include "clang.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Lex/Pragma.h"
#include "clang/Basic/SourceManager.h"
#include "llvm/Support/CommandLine.h"
// NOTE: we use stdio because it is empirically much faster than iostreams.
#include <cstdio>
using namespace llvm;
using namespace clang;

static cl::opt<bool>
DisableLineMarkers("P", cl::desc("Disable linemarker output in -E mode"));

static unsigned EModeCurLine;
static std::string EModeCurFilename;
static Preprocessor *EModePP;
static bool EmodeEmittedTokensOnThisLine;
static DirectoryLookup::DirType EmodeFileType =DirectoryLookup::NormalHeaderDir;

static void MoveToLine(SourceLocation Loc) {
  if (DisableLineMarkers) return;

  unsigned LineNo = EModePP->getSourceManager().getLineNumber(Loc);
  
  // If this line is "close enough" to the original line, just print newlines,
  // otherwise print a #line directive.
  if (LineNo-EModeCurLine < 8) {
    unsigned CurLine = EModeCurLine;
    for (; CurLine != LineNo; ++CurLine)
      putchar_unlocked('\n');
    EModeCurLine = CurLine;
  } else {
    if (EmodeEmittedTokensOnThisLine) {
      putchar_unlocked('\n');
      EmodeEmittedTokensOnThisLine = false;
    }
    
    EModeCurLine = LineNo;
    if (DisableLineMarkers) return;
    
    printf("# %d %s", LineNo, EModeCurFilename.c_str());
    
    if (EmodeFileType == DirectoryLookup::SystemHeaderDir)
      printf(" 3");
    else if (EmodeFileType == DirectoryLookup::ExternCSystemHeaderDir)
      printf(" 3 4");
    putchar_unlocked('\n');
  } 
}

/// HandleFileChange - Whenever the preprocessor enters or exits a #include file
/// it invokes this handler.  Update our conception of the current 
static void HandleFileChange(SourceLocation Loc,
                             Preprocessor::FileChangeReason Reason,
                             DirectoryLookup::DirType FileType) {
  if (DisableLineMarkers) return;

  // Unless we are exiting a #include, make sure to skip ahead to the line the
  // #include directive was at.
  SourceManager &SourceMgr = EModePP->getSourceManager();
  if (Reason == Preprocessor::EnterFile) {
    MoveToLine(SourceMgr.getIncludeLoc(Loc.getFileID()));
  } else if (Reason == Preprocessor::SystemHeaderPragma) {
    MoveToLine(Loc);
    
    // TODO GCC emits the # directive for this directive on the line AFTER the
    // directive and emits a bunch of spaces that aren't needed.  Emulate this
    // strange behavior.
  }
  
  EModeCurLine = SourceMgr.getLineNumber(Loc);
  EModeCurFilename = Lexer::Stringify(SourceMgr.getSourceName(Loc));
  EmodeFileType = FileType;
  
  if (EmodeEmittedTokensOnThisLine) {
    putchar_unlocked('\n');
    EmodeEmittedTokensOnThisLine = false;
  }
  
  if (DisableLineMarkers) return;
  
  printf("# %d %s", EModeCurLine, EModeCurFilename.c_str());
  switch (Reason) {
  case Preprocessor::EnterFile:
    printf(" 1");
    break;
  case Preprocessor::ExitFile:
    printf(" 2");
    break;
  case Preprocessor::SystemHeaderPragma: break;
  case Preprocessor::RenameFile: break;
  }
  
  if (FileType == DirectoryLookup::SystemHeaderDir)
    printf(" 3");
  else if (FileType == DirectoryLookup::ExternCSystemHeaderDir)
    printf(" 3 4");
  
  putchar_unlocked('\n');
}

static void HandleIdent(SourceLocation Loc, const std::string &Val) {
  MoveToLine(Loc);
  
  printf("#ident %s", Val.c_str());
  EmodeEmittedTokensOnThisLine = true;
}

/// HandleFirstTokOnLine - When emitting a preprocessed file in -E mode, this
/// is called for the first token on each new line.
static void HandleFirstTokOnLine(LexerToken &Tok, Preprocessor &PP) {
  // Figure out what line we went to and insert the appropriate number of
  // newline characters.
  MoveToLine(Tok.getLocation());
  
  // Print out space characters so that the first token on a line is
  // indented for easy reading.
  unsigned ColNo = 
    PP.getSourceManager().getColumnNumber(Tok.getLocation());
  
  // This hack prevents stuff like:
  // #define HASH #
  // HASH define foo bar
  // From having the # character end up at column 1, which makes it so it
  // is not handled as a #define next time through the preprocessor if in
  // -fpreprocessed mode.
  if (ColNo <= 1 && Tok.getKind() == tok::hash)
    putchar_unlocked(' ');
  
  // Otherwise, indent the appropriate number of spaces.
  for (; ColNo > 1; --ColNo)
    putchar_unlocked(' ');
}

namespace {
struct UnknownPragmaHandler : public PragmaHandler {
  const char *Prefix;
  UnknownPragmaHandler(const char *prefix) : PragmaHandler(0), Prefix(prefix) {}
  virtual void HandlePragma(Preprocessor &PP, LexerToken &PragmaTok) {
    // Figure out what line we went to and insert the appropriate number of
    // newline characters.
    MoveToLine(PragmaTok.getLocation());
    printf(Prefix);
    
    // Read and print all of the pragma tokens.
    while (PragmaTok.getKind() != tok::eom) {
      if (PragmaTok.hasLeadingSpace())
        putchar_unlocked(' ');
      printf("%s", PP.getSpelling(PragmaTok).c_str());
      PP.LexUnexpandedToken(PragmaTok);
    }
    putchar_unlocked('\n');
  }
};
} // end anonymous namespace

/// DoPrintPreprocessedInput - This implements -E mode.
void clang::DoPrintPreprocessedInput(Preprocessor &PP) {
  LexerToken Tok;
  char Buffer[256];
  EModeCurLine = 0;
  EModeCurFilename = "\"<uninit>\"";
  PP.setFileChangeHandler(HandleFileChange);
  PP.setIdentHandler(HandleIdent);
  EModePP = &PP;
  EmodeEmittedTokensOnThisLine = false;
  
  PP.AddPragmaHandler(0, new UnknownPragmaHandler("#pragma"));
  PP.AddPragmaHandler("GCC", new UnknownPragmaHandler("#pragma GCC"));
  do {
    PP.Lex(Tok);
    
    // If this token is at the start of a line.  Emit the \n and indentation.
    // FIXME: this shouldn't use the isAtStartOfLine flag.  This should use a
    // "newline callback" from the lexer.
    // FIXME: For some tests, this fails just because there is no col# info from
    // macro expansions!
    if (Tok.isAtStartOfLine()) {
      HandleFirstTokOnLine(Tok, PP);
    } else if (Tok.hasLeadingSpace()) {
      putchar_unlocked(' ');
    }
    
    if (Tok.getLength() < 256) {
      unsigned Len = PP.getSpelling(Tok, Buffer);
      Buffer[Len] = 0;
      fwrite(Buffer, Len, 1, stdout);
    } else {
      std::string S = PP.getSpelling(Tok);
      fwrite(&S[0], S.size(), 1, stdout);
    }
    EmodeEmittedTokensOnThisLine = true;
  } while (Tok.getKind() != tok::eof);
  putchar_unlocked('\n');
}

OpenPOWER on IntegriCloud