PPLexerChange.cpp revision 500d3297d2a21edeac4d46cbcbe21bc2352c2a28
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" 168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Lex/HeaderSearch.h" 178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Lex/MacroInfo.h" 18500d3297d2a21edeac4d46cbcbe21bc2352c2a28Chris Lattner#include "clang/Lex/LexDiagnostic.h" 198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Basic/SourceManager.h" 2015ba2af0f9ad52e67e908179b8ec2eb404e11c61Ted Kremenek#include "llvm/Support/MemoryBuffer.h" 2115ba2af0f9ad52e67e908179b8ec2eb404e11c61Ted Kremenek 228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerusing namespace clang; 238c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 244b391087f9c5582d448ab66ccbc7028f7673f380Ted KremenekPPCallbacks::~PPCallbacks() {} 258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 276b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Miscellaneous Methods. 288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// isInPrimaryFile - Return true if we're in the top-level file, not in a 317d39d742383ade80c9d937729bfc539c6c978845Chris Lattner/// #include. This looks through macro expansions and active _Pragma lexers. 328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::isInPrimaryFile() const { 3381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer()) 348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return IncludeMacroStack.empty(); 358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If there are any stacked lexers, we're in a #include. 3781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek assert(IsFileLexer(IncludeMacroStack[0]) && 388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Top level include stack isn't our primary lexer?"); 398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 1, e = IncludeMacroStack.size(); i != e; ++i) 4081d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer(IncludeMacroStack[i])) 418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// getCurrentLexer - Return the current file lexer being lexed from. Note 468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// that this ignores any potentially active macro expansions and _Pragma 478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// expansions going on at the time. 4868e48e4a81767997ef0231e47eca4f665102c95eTed KremenekPreprocessorLexer *Preprocessor::getCurrentFileLexer() const { 4981d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer()) 5068e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek return CurPPLexer; 518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Look for a stacked lexer. 538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = IncludeMacroStack.size(); i != 0; --i) { 5468e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek const IncludeStackInfo& ISI = IncludeMacroStack[i-1]; 5581d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer(ISI)) 5668e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek return ISI.ThePPLexer; 578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return 0; 598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner 626b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 636b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Methods for Entering and Callbacks for leaving various contexts 646b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterSourceFile - Add a source file to the top of the include stack and 678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// start lexing tokens from it instead of the current buffer. Return true 688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// on failure. 692b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid Preprocessor::EnterSourceFile(FileID FID, const DirectoryLookup *CurDir) { 708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(CurTokenLexer == 0 && "Cannot #include a file inside a macro!"); 718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner ++NumEnteredSourceFiles; 728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (MaxIncludeStackDepth < IncludeMacroStack.size()) 748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner MaxIncludeStackDepth = IncludeMacroStack.size(); 758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 766137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (PTH) { 77f056d92e182cbe4f62c8d14102544dc38066dabcChris Lattner if (PTHLexer *PL = PTH->CreateLexer(FID)) 7888d3ac1341aa016cabd966c5b113a95ac05ea43fChris Lattner return EnterSourceFileWithPTH(PL, CurDir); 796137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek } 8088d3ac1341aa016cabd966c5b113a95ac05ea43fChris Lattner EnterSourceFileWithLexer(new Lexer(FID, *this), CurDir); 818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 82721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner 836137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithLexer - Add a source file to the top of the include stack 846137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// and start lexing tokens from it instead of the current buffer. 858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::EnterSourceFileWithLexer(Lexer *TheLexer, 868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner const DirectoryLookup *CurDir) { 878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Add the current lexer to the include stack. 8941938c8493b4380df738263166b746eacb33c309Ted Kremenek if (CurPPLexer || CurTokenLexer) 90ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 91ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek 92caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(TheLexer); 939c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = TheLexer; 948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = CurDir; 958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Callbacks && !CurLexer->Is_PragmaLexer) { 989d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 990b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner SourceMgr.getFileCharacteristic(CurLexer->getFileLoc()); 1008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Callbacks->FileChanged(CurLexer->getFileLoc(), 1028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner PPCallbacks::EnterFile, FileType); 1038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1066137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithPTH - Add a source file to the top of the include stack 1076137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// and start getting tokens from it using the PTH cache. 1086137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenekvoid Preprocessor::EnterSourceFileWithPTH(PTHLexer *PL, 1096137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek const DirectoryLookup *CurDir) { 1106137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 1116137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (CurPPLexer || CurTokenLexer) 1126137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek PushIncludeMacroStack(); 1138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1146137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurDirLookup = CurDir; 1156137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurPTHLexer.reset(PL); 1166137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurPPLexer = CurPTHLexer.get(); 1176137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 1186137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek // Notify the client, if desired, that we are in a new source file. 1196137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (Callbacks) { 1202b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID FID = CurPPLexer->getFileID(); 1218c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceLocation EnterLoc = SourceMgr.getLocForStartOfFile(FID); 1228c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SrcMgr::CharacteristicKind FileType = 1238c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceMgr.getFileCharacteristic(EnterLoc); 1248c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner Callbacks->FileChanged(EnterLoc, PPCallbacks::EnterFile, FileType); 1256137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek } 1266137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek} 1278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterMacro - Add a Macro to the top of the include stack and start lexing 1298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// tokens from it instead of the current buffer. 1308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::EnterMacro(Token &Tok, MacroArgs *Args) { 131ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 135caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(new TokenLexer(Tok, Args, *this)); 1368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 137caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 1388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurTokenLexer->Init(Tok, Args); 1398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterTokenStream - Add a "macro" context to the top of the include stack, 1436b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// which will cause the lexer to start returning the specified tokens. 1446b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1456b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If DisableMacroExpansion is true, tokens lexed from the token stream will 1466b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// not be subject to further macro expansion. Otherwise, these tokens will 1476b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// be re-macro-expanded when/if expansion is enabled. 1486b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1496b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If OwnsTokens is false, this method assumes that the specified stream of 1506b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// tokens has a permanent owner somewhere, so they do not need to be copied. 1516b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If it is true, it assumes the array of tokens is allocated with new[] and 1526b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// must be freed. 1536b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1546b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattnervoid Preprocessor::EnterTokenStream(const Token *Toks, unsigned NumToks, 1556b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, 1566b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool OwnsTokens) { 1578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Save our current state. 158ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1618c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Create a macro expander to expand from the specified token stream. 1628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 163caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(new TokenLexer(Toks, NumToks, DisableMacroExpansion, 164caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek OwnsTokens, *this)); 1658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 166caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 1676b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner CurTokenLexer->Init(Toks, NumToks, DisableMacroExpansion, OwnsTokens); 1688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfFile - This callback is invoked when the lexer hits the end of 1728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the current file. This either returns the EOF token or pops a level off 1738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the include stack and keeps going. 1748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfFile(Token &Result, bool isEndOfMacro) { 1758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!CurTokenLexer && 1768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a file when currently in a macro!"); 1778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // See if this file had a controlling macro. 1791a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (CurPPLexer) { // Not ending a macro, ignore it. 1808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (const IdentifierInfo *ControllingMacro = 1811a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurPPLexer->MIOpt.GetControllingMacroAtEndOfFile()) { 1828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Okay, this has a controlling macro, remember in PerFileInfo. 1838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (const FileEntry *FE = 1841a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek SourceMgr.getFileEntryForID(CurPPLexer->getFileID())) 1858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner HeaderInfo.SetFileControllingMacro(FE, ControllingMacro); 1868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If this is a #include'd file, pop it off the include stack and continue 1908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexing the #includer file. 1918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!IncludeMacroStack.empty()) { 1928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We're done with the #included file. 1938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner RemoveTopOfLexerStack(); 1948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 1961a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (Callbacks && !isEndOfMacro && CurPPLexer) { 1979d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 1988c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceMgr.getFileCharacteristic(CurPPLexer->getSourceLocation()); 1998c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner Callbacks->FileChanged(CurPPLexer->getSourceLocation(), 2008c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner PPCallbacks::ExitFile, FileType); 2018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Client should lex another token. 2048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 2058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the file ends with a newline, form the EOF token on the newline itself, 2088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // rather than "on the line following it", which doesn't exist. This makes 2098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // diagnostics relating to the end of file include the last file that the user 2108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // actually typed, which is goodness. 2111a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (CurLexer) { 2121a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek const char *EndPos = CurLexer->BufferEnd; 2138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (EndPos != CurLexer->BufferStart && 2141a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek (EndPos[-1] == '\n' || EndPos[-1] == '\r')) { 2158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner --EndPos; 2161a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek 2171a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek // Handle \n\r and \r\n: 2181a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (EndPos != CurLexer->BufferStart && 2191a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek (EndPos[-1] == '\n' || EndPos[-1] == '\r') && 2201a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek EndPos[-1] != EndPos[0]) 2211a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek --EndPos; 2221a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek } 2231a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek 2241a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek Result.startToken(); 2251a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer->BufferPtr = EndPos; 2261a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer->FormTokenWithChars(Result, EndPos, tok::eof); 2271a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek 2281a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek // We're done with the #included file. 2291a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer.reset(); 2301a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek } 2311a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek else { 23259d08cb672136322375e5400578ee1fbd0947de2Ted Kremenek CurPTHLexer->getEOF(Result); 2331a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurPTHLexer.reset(); 2348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 23641938c8493b4380df738263166b746eacb33c309Ted Kremenek CurPPLexer = 0; 2378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // This is the end of the top-level file. If the diag::pp_macro_not_used 2398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // diagnostic is enabled, look for macros that have not been used. 2408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Diags.getDiagnosticLevel(diag::pp_macro_not_used) != Diagnostic::Ignored){ 2418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I = 2428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Macros.begin(), E = Macros.end(); I != E; ++I) { 2438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!I->second->isUsed()) 2448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Diag(I->second->getDefinitionLoc(), diag::pp_macro_not_used); 2458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 2488c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer 2518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// hits the end of its token stream. 2528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfTokenLexer(Token &Result) { 2531a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek assert(CurTokenLexer && !CurPPLexer && 2548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a macro when currently in a #include file!"); 2558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 258caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 260caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 2618c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Handle this like a #include file being popped off the stack. 2638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return HandleEndOfFile(Result, true); 2648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 2678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// lexer stack. This should only be used in situations where the current 2688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state of the top-of-stack lexer is unknown. 2698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::RemoveTopOfLexerStack() { 2708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!IncludeMacroStack.empty() && "Ran out of stack entries to load"); 2718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (CurTokenLexer) { 2738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 275caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 277caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 27815ba2af0f9ad52e67e908179b8ec2eb404e11c61Ted Kremenek } 279ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek 280ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PopIncludeMacroStack(); 2818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleMicrosoftCommentPaste - When the macro expander pastes together a 2848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// comment (/##/) in microsoft mode, this method handles updating the current 2858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state, returning the token on the next source line. 2868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::HandleMicrosoftCommentPaste(Token &Tok) { 2871a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek assert(CurTokenLexer && !CurPPLexer && 2888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Pasted comment can only be formed from macro"); 2898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We handle this by scanning for the closest real lexer, switching it to 2918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // raw mode and preprocessor mode. This will cause it to return \n as an 2928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // explicit EOM token. 2931a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek PreprocessorLexer *FoundLexer = 0; 2948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner bool LexerWasInPPMode = false; 2958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) { 2968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner IncludeStackInfo &ISI = *(IncludeMacroStack.end()-i-1); 2971a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (ISI.ThePPLexer == 0) continue; // Scan for a real lexer. 2988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Once we find a real lexer, mark it as raw mode (disabling macro 3008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // expansions) and preprocessor mode (return EOM). We know that the lexer 3018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // was *not* in raw mode before, because the macro that the comment came 3028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // from was expanded. However, it could have already been in preprocessor 3038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // mode (#if COMMENT) in which case we have to return it to that mode and 3048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // return EOM. 3051a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek FoundLexer = ISI.ThePPLexer; 3068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = true; 3078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner LexerWasInPPMode = FoundLexer->ParsingPreprocessorDirective; 3088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = true; 3098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner break; 3108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 3118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Okay, we either found and switched over the lexer, or we didn't find a 3138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexer. In either case, finish off the macro the comment came from, getting 3148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // the next token. 3158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!HandleEndOfTokenLexer(Tok)) Lex(Tok); 3168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Discarding comments as long as we don't have EOF or EOM. This 'comments 3188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // out' the rest of the line, including any tokens that came from other macros 3198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // that were active, as in: 3208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // #define submacro a COMMENT b 3218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // submacro c 3228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // which should lex to 'a' only: 'b' and 'c' should be removed. 3238c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner while (Tok.isNot(tok::eom) && Tok.isNot(tok::eof)) 3248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lex(Tok); 3258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an eom token, then we successfully found the end of the line. 3278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Tok.is(tok::eom)) { 3288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(FoundLexer && "Can't get end of line without an active lexer"); 3298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Restore the lexer back to normal mode instead of raw mode. 3308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = false; 3318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the lexer was already in preprocessor mode, just return the EOM token 3338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // to finish the preprocessor line. 3348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (LexerWasInPPMode) return; 3358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Otherwise, switch out of PP mode and return the next lexed token. 3378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = false; 3388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return Lex(Tok); 3398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 3408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an EOF token, then we reached the end of the token stream but 3428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // didn't find an explicit \n. This can only happen if there was no lexer 3438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // active (an active lexer would return EOM at EOF if there was no \n in 3448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // preprocessor directive mode), so just return EOF as our token. 3458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!FoundLexer && "Lexer should return EOM before EOF in PP mode"); 3468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 347