Preprocessor.h revision a5d10c4df435964600e104ebef6a96b106e416b7
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" 221b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner#include "clang/Basic/Builtins.h" 23adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner#include "clang/Basic/Diagnostic.h" 24c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 26cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 27caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 28f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer#include "llvm/ADT/SmallVector.h" 290ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 302e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor#include <vector> 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 3588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregorclass ExternalPreprocessorSource; 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 412e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler; 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 46a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 47e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Preprocessor { 53836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic *Diags; 54ba1e898c64048e25cb65afec3807ad463e41914bArgyrios Kyrtzidis LangOptions Features; 55444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &Target; 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 6288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 63a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 646137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 656137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 666137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek llvm::OwningPtr<PTHManager> PTH; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 680ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 690ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 700ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 78c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident_Pragma, *Ident__VA_ARGS__; // _Pragma, __VA_ARGS__ 80148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 81148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 8292bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 8392bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 86c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1005814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1015814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1025814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1031d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1041d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1051d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 10688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 10788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 108a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 111c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 11468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// It is declared/instantiated here because it's role/lifetime is 11668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 11868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 11968d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// the lifetime fo the preprocessor. 12029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1212e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1221b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1231b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1302e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1312e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1332968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1342968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1352968442603b029949246467253eeac8139a5b6d8Douglas Gregor 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1379c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 1389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 139caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 1401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 1429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1439c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1449c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1469c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1479c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1489c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 14923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 1501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1566cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 1576cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 158caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 1591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1626cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1649c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 1659c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 1669c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 1671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1699c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1709c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 1719c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 1729c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 1739c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TheDirLookup(D) {} 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 181cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 182cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 183cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1850ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 18623f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// allocation. 18723f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// FIXME: why not use a singly linked list? 1880ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek std::vector<MacroInfo*> MICache; 189a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 19023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 19123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 19223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 19323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 1941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 2021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 203aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 204aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 205aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 2061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2076cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 2086cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 2096cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 2106cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 2119e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 212e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 213f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer typedef llvm::SmallVector<Token, 1> CachedTokensTy; 21403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 21503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 21603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 21703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 21803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 21903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 22003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 22103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 22203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 22303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 224a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 225a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 226a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 227a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 228a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 22903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 231444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar Preprocessor(Diagnostic &diags, const LangOptions &opts, 232444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &target, 23372b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 2345814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 2355814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch = false); 23672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 239836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic &getDiagnostics() const { return *Diags; } 2407c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner void setDiagnostics(Diagnostic &D) { Diags = &D; } 2417c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 243444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &getTargetInfo() const { return Target; } 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 24929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 2501b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 25132fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 2521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 253337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 2541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 255880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 2562e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 25788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 25888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 25988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 260a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 26188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 26288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 26388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 264a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 2685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 2731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 2767062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 2777062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 280a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 281a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 282a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 283a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 284a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 285a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentFileLexer - Return the current file lexer being lexed from. Note 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// that this ignores any potentially active macro expansions and _Pragma 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 28868e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 2891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 290a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 291eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 292eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 294a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 295e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 296e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 300cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 301cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 302cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 303cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner return II->hasMacroDefinition() ? Macros.find(II)->second : 0; 304cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 306cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 307cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 308cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 3091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31009b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 31109b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// state of the macro table. This visits every currently-defined macro. 3121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 31309b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 31488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 31588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 316a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 317e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 318aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 319aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 320aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 321aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 3221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 3245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 3265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 3275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 328c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar IdentifierInfo *getIdentifierInfo(llvm::StringRef Name) const { 3293da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 3305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 3335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 3345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void AddPragmaHandler(const char *Namespace, PragmaHandler *Handler); 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3374095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 3384095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 3394095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 3404095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 3414095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar void RemovePragmaHandler(const char *Namespace, PragmaHandler *Handler); 3424095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 3432e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 3442e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void AddCommentHandler(CommentHandler *Handler); 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3462e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 3472e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 3482e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 3492e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void RemoveCommentHandler(CommentHandler *Handler); 3501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35153b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 3527dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void EnterMainSourceFile(); 3541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 3566e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner /// start lexing tokens from it instead of the current buffer. Return true 35739d9841ed4c0568d4b44dfbc12ac04491f60a374Chris Lattner /// and fill in ErrorStr with the error information on failure. 35839d9841ed4c0568d4b44dfbc12ac04491f60a374Chris Lattner bool EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 35963ceaa32a2371e38d1f912080fe471285e6b6e56Daniel Dunbar std::string &ErrorStr); 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 3625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 3635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 364e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 365e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 366e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 367e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 3706b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 3716b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 3726b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 3736b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 3746b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 3756b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 3766b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 3776b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 3786b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 3796b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 3806b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 3816b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 3826b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 3855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 3865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 38803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 38903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 390ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 391ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 392ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 39303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 394a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 395ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 396ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 39703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 398ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 399ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 400ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 40103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 402a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 40303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 404ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 405ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 40603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 40703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 4081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 409a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 41003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 41103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 41203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 413fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 41403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 4155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 4165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 417d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 4195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 420f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek else if (CurPTHLexer) 421f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek CurPTHLexer->Lex(Result); 4229e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis else if (CurTokenLexer) 4236cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner CurTokenLexer->Lex(Result); 42403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 42503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachingLex(Result); 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 4295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 4305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 431d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 4335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 4345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 436d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 4375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 4385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 439d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 4405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 4425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 4451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 4475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4506b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 4516b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 4526b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 4536b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 4546b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 45503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 45603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 45703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 45803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 45903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 4609e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 4613604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 46208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 46308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 46408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 46508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 46608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 46708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 46808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 46908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 47008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 47108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 47208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 47308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 47408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 47508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 4763604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 4773604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 4783604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 4793604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 4803604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 4813604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 4823604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 4833604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 4843604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 4853604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 4863604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 4873604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 4883604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 4893604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 4903604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 4913604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 4923604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 49347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 49483cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 4953604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 4963604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 49739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 49939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 50039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 50139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 50239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 50339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 50439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 50539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 50639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 50739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 50839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 50939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 51039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 51139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 5122968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 5132968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 5142968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 5152968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 5162968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 5172968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 5182968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 5192968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 5202968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 5212968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 5222968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 5232968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 5242968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 5252968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 526a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 5272968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 5282968442603b029949246467253eeac8139a5b6d8Douglas Gregor 5292968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Determine if this source location refers into the file 5302968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// for which we are performing code completion. 531109ae73ec71a1d27358510ce049b59637b4a6b40Douglas Gregor bool isCodeCompletionFile(SourceLocation FileLoc) const; 5322968442603b029949246467253eeac8139a5b6d8Douglas Gregor 5335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 534d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 536adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 537836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner return Diags->Report(FullSourceLoc(Loc, getSourceManager()), DiagID); 538adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 540adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 541836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner return Diags->Report(FullSourceLoc(Tok.getLocation(), getSourceManager()), 542836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner DiagID); 543adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 5475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 5485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 550d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner std::string getSpelling(const Token &Tok) const; 5511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5520ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 5530ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar /// token is the characters used to represent the token in the source file 5540ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar /// after trigraph expansion and escaped-newline folding. In particular, this 5550ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar /// wants to get the true, uncanonicalized, spelling of things like digraphs 5560ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar /// UCNs, etc. 5570ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar static std::string getSpelling(const Token &Tok, 5580ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar const SourceManager &SourceMgr, 5590ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar const LangOptions &Features); 5600ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 5615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 5625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 5635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 5645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 5655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 5665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 5675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 5685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 5695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 5705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 571d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner unsigned getSpelling(const Token &Tok, const char *&Buffer) const; 572b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 573ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 574ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 575ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 576ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer llvm::StringRef getSpelling(const Token &Tok, 57751f5fe3f2527cd1640d798d8d134268b14de3e86Benjamin Kramer llvm::SmallVectorImpl<char> &Buffer) const; 578ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 5797216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 5807216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 5817216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner char getSpellingOfSingleCharacterNumericConstant(const Token &Tok) const { 5827216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 5837216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 5847216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 5857216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 5867216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 5877216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 5887216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 58928396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 5907216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 5917216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 5927216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *SourceMgr.getCharacterData(Tok.getLocation()); 59328396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 59647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 59747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// location provides a location of the instantiation point of the token. 59847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void CreateString(const char *Buf, unsigned Len, 59947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner Token &Tok, SourceLocation SourceLoc = SourceLocation()); 600b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 601b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 602b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 603b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 604b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 605b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 606b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 607b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 608b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 609b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 610b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 61133e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 61233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 61333e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 61433e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 61533e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 61633e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0); 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 6195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 620d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 621c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 6225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 6231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62497ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 62597ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 62697ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart,unsigned Char); 6271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 6295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 6305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 6311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 6325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 6335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 6345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 6355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 6365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 6375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 6405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6413f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 6423f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 6433f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 6443f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 6451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 6485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookUpIdentifierInfo - Given a tok::identifier token, look up the 6515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier information for the token and install it into the token. 652d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner IdentifierInfo *LookUpIdentifierInfo(Token &Identifier, 653c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar const char *BufPtr = 0) const; 6541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 6565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 6575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 6585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 659d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 6605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 6635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 6645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 6655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 666d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 6671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 668fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 669fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 670fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 6711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 6731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 6745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 6755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 676d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 6775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CheckEndOfDirective - Ensure that the next token is a tok::eom token. If 679ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// not, emit a diagnostic and consume up until the eom. If EnableMacros is 680ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 681ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 683478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 684478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// current line until the tok::eom token is found. 685478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6877c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 6887c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 6897c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 6907c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 6917c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 692c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 693c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 695f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 696f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// SourceLocation. 697f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner MacroInfo* AllocateMacroInfo(SourceLocation L); 6981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 699a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 700a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// checked and spelled filename, e.g. as an operand of #include. This returns 701a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// true if the input filename was in <>'s or false if it were in ""'s. The 702a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// caller is expected to provide a buffer that is large enough to hold the 703a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// spelling of the filename, but is also expected to handle the case when 704a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// this method decides to use a different buffer. 705a139481e62fdb209d9d87a54a5733f989d2e8d51Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,llvm::StringRef &Filename); 706a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 707a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 708a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// return null on failure. isAngled indicates whether the file reference is 709a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// for system #include's or not (i.e. using <> instead of ""). 710a139481e62fdb209d9d87a54a5733f989d2e8d51Chris Lattner const FileEntry *LookupFile(llvm::StringRef Filename, 711f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 712a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *&CurDir); 713a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 714a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 715a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 716a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// implement #include_next and find directory-specific properties. 717a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 718a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 719a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// isInPrimaryFile - Return true if we're in the top-level file, not in a 720a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include. 721a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 722a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 723a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// ConcatenateIncludeName - Handle cases where the #include name is expanded 724a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 725a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 726a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #define FOO <a/b.h> 727a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include FOO 728a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 729a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 730a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// This code concatenates and consumes tokens up to the '>' token. It returns 731a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// false if the > was found, otherwise it returns true if it finds and consumes 732a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// the EOM marker. 733a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool ConcatenateIncludeName(llvm::SmallVector<char, 128> &FilenameBuffer); 734a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 7355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 7361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 737d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 7389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 7399c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 7409c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 7419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 7429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 743f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 744d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 746d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 747caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 7489c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 7499c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 750caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 7519c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 752d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 753d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 7541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7550ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 7560ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 7570301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 7581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 7605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #define or #undef. This emits a diagnostic, sets the token kind to eom, 7615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 762d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 7631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 7655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 7665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 7675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 7685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 7715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 7725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 7735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 7745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 7755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 7765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 7775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 7785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 7795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 7801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 781268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 782268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 783268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 7841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 7865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 7875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 7885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 7891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 7915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 7925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 7931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 7955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 7965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 7971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 7995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 8005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 801d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 8021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 8045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 8055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 8065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 8071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 8095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 8105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 811e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 812e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner SourceLocation &InstantiationEnd); 8135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 8155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 816d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 8195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 8205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 821d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 8221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 8245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 8255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 8266137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 8276137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 8286137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 8296137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 8301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 83134eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 83234eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 83334eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 83434eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 83541938c8493b4380df738263166b746eacb33c309Ted Kremenek } 83641938c8493b4380df738263166b746eacb33c309Ted Kremenek 83781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 83881d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 83941938c8493b4380df738263166b746eacb33c309Ted Kremenek } 84041938c8493b4380df738263166b746eacb33c309Ted Kremenek 84181d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 84281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 84341938c8493b4380df738263166b746eacb33c309Ted Kremenek } 8441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 84603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 84703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 8483296ccea50e7b6649638bd666181e0825145e898Ted Kremenek bool InCachingLexMode() const { return CurPPLexer == 0 && CurTokenLexer == 0;} 84903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 85003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 85103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 85203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 85303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 85403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 8553604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 85603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 85703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 8585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 8595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 8605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 861359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 862478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 863d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 864d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 8651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 867d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeDirective(Token &Tok, 8685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 8695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 870d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeNextDirective(Token &Tok); 871de076650fa79a02743b5fe57a72f991ba24779f9Chris Lattner void HandleIncludeMacrosDirective(Token &Tok); 872d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleImportDirective(Token &Tok); 8731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 87542e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 876d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 877d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleAssertDirective(Token &Tok); 878d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleUnassertDirective(Token &Tok); 8791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 881d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 8825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 883d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 884d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 885d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 886d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 8871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 8895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void HandlePragmaDirective(); 8905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 891d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 8922243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 893d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 894d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 895d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 896636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 897046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 898046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 899046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 9005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 9032e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 9042e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 9052e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 9062e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 9071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 908046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 909046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 910046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 9112e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 9145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 916