18c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===--- PPLexerChange.cpp - Handle changing lexers in the preprocessor ---===//
28c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//
38c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//                     The LLVM Compiler Infrastructure
48c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//
58c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner// This file is distributed under the University of Illinois Open Source
68c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner// License. See LICENSE.TXT for details.
78c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//
88c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===//
98c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//
108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner// This file implements pieces of the Preprocessor interface that manage the
118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner// current lexer stack.
128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//
138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===//
148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Lex/Preprocessor.h"
16aa93a875605536d72a10359a0098396192b7d4ecDouglas Gregor#include "clang/Basic/FileManager.h"
178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Basic/SourceManager.h"
1855fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Lex/HeaderSearch.h"
1955fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Lex/LexDiagnostic.h"
2055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Lex/MacroInfo.h"
2155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/StringSwitch.h"
22585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor#include "llvm/Support/FileSystem.h"
2315ba2af0f9ad52e67e908179b8ec2eb404e11c61Ted Kremenek#include "llvm/Support/MemoryBuffer.h"
248229d22e6449851b89361bf2f41804557328be63Rafael Espindola#include "llvm/Support/Path.h"
258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerusing namespace clang;
268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
274b391087f9c5582d448ab66ccbc7028f7673f380Ted KremenekPPCallbacks::~PPCallbacks() {}
288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===//
306b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Miscellaneous Methods.
318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===//
328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// isInPrimaryFile - Return true if we're in the top-level file, not in a
341a5f9000b690d08e65b6b8821e4f7c57d63beb1dJames Dennett/// \#include.  This looks through macro expansions and active _Pragma lexers.
358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::isInPrimaryFile() const {
3681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek  if (IsFileLexer())
378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    return IncludeMacroStack.empty();
381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // If there are any stacked lexers, we're in a #include.
4081d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek  assert(IsFileLexer(IncludeMacroStack[0]) &&
418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner         "Top level include stack isn't our primary lexer?");
428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  for (unsigned i = 1, e = IncludeMacroStack.size(); i != e; ++i)
4381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek    if (IsFileLexer(IncludeMacroStack[i]))
448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner      return false;
458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  return true;
468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
488c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// getCurrentLexer - Return the current file lexer being lexed from.  Note
498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// that this ignores any potentially active macro expansions and _Pragma
508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// expansions going on at the time.
5168e48e4a81767997ef0231e47eca4f665102c95eTed KremenekPreprocessorLexer *Preprocessor::getCurrentFileLexer() const {
5281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek  if (IsFileLexer())
5368e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek    return CurPPLexer;
541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Look for a stacked lexer.
568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  for (unsigned i = IncludeMacroStack.size(); i != 0; --i) {
5768e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek    const IncludeStackInfo& ISI = IncludeMacroStack[i-1];
5881d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek    if (IsFileLexer(ISI))
5968e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek      return ISI.ThePPLexer;
608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
616bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  return nullptr;
628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
646b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner
656b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===//
666b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Methods for Entering and Callbacks for leaving various contexts
676b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===//
688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterSourceFile - Add a source file to the top of the include stack and
70e7f2cbd8c093dcaebaa04c3f7b8fb1a0b4533b15Nuno Lopes/// start lexing tokens from it instead of the current buffer.
71651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesbool Preprocessor::EnterSourceFile(FileID FID, const DirectoryLookup *CurDir,
72e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner                                   SourceLocation Loc) {
737247c88d1e41514a41085f83ebf03dd5220e054aDavid Blaikie  assert(!CurTokenLexer && "Cannot #include a file inside a macro!");
748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  ++NumEnteredSourceFiles;
751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (MaxIncludeStackDepth < IncludeMacroStack.size())
778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    MaxIncludeStackDepth = IncludeMacroStack.size();
788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
796137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  if (PTH) {
806e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner    if (PTHLexer *PL = PTH->CreateLexer(FID)) {
816e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner      EnterSourceFileWithPTH(PL, CurDir);
82651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      return false;
836e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner    }
846137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  }
856e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner
866e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner  // Get the MemoryBuffer for this FID, if it fails, we fail.
87aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor  bool Invalid = false;
88e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner  const llvm::MemoryBuffer *InputFile =
89e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner    getSourceManager().getBuffer(FID, Loc, &Invalid);
90e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner  if (Invalid) {
91e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner    SourceLocation FileStart = SourceMgr.getLocForStartOfFile(FID);
92e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner    Diag(Loc, diag::err_pp_error_opening_file)
93e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner      << std::string(SourceMgr.getBufferName(FileStart)) << "";
94651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    return true;
95e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner  }
967d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis
977d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis  if (isCodeCompletionEnabled() &&
987d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis      SourceMgr.getFileEntryForID(FID) == CodeCompletionFile) {
997d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis    CodeCompletionFileLoc = SourceMgr.getLocForStartOfFile(FID);
1007d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis    CodeCompletionLoc =
101a64ccefdf0ea4e03ec88805d71b0af74950c7472Argyrios Kyrtzidis        CodeCompletionFileLoc.getLocWithOffset(CodeCompletionOffset);
1027d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis  }
1037d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis
1046e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner  EnterSourceFileWithLexer(new Lexer(FID, InputFile, *this), CurDir);
105651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  return false;
1061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}
107721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner
1086137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithLexer - Add a source file to the top of the include stack
1096137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek///  and start lexing tokens from it instead of the current buffer.
1101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid Preprocessor::EnterSourceFileWithLexer(Lexer *TheLexer,
1118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner                                            const DirectoryLookup *CurDir) {
1121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Add the current lexer to the include stack.
11441938c8493b4380df738263166b746eacb33c309Ted Kremenek  if (CurPPLexer || CurTokenLexer)
115ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek    PushIncludeMacroStack();
116ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek
117caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek  CurLexer.reset(TheLexer);
1189c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek  CurPPLexer = TheLexer;
1198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  CurDirLookup = CurDir;
1206bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  CurSubmodule = nullptr;
121b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor  if (CurLexerKind != CLK_LexAfterModuleImport)
122b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor    CurLexerKind = CLK_Lexer;
123b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor
1248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Notify the client, if desired, that we are in a new source file.
1258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (Callbacks && !CurLexer->Is_PragmaLexer) {
1269d72851fec9e9c62570a027d42701562bbf29751Chris Lattner    SrcMgr::CharacteristicKind FileType =
1270b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner       SourceMgr.getFileCharacteristic(CurLexer->getFileLoc());
1281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    Callbacks->FileChanged(CurLexer->getFileLoc(),
1308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner                           PPCallbacks::EnterFile, FileType);
1318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
1328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
1338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
1346137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithPTH - Add a source file to the top of the include stack
1356137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// and start getting tokens from it using the PTH cache.
1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid Preprocessor::EnterSourceFileWithPTH(PTHLexer *PL,
1376137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek                                          const DirectoryLookup *CurDir) {
1381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1396137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  if (CurPPLexer || CurTokenLexer)
1406137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek    PushIncludeMacroStack();
1418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
1426137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  CurDirLookup = CurDir;
1436137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  CurPTHLexer.reset(PL);
1446137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  CurPPLexer = CurPTHLexer.get();
1456bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  CurSubmodule = nullptr;
146b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor  if (CurLexerKind != CLK_LexAfterModuleImport)
147b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor    CurLexerKind = CLK_PTHLexer;
148b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor
1496137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  // Notify the client, if desired, that we are in a new source file.
1506137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  if (Callbacks) {
1512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner    FileID FID = CurPPLexer->getFileID();
1528c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner    SourceLocation EnterLoc = SourceMgr.getLocForStartOfFile(FID);
1538c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner    SrcMgr::CharacteristicKind FileType =
1548c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner      SourceMgr.getFileCharacteristic(EnterLoc);
1558c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner    Callbacks->FileChanged(EnterLoc, PPCallbacks::EnterFile, FileType);
1566137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek  }
1576137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek}
1588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
1598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterMacro - Add a Macro to the top of the include stack and start lexing
1608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// tokens from it instead of the current buffer.
161e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattnervoid Preprocessor::EnterMacro(Token &Tok, SourceLocation ILEnd,
162c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith                              MacroInfo *Macro, MacroArgs *Args) {
163bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  TokenLexer *TokLexer;
1648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (NumCachedTokenLexers == 0) {
165bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer = new TokenLexer(Tok, ILEnd, Macro, Args, *this);
1668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  } else {
167bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer = TokenLexerCache[--NumCachedTokenLexers];
168bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer->Init(Tok, ILEnd, Macro, Args);
1698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
170bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis
171bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  PushIncludeMacroStack();
1726bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  CurDirLookup = nullptr;
173bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  CurTokenLexer.reset(TokLexer);
174b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor  if (CurLexerKind != CLK_LexAfterModuleImport)
175b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor    CurLexerKind = CLK_TokenLexer;
1768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
1778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
1788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterTokenStream - Add a "macro" context to the top of the include stack,
1796b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// which will cause the lexer to start returning the specified tokens.
1806b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner///
1816b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If DisableMacroExpansion is true, tokens lexed from the token stream will
1826b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// not be subject to further macro expansion.  Otherwise, these tokens will
1836b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// be re-macro-expanded when/if expansion is enabled.
1846b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner///
1856b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If OwnsTokens is false, this method assumes that the specified stream of
1866b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// tokens has a permanent owner somewhere, so they do not need to be copied.
1876b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If it is true, it assumes the array of tokens is allocated with new[] and
1886b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// must be freed.
1896b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner///
1906b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattnervoid Preprocessor::EnterTokenStream(const Token *Toks, unsigned NumToks,
1916b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner                                    bool DisableMacroExpansion,
1926b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner                                    bool OwnsTokens) {
1938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Create a macro expander to expand from the specified token stream.
194bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  TokenLexer *TokLexer;
1958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (NumCachedTokenLexers == 0) {
196bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer = new TokenLexer(Toks, NumToks, DisableMacroExpansion,
197bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis                              OwnsTokens, *this);
1988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  } else {
199bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer = TokenLexerCache[--NumCachedTokenLexers];
200bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    TokLexer->Init(Toks, NumToks, DisableMacroExpansion, OwnsTokens);
2018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
202bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis
203bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  // Save our current state.
204bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  PushIncludeMacroStack();
2056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  CurDirLookup = nullptr;
206bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis  CurTokenLexer.reset(TokLexer);
207b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor  if (CurLexerKind != CLK_LexAfterModuleImport)
208b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor    CurLexerKind = CLK_TokenLexer;
2098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
2108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
211585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor/// \brief Compute the relative path that names the given file relative to
212585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor/// the given directory.
213585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregorstatic void computeRelativePath(FileManager &FM, const DirectoryEntry *Dir,
214585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor                                const FileEntry *File,
215f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith                                SmallString<128> &Result) {
216585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  Result.clear();
217585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
218585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  StringRef FilePath = File->getDir()->getName();
219585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  StringRef Path = FilePath;
220585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  while (!Path.empty()) {
221585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor    if (const DirectoryEntry *CurDir = FM.getDirectory(Path)) {
222585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor      if (CurDir == Dir) {
223585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        Result = FilePath.substr(Path.size());
224585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        llvm::sys::path::append(Result,
225585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor                                llvm::sys::path::filename(File->getName()));
226585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        return;
227585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor      }
228585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor    }
229585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
230585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor    Path = llvm::sys::path::parent_path(Path);
231585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  }
232585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
233585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  Result = File->getName();
234585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor}
235585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
236d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedmanvoid Preprocessor::PropagateLineStartLeadingSpaceInfo(Token &Result) {
237d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  if (CurTokenLexer) {
238d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    CurTokenLexer->PropagateLineStartLeadingSpaceInfo(Result);
239d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    return;
240d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  }
241d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  if (CurLexer) {
242d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    CurLexer->PropagateLineStartLeadingSpaceInfo(Result);
243d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    return;
244d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  }
245d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  // FIXME: Handle other kinds of lexers?  It generally shouldn't matter,
246d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman  // but it might if they're empty?
247d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman}
248d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman
249651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines/// \brief Determine the location to use as the end of the buffer for a lexer.
250651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines///
251651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines/// If the file ends with a newline, form the EOF token on the newline itself,
252651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines/// rather than "on the line following it", which doesn't exist.  This makes
253651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines/// diagnostics relating to the end of file include the last file that the user
254651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines/// actually typed, which is goodness.
255651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesconst char *Preprocessor::getCurLexerEndPos() {
256651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  const char *EndPos = CurLexer->BufferEnd;
257651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  if (EndPos != CurLexer->BufferStart &&
258651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      (EndPos[-1] == '\n' || EndPos[-1] == '\r')) {
259651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    --EndPos;
260651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
261651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    // Handle \n\r and \r\n:
262651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    if (EndPos != CurLexer->BufferStart &&
263651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines        (EndPos[-1] == '\n' || EndPos[-1] == '\r') &&
264651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines        EndPos[-1] != EndPos[0])
265651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      --EndPos;
266651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  }
267651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
268651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  return EndPos;
269651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines}
270651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
271651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
2728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfFile - This callback is invoked when the lexer hits the end of
2738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the current file.  This either returns the EOF token or pops a level off
2748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the include stack and keeps going.
2758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfFile(Token &Result, bool isEndOfMacro) {
2768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  assert(!CurTokenLexer &&
2778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner         "Ending a file when currently in a macro!");
2781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // See if this file had a controlling macro.
2801a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek  if (CurPPLexer) {  // Not ending a macro, ignore it.
2811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    if (const IdentifierInfo *ControllingMacro =
2821a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek          CurPPLexer->MIOpt.GetControllingMacroAtEndOfFile()) {
28383d63c78810556d26b62ac4cbae2eda6cdd2570cSteve Naroff      // Okay, this has a controlling macro, remember in HeaderFileInfo.
2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump      if (const FileEntry *FE =
285671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu            SourceMgr.getFileEntryForID(CurPPLexer->getFileID())) {
2868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner        HeaderInfo.SetFileControllingMacro(FE, ControllingMacro);
2876bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines        if (MacroInfo *MI =
2886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines              getMacroInfo(const_cast<IdentifierInfo*>(ControllingMacro))) {
2896bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines          MI->UsedForHeaderGuard = true;
2906bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines        }
291671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu        if (const IdentifierInfo *DefinedMacro =
292671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu              CurPPLexer->MIOpt.GetDefinedMacro()) {
293671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu          if (!ControllingMacro->hasMacroDefinition() &&
294671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu              DefinedMacro != ControllingMacro &&
295671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu              HeaderInfo.FirstTimeLexingFile(FE)) {
296223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi
297223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            // If the edit distance between the two macros is more than 50%,
298223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            // DefinedMacro may not be header guard, or can be header guard of
299223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            // another header file. Therefore, it maybe defining something
300223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            // completely different. This can be observed in the wild when
301223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            // handling feature macros or header guards in different files.
302223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi
303223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            const StringRef ControllingMacroName = ControllingMacro->getName();
304223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            const StringRef DefinedMacroName = DefinedMacro->getName();
305223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            const size_t MaxHalfLength = std::max(ControllingMacroName.size(),
306223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                                                  DefinedMacroName.size()) / 2;
307223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            const unsigned ED = ControllingMacroName.edit_distance(
308223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                DefinedMacroName, true, MaxHalfLength);
309223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            if (ED <= MaxHalfLength) {
310223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi              // Emit a warning for a bad header guard.
311223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi              Diag(CurPPLexer->MIOpt.GetMacroLocation(),
312223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                   diag::warn_header_guard)
313223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                  << CurPPLexer->MIOpt.GetMacroLocation() << ControllingMacro;
314223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi              Diag(CurPPLexer->MIOpt.GetDefinedLocation(),
315223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                   diag::note_header_guard)
316223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                  << CurPPLexer->MIOpt.GetDefinedLocation() << DefinedMacro
317223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                  << ControllingMacro
318223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                  << FixItHint::CreateReplacement(
319223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                         CurPPLexer->MIOpt.GetDefinedLocation(),
320223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi                         ControllingMacro->getName());
321223e7a8b0fadbbc9eaea1fb460cd90c8d9c8dd28Ismail Pazarbasi            }
322671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu          }
323671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu        }
324671538e8a51eab5bd65a1f9f327ba7f44f84e486Richard Trieu      }
3258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    }
3268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
3271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
3283eff3214647fe25e80dbf1dd096cc73a11d9a77aJohn McCall  // Complain about reaching a true EOF within arc_cf_code_audited.
3293eff3214647fe25e80dbf1dd096cc73a11d9a77aJohn McCall  // We don't want to complain about reaching the end of a macro
3303eff3214647fe25e80dbf1dd096cc73a11d9a77aJohn McCall  // instantiation or a _Pragma.
3313eff3214647fe25e80dbf1dd096cc73a11d9a77aJohn McCall  if (PragmaARCCFCodeAuditedLoc.isValid() &&
332d80d90d65895a2004b0d01c67ac417cde6cc62fdJohn McCall      !isEndOfMacro && !(CurLexer && CurLexer->Is_PragmaLexer)) {
3338dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall    Diag(PragmaARCCFCodeAuditedLoc, diag::err_pp_eof_in_arc_cf_code_audited);
3348dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall
3358dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall    // Recover by leaving immediately.
3368dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall    PragmaARCCFCodeAuditedLoc = SourceLocation();
3378dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall  }
3388dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall
3398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // If this is a #include'd file, pop it off the include stack and continue
3408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // lexing the #includer file.
3418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (!IncludeMacroStack.empty()) {
3427d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis
3437d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis    // If we lexed the code-completion file, act as if we reached EOF.
3447d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis    if (isCodeCompletionEnabled() && CurPPLexer &&
3457d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        SourceMgr.getLocForStartOfFile(CurPPLexer->getFileID()) ==
3467d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis            CodeCompletionFileLoc) {
3477d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis      if (CurLexer) {
3487d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        Result.startToken();
3497d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        CurLexer->FormTokenWithChars(Result, CurLexer->BufferEnd, tok::eof);
3507d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        CurLexer.reset();
3517d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis      } else {
3527d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        assert(CurPTHLexer && "Got EOF but no current lexer set!");
3537d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        CurPTHLexer->getEOF(Result);
3547d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis        CurPTHLexer.reset();
3557d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis      }
3567d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis
3576bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines      CurPPLexer = nullptr;
3587d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis      return true;
3597d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis    }
3607d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis
361d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis    if (!isEndOfMacro && CurPPLexer &&
362d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis        SourceMgr.getIncludeLoc(CurPPLexer->getFileID()).isValid()) {
363d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis      // Notify SourceManager to record the number of FileIDs that were created
364d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis      // during lexing of the #include'd file.
365d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis      unsigned NumFIDs =
366d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis          SourceMgr.local_sloc_entry_size() -
367d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis          CurPPLexer->getInitialNumSLocEntries() + 1/*#include'd file*/;
368d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis      SourceMgr.setNumCreatedFIDsForFileID(CurPPLexer->getFileID(), NumFIDs);
369d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis    }
370d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis
371c892c5fa92db137ff68d95afb13fe969d17f4fb2Argyrios Kyrtzidis    FileID ExitedFID;
372c892c5fa92db137ff68d95afb13fe969d17f4fb2Argyrios Kyrtzidis    if (Callbacks && !isEndOfMacro && CurPPLexer)
373c892c5fa92db137ff68d95afb13fe969d17f4fb2Argyrios Kyrtzidis      ExitedFID = CurPPLexer->getFileID();
374651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
375651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    bool LeavingSubmodule = CurSubmodule && CurLexer;
376651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    if (LeavingSubmodule) {
377651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      // Notify the parser that we've left the module.
378651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      const char *EndPos = getCurLexerEndPos();
379651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      Result.startToken();
380651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      CurLexer->BufferPtr = EndPos;
381651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      CurLexer->FormTokenWithChars(Result, EndPos, tok::annot_module_end);
382651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      Result.setAnnotationEndLoc(Result.getLocation());
383651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      Result.setAnnotationValue(CurSubmodule);
384651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    }
385651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines
3868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // We're done with the #included file.
3878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    RemoveTopOfLexerStack();
3888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
389d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    // Propagate info about start-of-line/leading white-space/etc.
390d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman    PropagateLineStartLeadingSpaceInfo(Result);
391d2f9308220af22bfc1bcd3bc2cad118dbd8be013Eli Friedman
3928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // Notify the client, if desired, that we are in a new source file.
3931a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    if (Callbacks && !isEndOfMacro && CurPPLexer) {
3949d72851fec9e9c62570a027d42701562bbf29751Chris Lattner      SrcMgr::CharacteristicKind FileType =
3958c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner        SourceMgr.getFileCharacteristic(CurPPLexer->getSourceLocation());
3968c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner      Callbacks->FileChanged(CurPPLexer->getSourceLocation(),
397c892c5fa92db137ff68d95afb13fe969d17f4fb2Argyrios Kyrtzidis                             PPCallbacks::ExitFile, FileType, ExitedFID);
3988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    }
3998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
400651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    // Client should lex another token unless we generated an EOM.
401651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    return LeavingSubmodule;
4028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
4038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
404651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  // If this is the end of the main file, form an EOF token.
4051a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek  if (CurLexer) {
406651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    const char *EndPos = getCurLexerEndPos();
4071a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    Result.startToken();
4081a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    CurLexer->BufferPtr = EndPos;
4091a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    CurLexer->FormTokenWithChars(Result, EndPos, tok::eof);
4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
411bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    if (isCodeCompletionEnabled()) {
412bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // Inserting the code-completion point increases the source buffer by 1,
413bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // but the main FileID was created before inserting the point.
414bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // Compensate by reducing the EOF location by 1, otherwise the location
415bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // will point to the next FileID.
416bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // FIXME: This is hacky, the code-completion point should probably be
417bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      // inserted before the main FileID is created.
418bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis      if (CurLexer->getFileLoc() == CodeCompletionFileLoc)
419bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis        Result.setLocation(Result.getLocation().getLocWithOffset(-1));
420bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis    }
421bb06b5000b9639a92e92c368ff3e5e5f8bb1e724Argyrios Kyrtzidis
422e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann    if (!isIncrementalProcessingEnabled())
423e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann      // We're done with lexing.
424e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann      CurLexer.reset();
42567116083e70ad44799808c7472d9cd9e7e21d4d5Chris Lattner  } else {
42667116083e70ad44799808c7472d9cd9e7e21d4d5Chris Lattner    assert(CurPTHLexer && "Got EOF but no current lexer set!");
42759d08cb672136322375e5400578ee1fbd0947de2Ted Kremenek    CurPTHLexer->getEOF(Result);
4281a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    CurPTHLexer.reset();
4298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
430e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann
431e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann  if (!isIncrementalProcessingEnabled())
4326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines    CurPPLexer = nullptr;
4338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
434651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  if (TUKind == TU_Complete) {
435651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    // This is the end of the top-level file. 'WarnUnusedMacroLocs' has
436651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    // collected all macro locations that we need to warn because they are not
437651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    // used.
438651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    for (WarnUnusedMacroLocsTy::iterator
439651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines           I=WarnUnusedMacroLocs.begin(), E=WarnUnusedMacroLocs.end();
440651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines           I!=E; ++I)
441651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      Diag(*I, diag::pp_macro_not_used);
442651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines  }
443dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar
444585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  // If we are building a module that has an umbrella header, make sure that
445585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  // each of the headers within the directory covered by the umbrella header
446585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  // was actually included by the umbrella header.
447585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  if (Module *Mod = getCurrentModule()) {
448585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor    if (Mod->getUmbrellaHeader()) {
449585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor      SourceLocation StartLoc
450585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        = SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
451585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
452ef8225444452a1486bd721f3285301fe84643b00Stephen Hines      if (!getDiagnostics().isIgnored(diag::warn_uncovered_module_header,
453ef8225444452a1486bd721f3285301fe84643b00Stephen Hines                                      StartLoc)) {
45451f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor        ModuleMap &ModMap = getHeaderSearchInfo().getModuleMap();
455585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        const DirectoryEntry *Dir = Mod->getUmbrellaDir();
456ef8225444452a1486bd721f3285301fe84643b00Stephen Hines        vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
457ef8225444452a1486bd721f3285301fe84643b00Stephen Hines        std::error_code EC;
458ef8225444452a1486bd721f3285301fe84643b00Stephen Hines        for (vfs::recursive_directory_iterator Entry(FS, Dir->getName(), EC), End;
459585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor             Entry != End && !EC; Entry.increment(EC)) {
460585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor          using llvm::StringSwitch;
461585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
46251f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor          // Check whether this entry has an extension typically associated with
463585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor          // headers.
464ef8225444452a1486bd721f3285301fe84643b00Stephen Hines          if (!StringSwitch<bool>(llvm::sys::path::extension(Entry->getName()))
46551f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor                 .Cases(".h", ".H", ".hh", ".hpp", true)
46651f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor                 .Default(false))
467585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor            continue;
468585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor
469ef8225444452a1486bd721f3285301fe84643b00Stephen Hines          if (const FileEntry *Header =
470ef8225444452a1486bd721f3285301fe84643b00Stephen Hines                  getFileManager().getFile(Entry->getName()))
471585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor            if (!getSourceManager().hasFileInfo(Header)) {
47251f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor              if (!ModMap.isHeaderInUnavailableModule(Header)) {
47351f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor                // Find the relative path that would access this header.
474f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith                SmallString<128> RelativePath;
47551f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor                computeRelativePath(FileMgr, Dir, Header, RelativePath);
47651f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor                Diag(StartLoc, diag::warn_uncovered_module_header)
477c9c3907e66659e4457593fdec4a27c671c12e041Douglas Gregor                  << Mod->getFullModuleName() << RelativePath;
47851f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor              }
479585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor            }
480585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor        }
481585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor      }
482585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor    }
48358ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor
48458ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor    // Check whether there are any headers that were included, but not
48558ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor    // mentioned at all in the module map. Such headers
48658ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor    SourceLocation StartLoc
48758ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor      = SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
488ef8225444452a1486bd721f3285301fe84643b00Stephen Hines    if (!getDiagnostics().isIgnored(diag::warn_forgotten_module_header,
489ef8225444452a1486bd721f3285301fe84643b00Stephen Hines                                    StartLoc)) {
49058ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor      ModuleMap &ModMap = getHeaderSearchInfo().getModuleMap();
49158ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor      for (unsigned I = 0, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
49258ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        // We only care about file entries.
49358ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        const SrcMgr::SLocEntry &Entry = SourceMgr.getLocalSLocEntry(I);
49458ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        if (!Entry.isFile())
49558ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor          continue;
49658ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor
49758ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        // Dig out the actual file.
49858ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        const FileEntry *File = Entry.getFile().getContentCache()->OrigEntry;
49958ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        if (!File)
50058ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor          continue;
50158ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor
50258ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        // If it's not part of a module and not unknown, complain.
50358ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        if (!ModMap.findModuleForHeader(File) &&
50458ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor            !ModMap.isHeaderInUnavailableModule(File)) {
50558ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor          Diag(StartLoc, diag::warn_forgotten_module_header)
50658ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor            << File->getName() << Mod->getFullModuleName();
50758ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor        }
50858ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor      }
50958ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor    }
510585ec93e1bd4fdd5a37aa19848e5f92084f0d923Douglas Gregor  }
51158ea48dc1dd970f131207e00ae7ece159d1a08edDouglas Gregor
5128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  return true;
5138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
5148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
5158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer
5168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// hits the end of its token stream.
5178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfTokenLexer(Token &Result) {
5181a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek  assert(CurTokenLexer && !CurPPLexer &&
5198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner         "Ending a macro when currently in a #include file!");
5208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
5215b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis  if (!MacroExpandingLexersStack.empty() &&
5225b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis      MacroExpandingLexersStack.back().first == CurTokenLexer.get())
5235b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis    removeCachedMacroExpandedTokensOfLastLexer();
5245b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis
5258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Delete or cache the now-dead macro expander.
5268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (NumCachedTokenLexers == TokenLexerCacheSize)
527caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek    CurTokenLexer.reset();
5288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  else
529651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines    TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.release();
5308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
5318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Handle this like a #include file being popped off the stack.
5328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  return HandleEndOfFile(Result, true);
5338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
5348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
5358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the
5368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// lexer stack.  This should only be used in situations where the current
5378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state of the top-of-stack lexer is unknown.
5388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::RemoveTopOfLexerStack() {
5398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  assert(!IncludeMacroStack.empty() && "Ran out of stack entries to load");
5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
5418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (CurTokenLexer) {
5428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // Delete or cache the now-dead macro expander.
5438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    if (NumCachedTokenLexers == TokenLexerCacheSize)
544caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek      CurTokenLexer.reset();
5458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    else
546651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines      TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.release();
5471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  }
5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
549ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek  PopIncludeMacroStack();
5508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
5518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner
5528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleMicrosoftCommentPaste - When the macro expander pastes together a
5538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// comment (/##/) in microsoft mode, this method handles updating the current
5548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state, returning the token on the next source line.
5558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::HandleMicrosoftCommentPaste(Token &Tok) {
5561a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek  assert(CurTokenLexer && !CurPPLexer &&
5578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner         "Pasted comment can only be formed from macro");
5581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
5598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // We handle this by scanning for the closest real lexer, switching it to
5608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // raw mode and preprocessor mode.  This will cause it to return \n as an
56184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  // explicit EOD token.
5626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines  PreprocessorLexer *FoundLexer = nullptr;
5638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  bool LexerWasInPPMode = false;
5648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) {
5658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    IncludeStackInfo &ISI = *(IncludeMacroStack.end()-i-1);
5666bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines    if (ISI.ThePPLexer == nullptr) continue;  // Scan for a real lexer.
5671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
5688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // Once we find a real lexer, mark it as raw mode (disabling macro
56984021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne    // expansions) and preprocessor mode (return EOD).  We know that the lexer
5708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // was *not* in raw mode before, because the macro that the comment came
5718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // from was expanded.  However, it could have already been in preprocessor
5728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // mode (#if COMMENT) in which case we have to return it to that mode and
57384021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne    // return EOD.
5741a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek    FoundLexer = ISI.ThePPLexer;
5758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    FoundLexer->LexingRawMode = true;
5768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    LexerWasInPPMode = FoundLexer->ParsingPreprocessorDirective;
5778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    FoundLexer->ParsingPreprocessorDirective = true;
5788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    break;
5798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
5801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
5818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // Okay, we either found and switched over the lexer, or we didn't find a
5828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // lexer.  In either case, finish off the macro the comment came from, getting
5838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // the next token.
5848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  if (!HandleEndOfTokenLexer(Tok)) Lex(Tok);
5851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
58684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  // Discarding comments as long as we don't have EOF or EOD.  This 'comments
5878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // out' the rest of the line, including any tokens that came from other macros
5888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // that were active, as in:
5898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  //  #define submacro a COMMENT b
5908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  //    submacro c
5918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // which should lex to 'a' only: 'b' and 'c' should be removed.
59284021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  while (Tok.isNot(tok::eod) && Tok.isNot(tok::eof))
5938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    Lex(Tok);
5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
59584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  // If we got an eod token, then we successfully found the end of the line.
59684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  if (Tok.is(tok::eod)) {
5978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    assert(FoundLexer && "Can't get end of line without an active lexer");
5988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // Restore the lexer back to normal mode instead of raw mode.
5998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    FoundLexer->LexingRawMode = false;
6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
60184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne    // If the lexer was already in preprocessor mode, just return the EOD token
6028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // to finish the preprocessor line.
6038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    if (LexerWasInPPMode) return;
6041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    // Otherwise, switch out of PP mode and return the next lexed token.
6068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    FoundLexer->ParsingPreprocessorDirective = false;
6078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner    return Lex(Tok);
6088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  }
6091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // If we got an EOF token, then we reached the end of the token stream but
6118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // didn't find an explicit \n.  This can only happen if there was no lexer
61284021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  // active (an active lexer would return EOD at EOF if there was no \n in
6138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner  // preprocessor directive mode), so just return EOF as our token.
61484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne  assert(!FoundLexer && "Lexer should return EOD before EOF in PP mode");
6158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner}
616