PPLexerChange.cpp revision 41938c8493b4380df738263166b746eacb33c309
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" 188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Basic/Diagnostic.h" 198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner#include "clang/Basic/SourceManager.h" 208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerusing namespace clang; 218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 224b391087f9c5582d448ab66ccbc7028f7673f380Ted KremenekPPCallbacks::~PPCallbacks() {} 238c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 256b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Miscellaneous Methods. 268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner//===----------------------------------------------------------------------===// 278c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// isInPrimaryFile - Return true if we're in the top-level file, not in a 297d39d742383ade80c9d937729bfc539c6c978845Chris Lattner/// #include. This looks through macro expansions and active _Pragma lexers. 308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::isInPrimaryFile() const { 3141938c8493b4380df738263166b746eacb33c309Ted Kremenek if (IsNonPragmaNonMacroLexer()) 328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return IncludeMacroStack.empty(); 338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If there are any stacked lexers, we're in a #include. 3541938c8493b4380df738263166b746eacb33c309Ted Kremenek assert(IsNonPragmaNonMacroLexer(IncludeMacroStack[0]) && 368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Top level include stack isn't our primary lexer?"); 378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 1, e = IncludeMacroStack.size(); i != e; ++i) 3841938c8493b4380df738263166b746eacb33c309Ted Kremenek if (IsNonPragmaNonMacroLexer(IncludeMacroStack[i])) 398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// getCurrentLexer - Return the current file lexer being lexed from. Note 448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// that this ignores any potentially active macro expansions and _Pragma 458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// expansions going on at the time. 468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris LattnerLexer *Preprocessor::getCurrentFileLexer() const { 47caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek if (CurLexer && !CurLexer->Is_PragmaLexer) return CurLexer.get(); 488c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Look for a stacked lexer. 508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = IncludeMacroStack.size(); i != 0; --i) { 518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lexer *L = IncludeMacroStack[i-1].TheLexer; 528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (L && !L->Is_PragmaLexer) // Ignore macro & _Pragma expansions. 538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return L; 548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return 0; 568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 586b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner 596b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 606b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner// Methods for Entering and Callbacks for leaving various contexts 616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner//===----------------------------------------------------------------------===// 628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterSourceFile - Add a source file to the top of the include stack and 648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// start lexing tokens from it instead of the current buffer. Return true 658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// on failure. 668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::EnterSourceFile(unsigned FileID, 678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner const DirectoryLookup *CurDir) { 688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(CurTokenLexer == 0 && "Cannot #include a file inside a macro!"); 698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner ++NumEnteredSourceFiles; 708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (MaxIncludeStackDepth < IncludeMacroStack.size()) 728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner MaxIncludeStackDepth = IncludeMacroStack.size(); 738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lexer *TheLexer = new Lexer(SourceLocation::getFileLoc(FileID, 0), *this); 758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner EnterSourceFileWithLexer(TheLexer, CurDir); 768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 77721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner 788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterSourceFile - Add a source file to the top of the include stack and 798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// start lexing tokens from it instead of the current buffer. 808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::EnterSourceFileWithLexer(Lexer *TheLexer, 818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner const DirectoryLookup *CurDir) { 828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Add the current lexer to the include stack. 8441938c8493b4380df738263166b746eacb33c309Ted Kremenek if (CurPPLexer || CurTokenLexer) 85ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 86ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek 87caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(TheLexer); 889c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = TheLexer; 898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = CurDir; 908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Callbacks && !CurLexer->Is_PragmaLexer) { 939d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 940b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner SourceMgr.getFileCharacteristic(CurLexer->getFileLoc()); 958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Callbacks->FileChanged(CurLexer->getFileLoc(), 978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner PPCallbacks::EnterFile, FileType); 988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterMacro - Add a Macro to the top of the include stack and start lexing 1048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// tokens from it instead of the current buffer. 1058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::EnterMacro(Token &Tok, MacroArgs *Args) { 106ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 110caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(new TokenLexer(Tok, Args, *this)); 1118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 112caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 1138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurTokenLexer->Init(Tok, Args); 1148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// EnterTokenStream - Add a "macro" context to the top of the include stack, 1186b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// which will cause the lexer to start returning the specified tokens. 1196b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1206b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If DisableMacroExpansion is true, tokens lexed from the token stream will 1216b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// not be subject to further macro expansion. Otherwise, these tokens will 1226b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// be re-macro-expanded when/if expansion is enabled. 1236b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1246b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If OwnsTokens is false, this method assumes that the specified stream of 1256b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// tokens has a permanent owner somewhere, so they do not need to be copied. 1266b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// If it is true, it assumes the array of tokens is allocated with new[] and 1276b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// must be freed. 1286b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner/// 1296b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattnervoid Preprocessor::EnterTokenStream(const Token *Toks, unsigned NumToks, 1306b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, 1316b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool OwnsTokens) { 1328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Save our current state. 133ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PushIncludeMacroStack(); 1348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurDirLookup = 0; 1358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Create a macro expander to expand from the specified token stream. 1378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == 0) { 138caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(new TokenLexer(Toks, NumToks, DisableMacroExpansion, 139caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek OwnsTokens, *this)); 1408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 141caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(TokenLexerCache[--NumCachedTokenLexers]); 1426b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner CurTokenLexer->Init(Toks, NumToks, DisableMacroExpansion, OwnsTokens); 1438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1448c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 1458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1468c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfFile - This callback is invoked when the lexer hits the end of 1478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the current file. This either returns the EOF token or pops a level off 1488c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// the include stack and keeps going. 1498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfFile(Token &Result, bool isEndOfMacro) { 1508c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!CurTokenLexer && 1518c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a file when currently in a macro!"); 1528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // See if this file had a controlling macro. 1548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (CurLexer) { // Not ending a macro, ignore it. 1558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (const IdentifierInfo *ControllingMacro = 1568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurLexer->MIOpt.GetControllingMacroAtEndOfFile()) { 1578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Okay, this has a controlling macro, remember in PerFileInfo. 1588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (const FileEntry *FE = 1598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner SourceMgr.getFileEntryForLoc(CurLexer->getFileLoc())) 1608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner HeaderInfo.SetFileControllingMacro(FE, ControllingMacro); 1618c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If this is a #include'd file, pop it off the include stack and continue 1658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexing the #includer file. 1668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!IncludeMacroStack.empty()) { 1678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We're done with the #included file. 1688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner RemoveTopOfLexerStack(); 1698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Notify the client, if desired, that we are in a new source file. 1718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Callbacks && !isEndOfMacro && CurLexer) { 1729d72851fec9e9c62570a027d42701562bbf29751Chris Lattner SrcMgr::CharacteristicKind FileType = 1730b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner SourceMgr.getFileCharacteristic(CurLexer->getFileLoc()); 1748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Callbacks->FileChanged(CurLexer->getSourceLocation(CurLexer->BufferPtr), 1768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner PPCallbacks::ExitFile, FileType); 1778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Client should lex another token. 1808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return false; 1818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the file ends with a newline, form the EOF token on the newline itself, 1848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // rather than "on the line following it", which doesn't exist. This makes 1858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // diagnostics relating to the end of file include the last file that the user 1868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // actually typed, which is goodness. 1878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner const char *EndPos = CurLexer->BufferEnd; 1888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (EndPos != CurLexer->BufferStart && 1898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner (EndPos[-1] == '\n' || EndPos[-1] == '\r')) { 1908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner --EndPos; 1918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Handle \n\r and \r\n: 1938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (EndPos != CurLexer->BufferStart && 1948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner (EndPos[-1] == '\n' || EndPos[-1] == '\r') && 1958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner EndPos[-1] != EndPos[0]) 1968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner --EndPos; 1978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 1988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 1998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Result.startToken(); 2008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner CurLexer->BufferPtr = EndPos; 2019e6293d4dfd688429f77ee3b6edba9dfd7ada3a2Chris Lattner CurLexer->FormTokenWithChars(Result, EndPos, tok::eof); 2028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We're done with the #included file. 204caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(); 20541938c8493b4380df738263166b746eacb33c309Ted Kremenek CurPPLexer = 0; 2068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // This is the end of the top-level file. If the diag::pp_macro_not_used 2088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // diagnostic is enabled, look for macros that have not been used. 2098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Diags.getDiagnosticLevel(diag::pp_macro_not_used) != Diagnostic::Ignored){ 2108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I = 2118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Macros.begin(), E = Macros.end(); I != E; ++I) { 2128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!I->second->isUsed()) 2138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Diag(I->second->getDefinitionLoc(), diag::pp_macro_not_used); 2148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return true; 2178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2188c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2198c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer 2208c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// hits the end of its token stream. 2218c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnerbool Preprocessor::HandleEndOfTokenLexer(Token &Result) { 2228c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(CurTokenLexer && !CurLexer && 2238c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Ending a macro when currently in a #include file!"); 2248c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2258c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2268c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 227caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2288c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 229caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 2308c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2318c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Handle this like a #include file being popped off the stack. 2328c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return HandleEndOfFile(Result, true); 2338c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2348c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2358c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 2368c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// lexer stack. This should only be used in situations where the current 2378c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state of the top-of-stack lexer is unknown. 2388c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::RemoveTopOfLexerStack() { 2398c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!IncludeMacroStack.empty() && "Ran out of stack entries to load"); 2408c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2418c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (CurTokenLexer) { 2428c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Delete or cache the now-dead macro expander. 2438c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (NumCachedTokenLexers == TokenLexerCacheSize) 244caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(); 2458c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner else 246caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek TokenLexerCache[NumCachedTokenLexers++] = CurTokenLexer.take(); 2478c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } else { 248caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(); 2498c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 250ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek 251ed04c4cdca11119cac7d2fd65685444ce25f9e37Ted Kremenek PopIncludeMacroStack(); 2528c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 2538c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2548c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// HandleMicrosoftCommentPaste - When the macro expander pastes together a 2558c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// comment (/##/) in microsoft mode, this method handles updating the current 2568c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner/// state, returning the token on the next source line. 2578c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattnervoid Preprocessor::HandleMicrosoftCommentPaste(Token &Tok) { 2588c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(CurTokenLexer && !CurLexer && 2598c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner "Pasted comment can only be formed from macro"); 2608c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2618c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // We handle this by scanning for the closest real lexer, switching it to 2628c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // raw mode and preprocessor mode. This will cause it to return \n as an 2638c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // explicit EOM token. 2648c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lexer *FoundLexer = 0; 2658c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner bool LexerWasInPPMode = false; 2668c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) { 2678c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner IncludeStackInfo &ISI = *(IncludeMacroStack.end()-i-1); 2688c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (ISI.TheLexer == 0) continue; // Scan for a real lexer. 2698c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2708c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Once we find a real lexer, mark it as raw mode (disabling macro 2718c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // expansions) and preprocessor mode (return EOM). We know that the lexer 2728c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // was *not* in raw mode before, because the macro that the comment came 2738c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // from was expanded. However, it could have already been in preprocessor 2748c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // mode (#if COMMENT) in which case we have to return it to that mode and 2758c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // return EOM. 2768c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer = ISI.TheLexer; 2778c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = true; 2788c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner LexerWasInPPMode = FoundLexer->ParsingPreprocessorDirective; 2798c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = true; 2808c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner break; 2818c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 2828c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2838c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Okay, we either found and switched over the lexer, or we didn't find a 2848c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // lexer. In either case, finish off the macro the comment came from, getting 2858c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // the next token. 2868c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (!HandleEndOfTokenLexer(Tok)) Lex(Tok); 2878c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2888c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Discarding comments as long as we don't have EOF or EOM. This 'comments 2898c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // out' the rest of the line, including any tokens that came from other macros 2908c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // that were active, as in: 2918c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // #define submacro a COMMENT b 2928c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // submacro c 2938c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // which should lex to 'a' only: 'b' and 'c' should be removed. 2948c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner while (Tok.isNot(tok::eom) && Tok.isNot(tok::eof)) 2958c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner Lex(Tok); 2968c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 2978c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an eom token, then we successfully found the end of the line. 2988c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (Tok.is(tok::eom)) { 2998c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(FoundLexer && "Can't get end of line without an active lexer"); 3008c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Restore the lexer back to normal mode instead of raw mode. 3018c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->LexingRawMode = false; 3028c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3038c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If the lexer was already in preprocessor mode, just return the EOM token 3048c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // to finish the preprocessor line. 3058c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner if (LexerWasInPPMode) return; 3068c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3078c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // Otherwise, switch out of PP mode and return the next lexed token. 3088c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner FoundLexer->ParsingPreprocessorDirective = false; 3098c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner return Lex(Tok); 3108c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner } 3118c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner 3128c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // If we got an EOF token, then we reached the end of the token stream but 3138c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // didn't find an explicit \n. This can only happen if there was no lexer 3148c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // active (an active lexer would return EOM at EOF if there was no \n in 3158c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner // preprocessor directive mode), so just return EOF as our token. 3168c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner assert(!FoundLexer && "Lexer should return EOM before EOF in PP mode"); 3178c32b1a7daf246b26e52b46604d91ce3717e28e5Chris Lattner} 318