Preprocessor.h revision 636c5ef6572e899d36cec1b0023fb28ba65189e1
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" 216137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek#include "clang/Lex/PTHManager.h" 22adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner#include "clang/Basic/Diagnostic.h" 23c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 25cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 26caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 270ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 416137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 42e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Preprocessor { 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &Diags; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &Features; 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &Target; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 556137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 566137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 576137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 586137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek llvm::OwningPtr<PTHManager> PTH; 590ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek 600ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 610ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 620ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident_Pragma, *Ident__VA_ARGS__; // _Pragma, __VA_ARGS__ 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool DisableMacroExpansion : 1; // True if macro expansion is disabled. 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable Identifiers; 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 9268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 9368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// It is declared/instantiated here because it's role/lifetime is 9468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 9568d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// flow (in clang::ParseAST()), make it convenient to put here. 9668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 9768d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// the lifetime fo the preprocessor. 9829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 992e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1059c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 1069c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 107caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1099c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 1109c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1119c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1129c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1139c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1149c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1159c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1169c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 1179c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer* CurPPLexer; 1189c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1246cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 1256cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 126caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1306cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1329c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 1339c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 1349c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 1359c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer *TheTokenLexer; 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1379c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 1399c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 1409c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 1419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TheDirLookup(D) {} 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 149cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 150cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 151cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 152cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 1530ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 1540ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// allocation. 1550ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek std::vector<MacroInfo*> MICache; 1560ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 1649594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner 165aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 166aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 167aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 16853b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 1696cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 1706cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 1716cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 1726cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 1739e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 174e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 17503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis typedef std::vector<Token> CachedTokensTy; 17603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 17703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 17803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 17903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 18003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 18103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 18203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 18303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 18403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 18503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 186a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 187a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 188a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 189a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 190a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 19103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Preprocessor(Diagnostic &diags, const LangOptions &opts, TargetInfo &target, 19472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 19572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek IdentifierInfoLookup* IILookup); 19672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &getDiagnostics() const { return Diags; } 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &getTargetInfo() const { return Target; } 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 20729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 2086137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 2096137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void setPTHManager(PTHManager* pm) { PTH.reset(pm); } 2102e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 2215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 2227062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 2237062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCurrentLexer - Return the current file lexer being lexed from. Note 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// that this ignores any potentially active macro expansions and _Pragma 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 22968e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 231eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// getPPCallbacks/setPPCallbacks - Accessors for preprocessor callbacks. 232eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 233eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setPPCallbacks(PPCallbacks *C) { 236eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner delete Callbacks; 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 240cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 241cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 242cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 243cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner return II->hasMacroDefinition() ? Macros.find(II)->second : 0; 244cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 245cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 246cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 247cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 248cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 249cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 250e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 251aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 252aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 253aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 254aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 25553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 2615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStart, 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *NameEnd) { 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return &Identifiers.get(NameStart, NameEnd); 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStr) { 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return getIdentifierInfo(NameStr, NameStr+strlen(NameStr)); 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void AddPragmaHandler(const char *Namespace, PragmaHandler *Handler); 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2744095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 2754095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 2764095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 2774095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 2784095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar void RemovePragmaHandler(const char *Namespace, PragmaHandler *Handler); 2794095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 28053b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 2817dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 28295041a2029a069386ee67439f6d0fb524a9d184fTed Kremenek void EnterMainSourceFile(); 28353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 2845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 2855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. If isMainFile 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// is true, this is the main file for the translation unit. 28753b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner void EnterSourceFile(unsigned CurFileID, const DirectoryLookup *Dir); 2885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 2915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 292d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void EnterMacro(Token &Identifier, MacroArgs *Args); 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 2956b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 2966b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 2976b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 2986b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 2996b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 3006b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 3016b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 3026b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 3036b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 3046b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 3056b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 3066b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 3076b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 3105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 3125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 31303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 31403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 315ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 316ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 317ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 31803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 319a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 320ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 321ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 32203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 323ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 324ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 325ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 32603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 327a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 32803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 329ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 330ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 33103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 33203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 33303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos() was previously called. 334a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 33503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 33603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 33703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 338fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 33903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 342d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 345f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek else if (CurPTHLexer) 346f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek CurPTHLexer->Lex(Result); 3479e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis else if (CurTokenLexer) 3486cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner CurTokenLexer->Lex(Result); 34903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 35003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachingLex(Result); 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 3555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 356d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 361d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 3625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 3635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 364d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 3655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 3665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 3705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 3725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 3735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3756b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 3766b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 3776b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 3786b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 3796b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 38003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 38103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 38203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 38303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 38403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 3859e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 3863604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 38708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 38808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 38908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 39008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 39108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 39208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 39308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 39408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 39508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 39608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 39708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 39808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 39908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 40008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 4013604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 4023604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 4033604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 4043604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 4053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 4063604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 4073604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 4083604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 4093604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 4103604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 4113604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 4123604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 4133604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 4143604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 4153604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 4163604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 4173604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 4183604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis assert(Tok.isAnnotationToken() && "Expected annotation token"); 41983cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 4203604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 4213604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 4226b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner 4235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 424d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 426adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 427adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner return Diags.Report(FullSourceLoc(Loc, getSourceManager()), DiagID); 428adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 429adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner 430adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 431adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner return Diags.Report(FullSourceLoc(Tok.getLocation(), getSourceManager()), 432adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagID); 433adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 4345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 4365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 4375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 4385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 4395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 440d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner std::string getSpelling(const Token &Tok) const; 4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 4475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 4495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 452d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner unsigned getSpelling(const Token &Tok, const char *&Buffer) const; 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4540c21e84b82191ae1c4d04444a84008c464433868Chris Lattner /// getSpelledCharacterAt - Return a pointer to the start of the specified 4550c21e84b82191ae1c4d04444a84008c464433868Chris Lattner /// location in the appropriate MemoryBuffer. 4560c21e84b82191ae1c4d04444a84008c464433868Chris Lattner char getSpelledCharacterAt(SourceLocation SL) const { 45728396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek if (PTH) { 458df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner SL = SourceMgr.getSpellingLoc(SL); 4590c21e84b82191ae1c4d04444a84008c464433868Chris Lattner unsigned FID = SourceMgr.getCanonicalFileID(SL); 4600c21e84b82191ae1c4d04444a84008c464433868Chris Lattner unsigned FPos = SourceMgr.getFullFilePos(SL); 4610c21e84b82191ae1c4d04444a84008c464433868Chris Lattner const char *Data; 4620c21e84b82191ae1c4d04444a84008c464433868Chris Lattner if (PTH->getSpelling(FID, FPos, Data)) 4630c21e84b82191ae1c4d04444a84008c464433868Chris Lattner return *Data; 46428396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 46528396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 46628396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek return *SourceMgr.getCharacterData(SL); 46728396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 4685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CreateString - Plop the specified string into a scratch buffer and return 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a location for it. If specified, the source location provides a source 4715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// location for the token. 4725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation CreateString(const char *Buf, unsigned Len, 4735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation SourceLoc = SourceLocation()); 4745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 4765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 477d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 478c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 4795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 4805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 48197ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 48297ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 48397ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart,unsigned Char); 48497ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 4875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 4885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 4895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 4905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 4915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 4925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 4935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 4945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 4975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4983f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 4993f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 5003f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 5013f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 5023f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner 5035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 5045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 5055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 5065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookUpIdentifierInfo - Given a tok::identifier token, look up the 5085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier information for the token and install it into the token. 509d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner IdentifierInfo *LookUpIdentifierInfo(Token &Identifier, 5105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *BufPtr = 0); 5115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 5135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 5145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 5155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 516d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 5175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 5205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 5215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 5225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 523d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 5245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 525fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 526fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 527fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 5285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 5305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// at the start of a line. This consumes the directive, modifies the 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 533d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 5345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CheckEndOfDirective - Ensure that the next token is a tok::eom token. If 5365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// not, emit a diagnostic and consume up until the eom. 5375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void CheckEndOfDirective(const char *Directive); 5385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 539d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 540d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 5419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 5429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 5439c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 5449c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 5459c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 546f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 547d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 548d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 549d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 550caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 5519c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 5529c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 553caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 5549c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 555d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 556d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 557d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 5580ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 5590ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// SourceLocation. 5600ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek MacroInfo* AllocateMacroInfo(SourceLocation L); 5610ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek 5620ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 5630ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 5640ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek void ReleaseMacroInfo(MacroInfo* MI) { 5650ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek MICache.push_back(MI); 5660ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek } 5670ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek 56853b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// isInPrimaryFile - Return true if we're in the top-level file, not in a 56953b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// #include. 57053b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner bool isInPrimaryFile() const; 5717bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 5725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 5735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current line until the tok::eom token is found. 5745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DiscardUntilEndOfDirective(); 5755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 5775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #define or #undef. This emits a diagnostic, sets the token kind to eom, 5785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 579d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 5805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 5825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 5835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 5845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 5855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 5865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 5885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 5895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 5905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 5915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 5925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 5935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 5945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 5955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 5965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 5975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 598268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 599268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 600268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 601268ee7016a2811803989487c0ad3799486092c63Ted Kremenek 6025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 6035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 6085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 6095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 6105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 6125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 6135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 6145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *RegisterBuiltinMacro(const char *Name); 6155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 6175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 6185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 619d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 6205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 6225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 6235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 6245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 6255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 6275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 6285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 629d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI); 6305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 6325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 633d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 6345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 6365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 6375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 638d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 6395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 6415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 6425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 6436137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 6446137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 6456137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 6466137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// checked and spelled filename, e.g. as an operand of #include. This returns 6505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// true if the input filename was in <>'s or false if it were in ""'s. The 6515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// caller is expected to provide a buffer that is large enough to hold the 6525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// spelling of the filename, but is also expected to handle the case when 6535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this method decides to use a different buffer. 654f1c99acc544a4e70f308db4e7200ca04cd5a06d2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc, 6555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *&BufStart, const char *&BufEnd); 6565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 6585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return null on failure. isAngled indicates whether the file reference is 6595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for system #include's or not (i.e. using <> instead of ""). 6605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const FileEntry *LookupFile(const char *FilenameStart,const char *FilenameEnd, 6615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isAngled, const DirectoryLookup *FromDir, 6625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *&CurDir); 66341938c8493b4380df738263166b746eacb33c309Ted Kremenek 66441938c8493b4380df738263166b746eacb33c309Ted Kremenek 66541938c8493b4380df738263166b746eacb33c309Ted Kremenek 66634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 66734eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 66834eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 66934eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 67041938c8493b4380df738263166b746eacb33c309Ted Kremenek } 67141938c8493b4380df738263166b746eacb33c309Ted Kremenek 67281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 67381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 67441938c8493b4380df738263166b746eacb33c309Ted Kremenek } 67541938c8493b4380df738263166b746eacb33c309Ted Kremenek 67681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 67781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 67841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 67941938c8493b4380df738263166b746eacb33c309Ted Kremenek 6805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 68103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 68203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 6833296ccea50e7b6649638bd666181e0825145e898Ted Kremenek bool InCachingLexMode() const { return CurPPLexer == 0 && CurTokenLexer == 0;} 68403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 68503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 68603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 68703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 68803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 68903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 6903604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 69103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 69203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 6935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 6945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 6955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 6965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 697d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 698d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 6995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 701d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeDirective(Token &Tok, 7025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 7035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 704d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeNextDirective(Token &Tok); 705d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleImportDirective(Token &Tok); 7065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 70842e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 709d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 710d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleAssertDirective(Token &Tok); 711d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleUnassertDirective(Token &Tok); 7125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 714d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 7155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 716d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 717d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 718d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 719d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 7205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 7225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void HandlePragmaDirective(); 7235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 724d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 7252243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 726d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 727d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 728d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 729636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 7305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 732ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek/// PreprocessorFactory - A generic factory interface for lazily creating 733ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek/// Preprocessor objects on-demand when they are needed. 734ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenekclass PreprocessorFactory { 735ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenekpublic: 736ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek virtual ~PreprocessorFactory(); 737ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek virtual Preprocessor* CreatePreprocessor() = 0; 738ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek}; 739ec6c574478a22008847d7ebc2498ef3336752096Ted Kremenek 7405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 7415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 743