• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===--- PPLexerChange.cpp - Handle changing lexers in the preprocessor ---===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements pieces of the Preprocessor interface that manage the
11 // current lexer stack.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/Lex/Preprocessor.h"
16 #include "clang/Basic/FileManager.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "clang/Lex/HeaderSearch.h"
19 #include "clang/Lex/LexDiagnostic.h"
20 #include "clang/Lex/MacroInfo.h"
21 #include "llvm/ADT/StringSwitch.h"
22 #include "llvm/Support/FileSystem.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 #include "llvm/Support/Path.h"
25 using namespace clang;
26 
~PPCallbacks()27 PPCallbacks::~PPCallbacks() {}
28 
29 //===----------------------------------------------------------------------===//
30 // Miscellaneous Methods.
31 //===----------------------------------------------------------------------===//
32 
33 /// isInPrimaryFile - Return true if we're in the top-level file, not in a
34 /// \#include.  This looks through macro expansions and active _Pragma lexers.
isInPrimaryFile() const35 bool Preprocessor::isInPrimaryFile() const {
36   if (IsFileLexer())
37     return IncludeMacroStack.empty();
38 
39   // If there are any stacked lexers, we're in a #include.
40   assert(IsFileLexer(IncludeMacroStack[0]) &&
41          "Top level include stack isn't our primary lexer?");
42   for (unsigned i = 1, e = IncludeMacroStack.size(); i != e; ++i)
43     if (IsFileLexer(IncludeMacroStack[i]))
44       return false;
45   return true;
46 }
47 
48 /// getCurrentLexer - Return the current file lexer being lexed from.  Note
49 /// that this ignores any potentially active macro expansions and _Pragma
50 /// expansions going on at the time.
getCurrentFileLexer() const51 PreprocessorLexer *Preprocessor::getCurrentFileLexer() const {
52   if (IsFileLexer())
53     return CurPPLexer;
54 
55   // Look for a stacked lexer.
56   for (unsigned i = IncludeMacroStack.size(); i != 0; --i) {
57     const IncludeStackInfo& ISI = IncludeMacroStack[i-1];
58     if (IsFileLexer(ISI))
59       return ISI.ThePPLexer;
60   }
61   return nullptr;
62 }
63 
64 
65 //===----------------------------------------------------------------------===//
66 // Methods for Entering and Callbacks for leaving various contexts
67 //===----------------------------------------------------------------------===//
68 
69 /// EnterSourceFile - Add a source file to the top of the include stack and
70 /// start lexing tokens from it instead of the current buffer.
EnterSourceFile(FileID FID,const DirectoryLookup * CurDir,SourceLocation Loc)71 bool Preprocessor::EnterSourceFile(FileID FID, const DirectoryLookup *CurDir,
72                                    SourceLocation Loc) {
73   assert(!CurTokenLexer && "Cannot #include a file inside a macro!");
74   ++NumEnteredSourceFiles;
75 
76   if (MaxIncludeStackDepth < IncludeMacroStack.size())
77     MaxIncludeStackDepth = IncludeMacroStack.size();
78 
79   if (PTH) {
80     if (PTHLexer *PL = PTH->CreateLexer(FID)) {
81       EnterSourceFileWithPTH(PL, CurDir);
82       return false;
83     }
84   }
85 
86   // Get the MemoryBuffer for this FID, if it fails, we fail.
87   bool Invalid = false;
88   const llvm::MemoryBuffer *InputFile =
89     getSourceManager().getBuffer(FID, Loc, &Invalid);
90   if (Invalid) {
91     SourceLocation FileStart = SourceMgr.getLocForStartOfFile(FID);
92     Diag(Loc, diag::err_pp_error_opening_file)
93       << std::string(SourceMgr.getBufferName(FileStart)) << "";
94     return true;
95   }
96 
97   if (isCodeCompletionEnabled() &&
98       SourceMgr.getFileEntryForID(FID) == CodeCompletionFile) {
99     CodeCompletionFileLoc = SourceMgr.getLocForStartOfFile(FID);
100     CodeCompletionLoc =
101         CodeCompletionFileLoc.getLocWithOffset(CodeCompletionOffset);
102   }
103 
104   EnterSourceFileWithLexer(new Lexer(FID, InputFile, *this), CurDir);
105   return false;
106 }
107 
108 /// EnterSourceFileWithLexer - Add a source file to the top of the include stack
109 ///  and start lexing tokens from it instead of the current buffer.
EnterSourceFileWithLexer(Lexer * TheLexer,const DirectoryLookup * CurDir)110 void Preprocessor::EnterSourceFileWithLexer(Lexer *TheLexer,
111                                             const DirectoryLookup *CurDir) {
112 
113   // Add the current lexer to the include stack.
114   if (CurPPLexer || CurTokenLexer)
115     PushIncludeMacroStack();
116 
117   CurLexer.reset(TheLexer);
118   CurPPLexer = TheLexer;
119   CurDirLookup = CurDir;
120   CurSubmodule = nullptr;
121   if (CurLexerKind != CLK_LexAfterModuleImport)
122     CurLexerKind = CLK_Lexer;
123 
124   // Notify the client, if desired, that we are in a new source file.
125   if (Callbacks && !CurLexer->Is_PragmaLexer) {
126     SrcMgr::CharacteristicKind FileType =
127        SourceMgr.getFileCharacteristic(CurLexer->getFileLoc());
128 
129     Callbacks->FileChanged(CurLexer->getFileLoc(),
130                            PPCallbacks::EnterFile, FileType);
131   }
132 }
133 
134 /// EnterSourceFileWithPTH - Add a source file to the top of the include stack
135 /// and start getting tokens from it using the PTH cache.
EnterSourceFileWithPTH(PTHLexer * PL,const DirectoryLookup * CurDir)136 void Preprocessor::EnterSourceFileWithPTH(PTHLexer *PL,
137                                           const DirectoryLookup *CurDir) {
138 
139   if (CurPPLexer || CurTokenLexer)
140     PushIncludeMacroStack();
141 
142   CurDirLookup = CurDir;
143   CurPTHLexer.reset(PL);
144   CurPPLexer = CurPTHLexer.get();
145   CurSubmodule = nullptr;
146   if (CurLexerKind != CLK_LexAfterModuleImport)
147     CurLexerKind = CLK_PTHLexer;
148 
149   // Notify the client, if desired, that we are in a new source file.
150   if (Callbacks) {
151     FileID FID = CurPPLexer->getFileID();
152     SourceLocation EnterLoc = SourceMgr.getLocForStartOfFile(FID);
153     SrcMgr::CharacteristicKind FileType =
154       SourceMgr.getFileCharacteristic(EnterLoc);
155     Callbacks->FileChanged(EnterLoc, PPCallbacks::EnterFile, FileType);
156   }
157 }
158 
159 /// EnterMacro - Add a Macro to the top of the include stack and start lexing
160 /// tokens from it instead of the current buffer.
EnterMacro(Token & Tok,SourceLocation ILEnd,MacroInfo * Macro,MacroArgs * Args)161 void Preprocessor::EnterMacro(Token &Tok, SourceLocation ILEnd,
162                               MacroInfo *Macro, MacroArgs *Args) {
163   TokenLexer *TokLexer;
164   if (NumCachedTokenLexers == 0) {
165     TokLexer = new TokenLexer(Tok, ILEnd, Macro, Args, *this);
166   } else {
167     TokLexer = TokenLexerCache[--NumCachedTokenLexers];
168     TokLexer->Init(Tok, ILEnd, Macro, Args);
169   }
170 
171   PushIncludeMacroStack();
172   CurDirLookup = nullptr;
173   CurTokenLexer.reset(TokLexer);
174   if (CurLexerKind != CLK_LexAfterModuleImport)
175     CurLexerKind = CLK_TokenLexer;
176 }
177 
178 /// EnterTokenStream - Add a "macro" context to the top of the include stack,
179 /// which will cause the lexer to start returning the specified tokens.
180 ///
181 /// If DisableMacroExpansion is true, tokens lexed from the token stream will
182 /// not be subject to further macro expansion.  Otherwise, these tokens will
183 /// be re-macro-expanded when/if expansion is enabled.
184 ///
185 /// If OwnsTokens is false, this method assumes that the specified stream of
186 /// tokens has a permanent owner somewhere, so they do not need to be copied.
187 /// If it is true, it assumes the array of tokens is allocated with new[] and
188 /// must be freed.
189 ///
EnterTokenStream(const Token * Toks,unsigned NumToks,bool DisableMacroExpansion,bool OwnsTokens)190 void Preprocessor::EnterTokenStream(const Token *Toks, unsigned NumToks,
191                                     bool DisableMacroExpansion,
192                                     bool OwnsTokens) {
193   // Create a macro expander to expand from the specified token stream.
194   TokenLexer *TokLexer;
195   if (NumCachedTokenLexers == 0) {
196     TokLexer = new TokenLexer(Toks, NumToks, DisableMacroExpansion,
197                               OwnsTokens, *this);
198   } else {
199     TokLexer = TokenLexerCache[--NumCachedTokenLexers];
200     TokLexer->Init(Toks, NumToks, DisableMacroExpansion, OwnsTokens);
201   }
202 
203   // Save our current state.
204   PushIncludeMacroStack();
205   CurDirLookup = nullptr;
206   CurTokenLexer.reset(TokLexer);
207   if (CurLexerKind != CLK_LexAfterModuleImport)
208     CurLexerKind = CLK_TokenLexer;
209 }
210 
211 /// \brief Compute the relative path that names the given file relative to
212 /// the given directory.
computeRelativePath(FileManager & FM,const DirectoryEntry * Dir,const FileEntry * File,SmallString<128> & Result)213 static void computeRelativePath(FileManager &FM, const DirectoryEntry *Dir,
214                                 const FileEntry *File,
215                                 SmallString<128> &Result) {
216   Result.clear();
217 
218   StringRef FilePath = File->getDir()->getName();
219   StringRef Path = FilePath;
220   while (!Path.empty()) {
221     if (const DirectoryEntry *CurDir = FM.getDirectory(Path)) {
222       if (CurDir == Dir) {
223         Result = FilePath.substr(Path.size());
224         llvm::sys::path::append(Result,
225                                 llvm::sys::path::filename(File->getName()));
226         return;
227       }
228     }
229 
230     Path = llvm::sys::path::parent_path(Path);
231   }
232 
233   Result = File->getName();
234 }
235 
PropagateLineStartLeadingSpaceInfo(Token & Result)236 void Preprocessor::PropagateLineStartLeadingSpaceInfo(Token &Result) {
237   if (CurTokenLexer) {
238     CurTokenLexer->PropagateLineStartLeadingSpaceInfo(Result);
239     return;
240   }
241   if (CurLexer) {
242     CurLexer->PropagateLineStartLeadingSpaceInfo(Result);
243     return;
244   }
245   // FIXME: Handle other kinds of lexers?  It generally shouldn't matter,
246   // but it might if they're empty?
247 }
248 
249 /// \brief Determine the location to use as the end of the buffer for a lexer.
250 ///
251 /// If the file ends with a newline, form the EOF token on the newline itself,
252 /// rather than "on the line following it", which doesn't exist.  This makes
253 /// diagnostics relating to the end of file include the last file that the user
254 /// actually typed, which is goodness.
getCurLexerEndPos()255 const char *Preprocessor::getCurLexerEndPos() {
256   const char *EndPos = CurLexer->BufferEnd;
257   if (EndPos != CurLexer->BufferStart &&
258       (EndPos[-1] == '\n' || EndPos[-1] == '\r')) {
259     --EndPos;
260 
261     // Handle \n\r and \r\n:
262     if (EndPos != CurLexer->BufferStart &&
263         (EndPos[-1] == '\n' || EndPos[-1] == '\r') &&
264         EndPos[-1] != EndPos[0])
265       --EndPos;
266   }
267 
268   return EndPos;
269 }
270 
271 
272 /// HandleEndOfFile - This callback is invoked when the lexer hits the end of
273 /// the current file.  This either returns the EOF token or pops a level off
274 /// the include stack and keeps going.
HandleEndOfFile(Token & Result,bool isEndOfMacro)275 bool Preprocessor::HandleEndOfFile(Token &Result, bool isEndOfMacro) {
276   assert(!CurTokenLexer &&
277          "Ending a file when currently in a macro!");
278 
279   // See if this file had a controlling macro.
280   if (CurPPLexer) {  // Not ending a macro, ignore it.
281     if (const IdentifierInfo *ControllingMacro =
282           CurPPLexer->MIOpt.GetControllingMacroAtEndOfFile()) {
283       // Okay, this has a controlling macro, remember in HeaderFileInfo.
284       if (const FileEntry *FE =
285             SourceMgr.getFileEntryForID(CurPPLexer->getFileID())) {
286         HeaderInfo.SetFileControllingMacro(FE, ControllingMacro);
287         if (MacroInfo *MI =
288               getMacroInfo(const_cast<IdentifierInfo*>(ControllingMacro))) {
289           MI->UsedForHeaderGuard = true;
290         }
291         if (const IdentifierInfo *DefinedMacro =
292               CurPPLexer->MIOpt.GetDefinedMacro()) {
293           if (!ControllingMacro->hasMacroDefinition() &&
294               DefinedMacro != ControllingMacro &&
295               HeaderInfo.FirstTimeLexingFile(FE)) {
296 
297             // If the edit distance between the two macros is more than 50%,
298             // DefinedMacro may not be header guard, or can be header guard of
299             // another header file. Therefore, it maybe defining something
300             // completely different. This can be observed in the wild when
301             // handling feature macros or header guards in different files.
302 
303             const StringRef ControllingMacroName = ControllingMacro->getName();
304             const StringRef DefinedMacroName = DefinedMacro->getName();
305             const size_t MaxHalfLength = std::max(ControllingMacroName.size(),
306                                                   DefinedMacroName.size()) / 2;
307             const unsigned ED = ControllingMacroName.edit_distance(
308                 DefinedMacroName, true, MaxHalfLength);
309             if (ED <= MaxHalfLength) {
310               // Emit a warning for a bad header guard.
311               Diag(CurPPLexer->MIOpt.GetMacroLocation(),
312                    diag::warn_header_guard)
313                   << CurPPLexer->MIOpt.GetMacroLocation() << ControllingMacro;
314               Diag(CurPPLexer->MIOpt.GetDefinedLocation(),
315                    diag::note_header_guard)
316                   << CurPPLexer->MIOpt.GetDefinedLocation() << DefinedMacro
317                   << ControllingMacro
318                   << FixItHint::CreateReplacement(
319                          CurPPLexer->MIOpt.GetDefinedLocation(),
320                          ControllingMacro->getName());
321             }
322           }
323         }
324       }
325     }
326   }
327 
328   // Complain about reaching a true EOF within arc_cf_code_audited.
329   // We don't want to complain about reaching the end of a macro
330   // instantiation or a _Pragma.
331   if (PragmaARCCFCodeAuditedLoc.isValid() &&
332       !isEndOfMacro && !(CurLexer && CurLexer->Is_PragmaLexer)) {
333     Diag(PragmaARCCFCodeAuditedLoc, diag::err_pp_eof_in_arc_cf_code_audited);
334 
335     // Recover by leaving immediately.
336     PragmaARCCFCodeAuditedLoc = SourceLocation();
337   }
338 
339   // If this is a #include'd file, pop it off the include stack and continue
340   // lexing the #includer file.
341   if (!IncludeMacroStack.empty()) {
342 
343     // If we lexed the code-completion file, act as if we reached EOF.
344     if (isCodeCompletionEnabled() && CurPPLexer &&
345         SourceMgr.getLocForStartOfFile(CurPPLexer->getFileID()) ==
346             CodeCompletionFileLoc) {
347       if (CurLexer) {
348         Result.startToken();
349         CurLexer->FormTokenWithChars(Result, CurLexer->BufferEnd, tok::eof);
350         CurLexer.reset();
351       } else {
352         assert(CurPTHLexer && "Got EOF but no current lexer set!");
353         CurPTHLexer->getEOF(Result);
354         CurPTHLexer.reset();
355       }
356 
357       CurPPLexer = nullptr;
358       return true;
359     }
360 
361     if (!isEndOfMacro && CurPPLexer &&
362         SourceMgr.getIncludeLoc(CurPPLexer->getFileID()).isValid()) {
363       // Notify SourceManager to record the number of FileIDs that were created
364       // during lexing of the #include'd file.
365       unsigned NumFIDs =
366           SourceMgr.local_sloc_entry_size() -
367           CurPPLexer->getInitialNumSLocEntries() + 1/*#include'd file*/;
368       SourceMgr.setNumCreatedFIDsForFileID(CurPPLexer->getFileID(), NumFIDs);
369     }
370 
371     FileID ExitedFID;
372     if (Callbacks && !isEndOfMacro && CurPPLexer)
373       ExitedFID = CurPPLexer->getFileID();
374 
375     bool LeavingSubmodule = CurSubmodule && CurLexer;
376     if (LeavingSubmodule) {
377       // Notify the parser that we've left the module.
378       const char *EndPos = getCurLexerEndPos();
379       Result.startToken();
380       CurLexer->BufferPtr = EndPos;
381       CurLexer->FormTokenWithChars(Result, EndPos, tok::annot_module_end);
382       Result.setAnnotationEndLoc(Result.getLocation());
383       Result.setAnnotationValue(CurSubmodule);
384     }
385 
386     // We're done with the #included file.
387     RemoveTopOfLexerStack();
388 
389     // Propagate info about start-of-line/leading white-space/etc.
390     PropagateLineStartLeadingSpaceInfo(Result);
391 
392     // Notify the client, if desired, that we are in a new source file.
393     if (Callbacks && !isEndOfMacro && CurPPLexer) {
394       SrcMgr::CharacteristicKind FileType =
395         SourceMgr.getFileCharacteristic(CurPPLexer->getSourceLocation());
396       Callbacks->FileChanged(CurPPLexer->getSourceLocation(),
397                              PPCallbacks::ExitFile, FileType, ExitedFID);
398     }
399 
400     // Client should lex another token unless we generated an EOM.
401     return LeavingSubmodule;
402   }
403 
404   // If this is the end of the main file, form an EOF token.
405   if (CurLexer) {
406     const char *EndPos = getCurLexerEndPos();
407     Result.startToken();
408     CurLexer->BufferPtr = EndPos;
409     CurLexer->FormTokenWithChars(Result, EndPos, tok::eof);
410 
411     if (isCodeCompletionEnabled()) {
412       // Inserting the code-completion point increases the source buffer by 1,
413       // but the main FileID was created before inserting the point.
414       // Compensate by reducing the EOF location by 1, otherwise the location
415       // will point to the next FileID.
416       // FIXME: This is hacky, the code-completion point should probably be
417       // inserted before the main FileID is created.
418       if (CurLexer->getFileLoc() == CodeCompletionFileLoc)
419         Result.setLocation(Result.getLocation().getLocWithOffset(-1));
420     }
421 
422     if (!isIncrementalProcessingEnabled())
423       // We're done with lexing.
424       CurLexer.reset();
425   } else {
426     assert(CurPTHLexer && "Got EOF but no current lexer set!");
427     CurPTHLexer->getEOF(Result);
428     CurPTHLexer.reset();
429   }
430 
431   if (!isIncrementalProcessingEnabled())
432     CurPPLexer = nullptr;
433 
434   if (TUKind == TU_Complete) {
435     // This is the end of the top-level file. 'WarnUnusedMacroLocs' has
436     // collected all macro locations that we need to warn because they are not
437     // used.
438     for (WarnUnusedMacroLocsTy::iterator
439            I=WarnUnusedMacroLocs.begin(), E=WarnUnusedMacroLocs.end();
440            I!=E; ++I)
441       Diag(*I, diag::pp_macro_not_used);
442   }
443 
444   // If we are building a module that has an umbrella header, make sure that
445   // each of the headers within the directory covered by the umbrella header
446   // was actually included by the umbrella header.
447   if (Module *Mod = getCurrentModule()) {
448     if (Mod->getUmbrellaHeader()) {
449       SourceLocation StartLoc
450         = SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
451 
452       if (!getDiagnostics().isIgnored(diag::warn_uncovered_module_header,
453                                       StartLoc)) {
454         ModuleMap &ModMap = getHeaderSearchInfo().getModuleMap();
455         const DirectoryEntry *Dir = Mod->getUmbrellaDir();
456         vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
457         std::error_code EC;
458         for (vfs::recursive_directory_iterator Entry(FS, Dir->getName(), EC), End;
459              Entry != End && !EC; Entry.increment(EC)) {
460           using llvm::StringSwitch;
461 
462           // Check whether this entry has an extension typically associated with
463           // headers.
464           if (!StringSwitch<bool>(llvm::sys::path::extension(Entry->getName()))
465                  .Cases(".h", ".H", ".hh", ".hpp", true)
466                  .Default(false))
467             continue;
468 
469           if (const FileEntry *Header =
470                   getFileManager().getFile(Entry->getName()))
471             if (!getSourceManager().hasFileInfo(Header)) {
472               if (!ModMap.isHeaderInUnavailableModule(Header)) {
473                 // Find the relative path that would access this header.
474                 SmallString<128> RelativePath;
475                 computeRelativePath(FileMgr, Dir, Header, RelativePath);
476                 Diag(StartLoc, diag::warn_uncovered_module_header)
477                   << Mod->getFullModuleName() << RelativePath;
478               }
479             }
480         }
481       }
482     }
483 
484     // Check whether there are any headers that were included, but not
485     // mentioned at all in the module map. Such headers
486     SourceLocation StartLoc
487       = SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
488     if (!getDiagnostics().isIgnored(diag::warn_forgotten_module_header,
489                                     StartLoc)) {
490       ModuleMap &ModMap = getHeaderSearchInfo().getModuleMap();
491       for (unsigned I = 0, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
492         // We only care about file entries.
493         const SrcMgr::SLocEntry &Entry = SourceMgr.getLocalSLocEntry(I);
494         if (!Entry.isFile())
495           continue;
496 
497         // Dig out the actual file.
498         const FileEntry *File = Entry.getFile().getContentCache()->OrigEntry;
499         if (!File)
500           continue;
501 
502         // If it's not part of a module and not unknown, complain.
503         if (!ModMap.findModuleForHeader(File) &&
504             !ModMap.isHeaderInUnavailableModule(File)) {
505           Diag(StartLoc, diag::warn_forgotten_module_header)
506             << File->getName() << Mod->getFullModuleName();
507         }
508       }
509     }
510   }
511 
512   return true;
513 }
514 
515 /// HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer
516 /// hits the end of its token stream.
HandleEndOfTokenLexer(Token & Result)517 bool Preprocessor::HandleEndOfTokenLexer(Token &Result) {
518   assert(CurTokenLexer && !CurPPLexer &&
519          "Ending a macro when currently in a #include file!");
520 
521   if (!MacroExpandingLexersStack.empty() &&
522       MacroExpandingLexersStack.back().first == CurTokenLexer.get())
523     removeCachedMacroExpandedTokensOfLastLexer();
524 
525   // Delete or cache the now-dead macro expander.
526   if (NumCachedTokenLexers == TokenLexerCacheSize)
527     CurTokenLexer.reset();
528   else
529     TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.release();
530 
531   // Handle this like a #include file being popped off the stack.
532   return HandleEndOfFile(Result, true);
533 }
534 
535 /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the
536 /// lexer stack.  This should only be used in situations where the current
537 /// state of the top-of-stack lexer is unknown.
RemoveTopOfLexerStack()538 void Preprocessor::RemoveTopOfLexerStack() {
539   assert(!IncludeMacroStack.empty() && "Ran out of stack entries to load");
540 
541   if (CurTokenLexer) {
542     // Delete or cache the now-dead macro expander.
543     if (NumCachedTokenLexers == TokenLexerCacheSize)
544       CurTokenLexer.reset();
545     else
546       TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.release();
547   }
548 
549   PopIncludeMacroStack();
550 }
551 
552 /// HandleMicrosoftCommentPaste - When the macro expander pastes together a
553 /// comment (/##/) in microsoft mode, this method handles updating the current
554 /// state, returning the token on the next source line.
HandleMicrosoftCommentPaste(Token & Tok)555 void Preprocessor::HandleMicrosoftCommentPaste(Token &Tok) {
556   assert(CurTokenLexer && !CurPPLexer &&
557          "Pasted comment can only be formed from macro");
558 
559   // We handle this by scanning for the closest real lexer, switching it to
560   // raw mode and preprocessor mode.  This will cause it to return \n as an
561   // explicit EOD token.
562   PreprocessorLexer *FoundLexer = nullptr;
563   bool LexerWasInPPMode = false;
564   for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) {
565     IncludeStackInfo &ISI = *(IncludeMacroStack.end()-i-1);
566     if (ISI.ThePPLexer == nullptr) continue;  // Scan for a real lexer.
567 
568     // Once we find a real lexer, mark it as raw mode (disabling macro
569     // expansions) and preprocessor mode (return EOD).  We know that the lexer
570     // was *not* in raw mode before, because the macro that the comment came
571     // from was expanded.  However, it could have already been in preprocessor
572     // mode (#if COMMENT) in which case we have to return it to that mode and
573     // return EOD.
574     FoundLexer = ISI.ThePPLexer;
575     FoundLexer->LexingRawMode = true;
576     LexerWasInPPMode = FoundLexer->ParsingPreprocessorDirective;
577     FoundLexer->ParsingPreprocessorDirective = true;
578     break;
579   }
580 
581   // Okay, we either found and switched over the lexer, or we didn't find a
582   // lexer.  In either case, finish off the macro the comment came from, getting
583   // the next token.
584   if (!HandleEndOfTokenLexer(Tok)) Lex(Tok);
585 
586   // Discarding comments as long as we don't have EOF or EOD.  This 'comments
587   // out' the rest of the line, including any tokens that came from other macros
588   // that were active, as in:
589   //  #define submacro a COMMENT b
590   //    submacro c
591   // which should lex to 'a' only: 'b' and 'c' should be removed.
592   while (Tok.isNot(tok::eod) && Tok.isNot(tok::eof))
593     Lex(Tok);
594 
595   // If we got an eod token, then we successfully found the end of the line.
596   if (Tok.is(tok::eod)) {
597     assert(FoundLexer && "Can't get end of line without an active lexer");
598     // Restore the lexer back to normal mode instead of raw mode.
599     FoundLexer->LexingRawMode = false;
600 
601     // If the lexer was already in preprocessor mode, just return the EOD token
602     // to finish the preprocessor line.
603     if (LexerWasInPPMode) return;
604 
605     // Otherwise, switch out of PP mode and return the next lexed token.
606     FoundLexer->ParsingPreprocessorDirective = false;
607     return Lex(Tok);
608   }
609 
610   // If we got an EOF token, then we reached the end of the token stream but
611   // didn't find an explicit \n.  This can only happen if there was no lexer
612   // active (an active lexer would return EOD at EOF if there was no \n in
613   // preprocessor directive mode), so just return EOF as our token.
614   assert(!FoundLexer && "Lexer should return EOD before EOF in PP mode");
615 }
616