Preprocessor.h revision 68e48e4a81767997ef0231e47eca4f665102c95e
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Preprocessor.h - C Language Family Preprocessor --------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Preprocessor interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_LEX_PREPROCESSOR_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_LEX_PREPROCESSOR_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/Lexer.h" 189c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek#include "clang/Lex/PTHLexer.h" 19eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner#include "clang/Lex/PPCallbacks.h" 205d75de0f821023f4ed4815825bf3aea8a0b5e40dChris Lattner#include "clang/Lex/TokenLexer.h" 21c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 23cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 24caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 39e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Preprocessor { 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &Diags; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &Features; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &Target; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident_Pragma, *Ident__VA_ARGS__; // _Pragma, __VA_ARGS__ 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool DisableMacroExpansion : 1; // True if macro expansion is disabled. 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable Identifiers; 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8068d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 8168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 8268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// It is declared/instantiated here because it's role/lifetime is 8368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 8468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// flow (in clang::ParseAST()), make it convenient to put here. 8568d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 8668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// the lifetime fo the preprocessor. 8729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 882e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 949c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 959c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 96caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 989c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 999c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1009c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1019c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1029c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1039c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1049c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1059c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 1069c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer* CurPPLexer; 1079c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1136cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 1146cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 115caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1196cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1219c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 1229c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 1239c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 1249c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer *TheTokenLexer; 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1269c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1279c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 1289c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 1299c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 1309c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TheDirLookup(D) {} 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 138cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 139cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 140cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 141cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 1499594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner 150aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 151aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 152aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 15353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 1546cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 1556cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 1566cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 1576cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 1589e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 159e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 16003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis typedef std::vector<Token> CachedTokensTy; 16103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 16203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 16303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 16403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 16503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 16603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 16703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 16803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 16903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 17003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 171a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 172a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 173a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 174a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 175a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 17603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Preprocessor(Diagnostic &diags, const LangOptions &opts, TargetInfo &target, 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SM, HeaderSearch &Headers); 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &getDiagnostics() const { return Diags; } 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &getTargetInfo() const { return Target; } 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 19029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 1912e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 192e0579f08d4a4ae57971b74ca1863106df4c6399fTed Kremenek inline FullSourceLoc getFullLoc(SourceLocation Loc) const { 19394b3cdb57fd5d245963e597626e0dfd88d479795Chris Lattner return FullSourceLoc(Loc, getSourceManager()); 194ea8646993741739d8a04d67396fe466dcc3a104fTed Kremenek } 195ea8646993741739d8a04d67396fe466dcc3a104fTed Kremenek 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isCurrentLexer(const Lexer *L) const { 208caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek return CurLexer.get() == L; 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCurrentLexer - Return the current file lexer being lexed from. Note 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// that this ignores any potentially active macro expansions and _Pragma 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 21468e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 216eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// getPPCallbacks/setPPCallbacks - Accessors for preprocessor callbacks. 217eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 218eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setPPCallbacks(PPCallbacks *C) { 221eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner delete Callbacks; 2225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 2235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 225cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 226cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 227cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 228cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner return II->hasMacroDefinition() ? Macros.find(II)->second : 0; 229cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 230cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 231cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 232cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 233cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 234cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 235e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 236aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 237aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 238aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 239aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 24053b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStart, 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *NameEnd) { 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return &Identifiers.get(NameStart, NameEnd); 2495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStr) { 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return getIdentifierInfo(NameStr, NameStr+strlen(NameStr)); 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void AddPragmaHandler(const char *Namespace, PragmaHandler *Handler); 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2594095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 2604095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 2614095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 2624095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 2634095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar void RemovePragmaHandler(const char *Namespace, PragmaHandler *Handler); 2644095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 26553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 2667dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 26795041a2029a069386ee67439f6d0fb524a9d184fTed Kremenek void EnterMainSourceFile(); 26853b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. If isMainFile 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// is true, this is the main file for the translation unit. 27253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner void EnterSourceFile(unsigned CurFileID, const DirectoryLookup *Dir); 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 277d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void EnterMacro(Token &Identifier, MacroArgs *Args); 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 2806b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 2816b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 2826b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 2836b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 2846b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 2856b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 2866b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 2876b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 2886b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 2896b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 2906b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 2916b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 2926b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 2965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 29803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 29903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 300ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 301ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 302ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 30303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 304a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 305ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 306ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 30703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 308ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 309ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 310ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 31103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 312a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 31303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 314ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 315ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 31603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 31703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 31803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos() was previously called. 319a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 32003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 32103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 32203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 323fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 32403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 3265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 327d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 3285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 3295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 330f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek else if (CurPTHLexer) 331f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek CurPTHLexer->Lex(Result); 3329e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis else if (CurTokenLexer) 3336cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner CurTokenLexer->Lex(Result); 33403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 33503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachingLex(Result); 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 341d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 346d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 3475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 3485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 349d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 3535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 3555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3606b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 3616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 3626b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 3636b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 3646b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 36503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 36603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 36703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 36803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 36903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 3709e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 3713604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 37208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 37308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 37408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 37508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 37608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 37708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 37808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 37908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 38008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 38108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 38208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 38308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 38408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 38508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 3863604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 3873604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 3883604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 3893604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 3903604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 3913604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 3923604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 3933604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 3943604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 3953604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 3963604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 3973604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 3983604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 3993604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 4003604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 4013604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 4023604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 4033604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis assert(Tok.isAnnotationToken() && "Expected annotation token"); 4043604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis if (CachedLexPos != 0 && InCachingLexMode()) 4053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 4063604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 4076b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner 4085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 409d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 4105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 4113692b09faa9fe346f39bc922db6dce48cdcc3f63Chris Lattner DiagnosticInfo Diag(SourceLocation Loc, unsigned DiagID); 4123692b09faa9fe346f39bc922db6dce48cdcc3f63Chris Lattner DiagnosticInfo Diag(const Token &Tok, unsigned DiagID); 4135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 4155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 4165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 4175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 419d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner std::string getSpelling(const Token &Tok) const; 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 4225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 4235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 4245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 4275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 4285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 4295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 4305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 431d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner unsigned getSpelling(const Token &Tok, const char *&Buffer) const; 4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CreateString - Plop the specified string into a scratch buffer and return 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a location for it. If specified, the source location provides a source 4365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// location for the token. 4375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation CreateString(const char *Buf, unsigned Len, 4385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation SourceLoc = SourceLocation()); 4395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 442d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 443c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 44697ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 44797ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 44897ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart,unsigned Char); 44997ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 4525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 4565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 4575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 4585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 4625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4633f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 4643f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 4653f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 4663f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 4673f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner 4685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 4695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 4715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookUpIdentifierInfo - Given a tok::identifier token, look up the 4735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier information for the token and install it into the token. 474d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner IdentifierInfo *LookUpIdentifierInfo(Token &Identifier, 4755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *BufPtr = 0); 4765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 4785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 4795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 4805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 481d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 4825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 4875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 488d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 4895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 490fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 491fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 492fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 4935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 4955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// at the start of a line. This consumes the directive, modifies the 4965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 4975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 498d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 4995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CheckEndOfDirective - Ensure that the next token is a tok::eom token. If 5015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// not, emit a diagnostic and consume up until the eom. 5025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void CheckEndOfDirective(const char *Directive); 5035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 504d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 505d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 5069c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 5079c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 5089c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 5099c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 5109c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 511f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 512d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 513d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 514d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 515caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 5169c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 5179c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 518caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 5199c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 520d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 521d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 522d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 52353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// isInPrimaryFile - Return true if we're in the top-level file, not in a 52453b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// #include. 52553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner bool isInPrimaryFile() const; 5267bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 5275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 5285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current line until the tok::eom token is found. 5295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DiscardUntilEndOfDirective(); 5305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #define or #undef. This emits a diagnostic, sets the token kind to eom, 5335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 534d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 5375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 5385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 5395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 5405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 5415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 5435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 5445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 5455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 5475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 5485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 5505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 5515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 5525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 5545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 5555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 5565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 5575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 5595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 5605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 5615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 5635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 5645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 5655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *RegisterBuiltinMacro(const char *Name); 5665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 5685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 5695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 570d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 5715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 5735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 5745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 5755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 5765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 5785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 5795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 580d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI); 5815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 5835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 584d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 5855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 5875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 5885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 589d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 5905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 5935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 5945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 5955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 5975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// checked and spelled filename, e.g. as an operand of #include. This returns 5985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// true if the input filename was in <>'s or false if it were in ""'s. The 5995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// caller is expected to provide a buffer that is large enough to hold the 6005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// spelling of the filename, but is also expected to handle the case when 6015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this method decides to use a different buffer. 602f1c99acc544a4e70f308db4e7200ca04cd5a06d2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc, 6035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *&BufStart, const char *&BufEnd); 6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return null on failure. isAngled indicates whether the file reference is 6075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for system #include's or not (i.e. using <> instead of ""). 6085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const FileEntry *LookupFile(const char *FilenameStart,const char *FilenameEnd, 6095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isAngled, const DirectoryLookup *FromDir, 6105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *&CurDir); 61141938c8493b4380df738263166b746eacb33c309Ted Kremenek 61241938c8493b4380df738263166b746eacb33c309Ted Kremenek 61341938c8493b4380df738263166b746eacb33c309Ted Kremenek 61441938c8493b4380df738263166b746eacb33c309Ted Kremenek static bool IsNonPragmaNonMacroLexer(const Lexer* L, 61541938c8493b4380df738263166b746eacb33c309Ted Kremenek const PreprocessorLexer* P) { 61641938c8493b4380df738263166b746eacb33c309Ted Kremenek if (L) 61741938c8493b4380df738263166b746eacb33c309Ted Kremenek return !L->isPragmaLexer(); 61841938c8493b4380df738263166b746eacb33c309Ted Kremenek else 61941938c8493b4380df738263166b746eacb33c309Ted Kremenek return P != 0; 62041938c8493b4380df738263166b746eacb33c309Ted Kremenek } 62141938c8493b4380df738263166b746eacb33c309Ted Kremenek 62241938c8493b4380df738263166b746eacb33c309Ted Kremenek static bool IsNonPragmaNonMacroLexer(const IncludeStackInfo& I) { 62341938c8493b4380df738263166b746eacb33c309Ted Kremenek return IsNonPragmaNonMacroLexer(I.TheLexer, I.ThePPLexer); 62441938c8493b4380df738263166b746eacb33c309Ted Kremenek } 62541938c8493b4380df738263166b746eacb33c309Ted Kremenek 62641938c8493b4380df738263166b746eacb33c309Ted Kremenek bool IsNonPragmaNonMacroLexer() const { 62741938c8493b4380df738263166b746eacb33c309Ted Kremenek return IsNonPragmaNonMacroLexer(CurLexer.get(), CurPPLexer); 62841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 62941938c8493b4380df738263166b746eacb33c309Ted Kremenek 6305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 63103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 63203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 63303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis bool InCachingLexMode() const { return CurLexer == 0 && CurTokenLexer == 0; } 63403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 63503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 63603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 63703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 63803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 63903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 6403604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 64103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 64203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 6435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 6445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 6455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 6465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 647d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 648d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 651d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeDirective(Token &Tok, 6525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 6535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 654d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeNextDirective(Token &Tok); 655d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleImportDirective(Token &Tok); 6565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 65842e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 659d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 660d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleAssertDirective(Token &Tok); 661d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleUnassertDirective(Token &Tok); 6625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 664d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 6655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 666d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 667d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 668d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 669d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 6705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void HandlePragmaDirective(); 6735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 674d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 6752243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 676d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 677d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 678d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 6795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 6805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 681ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek/// PreprocessorFactory - A generic factory interface for lazily creating 682ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek/// Preprocessor objects on-demand when they are needed. 683ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenekclass PreprocessorFactory { 684ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenekpublic: 685ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek virtual ~PreprocessorFactory(); 686ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek virtual Preprocessor* CreatePreprocessor() = 0; 687ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek}; 688ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek 6895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 6905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 692