PPLexerChange.cpp revision 0827408865e32789e0ec4b8113a302ccdc531423
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" 218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerusing namespace clang; 228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 234b391087f9c5582d448ab66ccbc7028f7673f380Ted KremenekPPCallbacks::~PPCallbacks() {} 248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 266b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Miscellaneous Methods. 278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// isInPrimaryFile - Return true if we're in the top-level file, not in a 307d39d742383ade80c9d937729bfc539c6c978845Chris Lattner/// #include. This looks through macro expansions and active _Pragma lexers. 318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::isInPrimaryFile() const { 3281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer()) 338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return IncludeMacroStack.empty(); 341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If there are any stacked lexers, we're in a #include. 3681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek assert(IsFileLexer(IncludeMacroStack[0]) && 378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Top level include stack isn't our primary lexer?"); 388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 1, e = IncludeMacroStack.size(); i != e; ++i) 3981d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer(IncludeMacroStack[i])) 408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// getCurrentLexer - Return the current file lexer being lexed from. Note 458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// that this ignores any potentially active macro expansions and _Pragma 468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// expansions going on at the time. 4768e48e4a81767997ef0231e47eca4f665102c95eTed KremenekPreprocessorLexer *Preprocessor::getCurrentFileLexer() const { 4881d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer()) 4968e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek return CurPPLexer; 501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Look for a stacked lexer. 528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = IncludeMacroStack.size(); i != 0; --i) { 5368e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek const IncludeStackInfo& ISI = IncludeMacroStack[i-1]; 5481d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek if (IsFileLexer(ISI)) 5568e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek return ISI.ThePPLexer; 568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return 0; 588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 606b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner 616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 626b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Methods for Entering and Callbacks for leaving various contexts 636b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterSourceFile - Add a source file to the top of the include stack and 66e7f2cbd8c093dcaebaa04c3f7b8fb1a0b4533b15Nuno Lopes/// start lexing tokens from it instead of the current buffer. 67e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattnervoid Preprocessor::EnterSourceFile(FileID FID, const DirectoryLookup *CurDir, 68e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc) { 698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(CurTokenLexer == 0 && "Cannot #include a file inside a macro!"); 708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner ++NumEnteredSourceFiles; 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (MaxIncludeStackDepth < IncludeMacroStack.size()) 738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner MaxIncludeStackDepth = IncludeMacroStack.size(); 748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 756137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (PTH) { 766e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner if (PTHLexer *PL = PTH->CreateLexer(FID)) { 776e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner EnterSourceFileWithPTH(PL, CurDir); 78e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner return; 796e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner } 806137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek } 816e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner 826e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner // Get the MemoryBuffer for this FID, if it fails, we fail. 83aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor bool Invalid = false; 84e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *InputFile = 85e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner getSourceManager().getBuffer(FID, Loc, &Invalid); 86e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner if (Invalid) { 87e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation FileStart = SourceMgr.getLocForStartOfFile(FID); 88e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner Diag(Loc, diag::err_pp_error_opening_file) 89e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner << std::string(SourceMgr.getBufferName(FileStart)) << ""; 90e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner return; 91e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner } 926e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner 936e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner EnterSourceFileWithLexer(new Lexer(FID, InputFile, *this), CurDir); 94e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner return; 951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump} 96721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner 976137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithLexer - Add a source file to the top of the include stack 986137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// and start lexing tokens from it instead of the current buffer. 991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid Preprocessor::EnterSourceFileWithLexer(Lexer *TheLexer, 1008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner const DirectoryLookup *CurDir) { 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Add the current lexer to the include stack. 10341938c8493b4380df738263166b746eacb33c309Ted Kremenek if (CurPPLexer || CurTokenLexer) 104ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 105ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek 106caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(TheLexer); 1079c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = TheLexer; 1088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = CurDir; 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 1118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Callbacks && !CurLexer->Is_PragmaLexer) { 1129d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 1130b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner SourceMgr.getFileCharacteristic(CurLexer->getFileLoc()); 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Callbacks->FileChanged(CurLexer->getFileLoc(), 1168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner PPCallbacks::EnterFile, FileType); 1178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1206137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// EnterSourceFileWithPTH - Add a source file to the top of the include stack 1216137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek/// and start getting tokens from it using the PTH cache. 1221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid Preprocessor::EnterSourceFileWithPTH(PTHLexer *PL, 1236137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek const DirectoryLookup *CurDir) { 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1256137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (CurPPLexer || CurTokenLexer) 1266137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek PushIncludeMacroStack(); 1278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1286137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurDirLookup = CurDir; 1296137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurPTHLexer.reset(PL); 1306137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek CurPPLexer = CurPTHLexer.get(); 1316137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 1326137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek // Notify the client, if desired, that we are in a new source file. 1336137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek if (Callbacks) { 1342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID FID = CurPPLexer->getFileID(); 1358c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceLocation EnterLoc = SourceMgr.getLocForStartOfFile(FID); 1368c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SrcMgr::CharacteristicKind FileType = 1378c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceMgr.getFileCharacteristic(EnterLoc); 1388c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner Callbacks->FileChanged(EnterLoc, PPCallbacks::EnterFile, FileType); 1396137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek } 1406137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek} 1418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterMacro - Add a Macro to the top of the include stack and start lexing 1438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// tokens from it instead of the current buffer. 144e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattnervoid Preprocessor::EnterMacro(Token &Tok, SourceLocation ILEnd, 145e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *Args) { 146ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 150e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner CurTokenLexer.reset(new TokenLexer(Tok, ILEnd, Args, *this)); 1518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 152caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 153e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner CurTokenLexer->Init(Tok, ILEnd, Args); 1548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterTokenStream - Add a "macro" context to the top of the include stack, 1586b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// which will cause the lexer to start returning the specified tokens. 1596b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1606b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If DisableMacroExpansion is true, tokens lexed from the token stream will 1616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// not be subject to further macro expansion. Otherwise, these tokens will 1626b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// be re-macro-expanded when/if expansion is enabled. 1636b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1646b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If OwnsTokens is false, this method assumes that the specified stream of 1656b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// tokens has a permanent owner somewhere, so they do not need to be copied. 1666b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If it is true, it assumes the array of tokens is allocated with new[] and 1676b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// must be freed. 1686b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1696b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattnervoid Preprocessor::EnterTokenStream(const Token *Toks, unsigned NumToks, 1706b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, 1716b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool OwnsTokens) { 1728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Save our current state. 173ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Create a macro expander to expand from the specified token stream. 1778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 178caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(new TokenLexer(Toks, NumToks, DisableMacroExpansion, 179caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek OwnsTokens, *this)); 1808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 181caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 1826b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner CurTokenLexer->Init(Toks, NumToks, DisableMacroExpansion, OwnsTokens); 1838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfFile - This callback is invoked when the lexer hits the end of 1878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the current file. This either returns the EOF token or pops a level off 1888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the include stack and keeps going. 1898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfFile(Token &Result, bool isEndOfMacro) { 1908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!CurTokenLexer && 1918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a file when currently in a macro!"); 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // See if this file had a controlling macro. 1941a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (CurPPLexer) { // Not ending a macro, ignore it. 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (const IdentifierInfo *ControllingMacro = 1961a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurPPLexer->MIOpt.GetControllingMacroAtEndOfFile()) { 19783d63c78810556d26b62ac4cbae2eda6cdd2570cSteve Naroff // Okay, this has a controlling macro, remember in HeaderFileInfo. 1981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (const FileEntry *FE = 1991a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek SourceMgr.getFileEntryForID(CurPPLexer->getFileID())) 2008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner HeaderInfo.SetFileControllingMacro(FE, ControllingMacro); 2018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If this is a #include'd file, pop it off the include stack and continue 2058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexing the #includer file. 2068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!IncludeMacroStack.empty()) { 2078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We're done with the #included file. 2088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner RemoveTopOfLexerStack(); 2098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 2111a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (Callbacks && !isEndOfMacro && CurPPLexer) { 2129d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 2138c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner SourceMgr.getFileCharacteristic(CurPPLexer->getSourceLocation()); 2148c61b53fdb283dade0bbf51c3c5befbc5d0aefa7Chris Lattner Callbacks->FileChanged(CurPPLexer->getSourceLocation(), 2151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump PPCallbacks::ExitFile, FileType); 2168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Client should lex another token. 2198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 2208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the file ends with a newline, form the EOF token on the newline itself, 2238c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // rather than "on the line following it", which doesn't exist. This makes 2248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // diagnostics relating to the end of file include the last file that the user 2258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // actually typed, which is goodness. 2261a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (CurLexer) { 2271a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek const char *EndPos = CurLexer->BufferEnd; 2281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (EndPos != CurLexer->BufferStart && 2291a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek (EndPos[-1] == '\n' || EndPos[-1] == '\r')) { 2308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner --EndPos; 2311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2321a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek // Handle \n\r and \r\n: 2331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (EndPos != CurLexer->BufferStart && 2341a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek (EndPos[-1] == '\n' || EndPos[-1] == '\r') && 2351a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek EndPos[-1] != EndPos[0]) 2361a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek --EndPos; 2371a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek } 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2391a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek Result.startToken(); 2401a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer->BufferPtr = EndPos; 2411a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer->FormTokenWithChars(Result, EndPos, tok::eof); 2421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2431a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek // We're done with the #included file. 2441a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurLexer.reset(); 24567116083e70ad44799808c7472d9cd9e7e21d4d5Chris Lattner } else { 24667116083e70ad44799808c7472d9cd9e7e21d4d5Chris Lattner assert(CurPTHLexer && "Got EOF but no current lexer set!"); 24759d08cb672136322375e5400578ee1fbd0947de2Ted Kremenek CurPTHLexer->getEOF(Result); 2481a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek CurPTHLexer.reset(); 2498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25141938c8493b4380df738263166b746eacb33c309Ted Kremenek CurPPLexer = 0; 2528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2530827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // This is the end of the top-level file. 'WarnUnusedMacroLocs' has collected 2540827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // all macro locations that we need to warn because they are not used. 2550827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis for (WarnUnusedMacroLocsTy::iterator 2560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis I=WarnUnusedMacroLocs.begin(), E=WarnUnusedMacroLocs.end(); I!=E; ++I) 2570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis Diag(*I, diag::pp_macro_not_used); 258dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 2598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 2608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2618c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer 2638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// hits the end of its token stream. 2648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfTokenLexer(Token &Result) { 2651a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek assert(CurTokenLexer && !CurPPLexer && 2668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a macro when currently in a #include file!"); 2678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 270caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 272caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 2738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Handle this like a #include file being popped off the stack. 2758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return HandleEndOfFile(Result, true); 2768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 2798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// lexer stack. This should only be used in situations where the current 2808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state of the top-of-stack lexer is unknown. 2818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::RemoveTopOfLexerStack() { 2828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!IncludeMacroStack.empty() && "Ran out of stack entries to load"); 2831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (CurTokenLexer) { 2858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 287caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 289caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 2901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 292ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PopIncludeMacroStack(); 2938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleMicrosoftCommentPaste - When the macro expander pastes together a 2968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// comment (/##/) in microsoft mode, this method handles updating the current 2978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state, returning the token on the next source line. 2988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::HandleMicrosoftCommentPaste(Token &Tok) { 2991a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek assert(CurTokenLexer && !CurPPLexer && 3008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Pasted comment can only be formed from macro"); 3011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We handle this by scanning for the closest real lexer, switching it to 3038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // raw mode and preprocessor mode. This will cause it to return \n as an 3048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // explicit EOM token. 3051a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek PreprocessorLexer *FoundLexer = 0; 3068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner bool LexerWasInPPMode = false; 3078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) { 3088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner IncludeStackInfo &ISI = *(IncludeMacroStack.end()-i-1); 3091a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek if (ISI.ThePPLexer == 0) continue; // Scan for a real lexer. 3101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Once we find a real lexer, mark it as raw mode (disabling macro 3128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // expansions) and preprocessor mode (return EOM). We know that the lexer 3138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // was *not* in raw mode before, because the macro that the comment came 3148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // from was expanded. However, it could have already been in preprocessor 3158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // mode (#if COMMENT) in which case we have to return it to that mode and 3168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // return EOM. 3171a531570d294ffc300cce1bc5e73de847a370f4fTed Kremenek FoundLexer = ISI.ThePPLexer; 3188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = true; 3198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner LexerWasInPPMode = FoundLexer->ParsingPreprocessorDirective; 3208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = true; 3218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner break; 3228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 3231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Okay, we either found and switched over the lexer, or we didn't find a 3258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexer. In either case, finish off the macro the comment came from, getting 3268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // the next token. 3278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!HandleEndOfTokenLexer(Tok)) Lex(Tok); 3281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3298c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Discarding comments as long as we don't have EOF or EOM. This 'comments 3308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // out' the rest of the line, including any tokens that came from other macros 3318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // that were active, as in: 3328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // #define submacro a COMMENT b 3338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // submacro c 3348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // which should lex to 'a' only: 'b' and 'c' should be removed. 3358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner while (Tok.isNot(tok::eom) && Tok.isNot(tok::eof)) 3368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lex(Tok); 3371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an eom token, then we successfully found the end of the line. 3398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Tok.is(tok::eom)) { 3408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(FoundLexer && "Can't get end of line without an active lexer"); 3418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Restore the lexer back to normal mode instead of raw mode. 3428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = false; 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the lexer was already in preprocessor mode, just return the EOM token 3458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // to finish the preprocessor line. 3468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (LexerWasInPPMode) return; 3471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3488c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Otherwise, switch out of PP mode and return the next lexed token. 3498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = false; 3508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return Lex(Tok); 3518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an EOF token, then we reached the end of the token stream but 3548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // didn't find an explicit \n. This can only happen if there was no lexer 3558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // active (an active lexer would return EOM at EOF if there was no \n in 3568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // preprocessor directive mode), so just return EOF as our token. 3578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!FoundLexer && "Lexer should return EOM before EOF in PP mode"); 3588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 359