Preprocessor.h revision dca8ee8b7bc86076916a3a80f553f7a4e98c14af
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 17af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek#include "clang/Lex/MacroInfo.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/Lexer.h" 199c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek#include "clang/Lex/PTHLexer.h" 20eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner#include "clang/Lex/PPCallbacks.h" 215d75de0f821023f4ed4815825bf3aea8a0b5e40dChris Lattner#include "clang/Lex/TokenLexer.h" 226137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek#include "clang/Lex/PTHManager.h" 231b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner#include "clang/Basic/Builtins.h" 24adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner#include "clang/Basic/Diagnostic.h" 25c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 27cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 284f32786ac45210143654390177105eb749b614e9Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 290827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/SmallPtrSet.h" 30caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 31f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer#include "llvm/ADT/SmallVector.h" 320ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 332e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor#include <vector> 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 3888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregorclass ExternalPreprocessorSource; 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 442e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler; 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 48f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregorclass CodeCompletionHandler; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 5094dc8f640ebea52241412512ed48601626edbc58Douglas Gregorclass PreprocessingRecord; 5194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 52e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 574f32786ac45210143654390177105eb749b614e9Ted Kremenekclass Preprocessor : public llvm::RefCountedBase<Preprocessor> { 58836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic *Diags; 59ba1e898c64048e25cb65afec3807ad463e41914bArgyrios Kyrtzidis LangOptions Features; 60444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &Target; 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 6788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 68a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 696137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 706137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 716137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek llvm::OwningPtr<PTHManager> PTH; 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 730ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 740ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 750ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 83c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 841ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma 851ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__ 86148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 87148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 88cae5095c116c29a4e52c91fa0ad88df09dd2b45fAnders Carlsson IdentifierInfo *Ident__has_attribute; // __has_attribute 8992bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 9092bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 93c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 1031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1075814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1085814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1095814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1101d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1111d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1121d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 11388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 11488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 115a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 118c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12068d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 12168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// It is declared/instantiated here because it's role/lifetime is 12368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 12568d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 126083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 12729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1282e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1291b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1301b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1372e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1382e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 140f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 141f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 142f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 1432968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1442968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1452968442603b029949246467253eeac8139a5b6d8Douglas Gregor 146f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 147f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 148f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 149f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 150f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 151f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1539c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 1549c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 155caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 1561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1579c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 1589c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1599c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1609c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1629c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1639c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1649c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 16523f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 1661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1726cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 1736cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 174caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1786cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1809c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 1819c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 1829c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1859c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1869c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 1879c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 1889c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 1899c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TheDirLookup(D) {} 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 1955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 1961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 197cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 198cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 199cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 2001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2010827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 2020827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 2030827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 2040827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 2050827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 2060827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 2070827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 2080827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 2090827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 2100827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 21123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 21223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 21323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 21423f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 215f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 216f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 217f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// push_macro directive, we keep a MacroInfo stack used to restore 218f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 219f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 2201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 221b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// \brief Instantiation source location for the last macro that expanded 222b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// to no tokens. 223b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis SourceLocation LastEmptyMacroInstantiationLoc; 224b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 2321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 233aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 234aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 235aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 2361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2376cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 2386cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 2396cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 2406cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 2419e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 24294dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief A record of the macro definitions and instantiations that 24394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// occurred during preprocessing. 24494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 24594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 24694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 247b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 24894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 249e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 250f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer typedef llvm::SmallVector<Token, 1> CachedTokensTy; 25103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 25203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 25303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 25403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 25503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 25603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 25703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 25803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 25903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 26003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 261a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 262a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 263a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 264a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 265a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 26603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 267af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 268af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 269af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 2709714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 271af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 272af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 273af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 274af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 275af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 276af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 2779714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 2789714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 2799714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 2809714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 281295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor MacroInfo *getInfoForMacro(IdentifierInfo *II) const; 282295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 284444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar Preprocessor(Diagnostic &diags, const LangOptions &opts, 285444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &target, 28672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 2875814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 2885814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch = false); 28972b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 2915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 292836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic &getDiagnostics() const { return *Diags; } 2937c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner void setDiagnostics(Diagnostic &D) { Diags = &D; } 2947c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 296444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &getTargetInfo() const { return Target; } 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 2995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 3005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 30229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 3031b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 30432fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 306337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 3071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 308880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 3092e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 31088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 31188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 31288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 313a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 31488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 31588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 31688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 317a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 3185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 3195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 3215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 3225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 3261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 3285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 3297062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 3307062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 3315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 333a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 334a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 335a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 336a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 337a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 338321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 339321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 34168e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 3421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 343a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 344eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 345eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 3465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 347a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 348e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 349e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 353cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 354cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 355cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 356295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 357295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 358295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 359295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return getInfoForMacro(II); 360cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 3611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 362cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 363cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 364cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36609b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 36709b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// state of the macro table. This visits every currently-defined macro. 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 36909b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 37088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 37188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 372a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 373b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// \brief Instantiation source location for the last macro that expanded 374b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// to no tokens. 375b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis SourceLocation getLastEmptyMacroInstantiationLoc() const { 376b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis return LastEmptyMacroInstantiationLoc; 377b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis } 378b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis 379e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 380aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 381aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 382aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 383aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 3865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 3885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 3895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 390c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar IdentifierInfo *getIdentifierInfo(llvm::StringRef Name) const { 3913da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 3925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 3955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 3979b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(llvm::StringRef Namespace, PragmaHandler *Handler); 3989b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 3999b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis AddPragmaHandler(llvm::StringRef(), Handler); 4009b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4024095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 4034095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 4044095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 4054095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 4069b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(llvm::StringRef Namespace, PragmaHandler *Handler); 4079b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 4089b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis RemovePragmaHandler(llvm::StringRef(), Handler); 4099b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4104095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 4112e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 4122e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void AddCommentHandler(CommentHandler *Handler); 4131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4142e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 4152e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 4162e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 4172e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void RemoveCommentHandler(CommentHandler *Handler); 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 419f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 420f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 421f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 422f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 423f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 4241fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 4251fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 4261fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 4271fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 4281fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor 429f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 430f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 431f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 432f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 433f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 43455817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 43555817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 43655817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 43755817afdf9d453a443262a733f6caf6692dca118Douglas Gregor 43894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 43994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 440b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 44194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 44294dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Create a new preprocessing record, which will keep track of 44394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 444dca8ee8b7bc86076916a3a80f553f7a4e98c14afDouglas Gregor void createPreprocessingRecord(bool IncludeNestedMacroInstantiations); 44594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 44653b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 4477dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 448e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 450dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 451dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 452dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 453dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 455e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 456e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 457e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 458e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 4615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 4625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 463e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 464e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 465e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 466e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 4671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 4696b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 4706b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4716b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 4726b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 4736b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 4746b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4756b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 4766b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 4776b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 4786b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 4796b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4806b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 4816b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 4845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 48703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 48803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 489ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 490ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 491ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 49203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 493a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 494ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 495ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 49603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 497ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 498ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 499ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 50003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 501a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 50203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 503ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 504ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 50503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 50603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 508a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 50903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 51003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 51103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 512fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 51303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 5145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 5155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 516d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 5175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 5185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 519f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek else if (CurPTHLexer) 520f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek CurPTHLexer->Lex(Result); 5219e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis else if (CurTokenLexer) 5226cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner CurTokenLexer->Lex(Result); 52303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 52403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachingLex(Result); 5255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 5285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 5295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 530d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 5335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 5345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 535d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 5365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 5375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 538d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 5395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 5405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 5415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 5425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 5435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 5475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5496b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 5506b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 5516b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 5526b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 5536b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 55403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 55503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 55603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 55703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 55803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 5599e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 5603604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 56108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 56208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 56308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 56408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 56508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 56608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 56708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 56808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 56908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 57008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 57108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 57208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 57308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 57408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 5753604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 5763604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 5773604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 5783604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 5793604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 5803604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 5813604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 5823604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 5833604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 5843604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 5853604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 5863604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 5873604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 5883604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 5893604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 5903604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 5913604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 59247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 59383cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 5943604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 5953604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 59639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 5971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 59839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 59939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 60039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 60139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 60239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 60339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 60439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 60539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 60639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 60739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 60839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 60939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 61039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6112968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 6122968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6132968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 6142968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 6152968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 6162968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 6172968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6182968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 6192968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6202968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6212968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 6222968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6232968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6242968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 625a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 6262968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 6272968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6282968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Determine if this source location refers into the file 6292968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// for which we are performing code completion. 630109ae73ec71a1d27358510ce049b59637b4a6b40Douglas Gregor bool isCodeCompletionFile(SourceLocation FileLoc) const; 6312968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6323437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 6333437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 6343437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 635f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Instruct the preprocessor to skip part of the main 636f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// the main source file. 637f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 638f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Bytes The number of bytes in the preamble to skip. 639f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 640f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief StartOfLine Whether skipping these bytes puts the lexer at the 641f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 642f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 643f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 644f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 645f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 646f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 648d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 650adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 65133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Loc, DiagID); 652adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 6531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 654adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 65533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Tok.getLocation(), DiagID); 656adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 6571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 658834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 659834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 660834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// instantiation location. 66130900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 662834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 663834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 66430900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 665834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall llvm::StringRef getSpelling(SourceLocation loc, 666834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall llvm::SmallVectorImpl<char> &buffer, 667834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 668834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall return Lexer::getSpelling(loc, buffer, SourceMgr, Features, invalid); 669834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 67030900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 6715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 6735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 6745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 6755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 67650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 67730900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 678b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 679b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, SourceMgr, Features, Invalid); 680b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 6810ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 6825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 6835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 6845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 6855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 6865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 6875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 6885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 6895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 6905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 6915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 69250f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getSpelling(const Token &Tok, const char *&Buffer, 69348cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 694b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, Buffer, SourceMgr, Features, Invalid); 69548cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 696b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 697ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 698ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 699ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 700ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer llvm::StringRef getSpelling(const Token &Tok, 70150f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor llvm::SmallVectorImpl<char> &Buffer, 70250f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const; 703ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 7047216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 7057216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 70650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 70750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 7087216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 7097216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 7107216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 7117216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 7127216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 7137216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 7147216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 71528396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 7167216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 7177216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 718a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 71928396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 7201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 72247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 72347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// location provides a location of the instantiation point of the token. 72447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void CreateString(const char *Buf, unsigned Len, 72547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner Token &Tok, SourceLocation SourceLoc = SourceLocation()); 726b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 727b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 728b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 729b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 730b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 731b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 732b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 733b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 734b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 735b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 736b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 73733e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 73833e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 73933e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 74033e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 74133e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 7427ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 7437ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, Features); 7447ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 7475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 748d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 749c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 7505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 7511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75297ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 75397ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 754872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 755872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 7567ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, Features); 757872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 758872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 7595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 7605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 7615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 7621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 7635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 7645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 7655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 7665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 7675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 7685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 7715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7723f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 7733f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 7743f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 7753f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 7761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 7785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 7795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 7805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 781c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 782c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 783c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 784c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 78728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 78828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 78928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 79028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 79128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 79228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 79328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 79428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 79528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 79628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 79728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 79828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 79928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 80028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 80128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 80228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 80328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 80428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 80528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 80628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 80728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 80828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 80928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 81028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 81128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 81228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_code, *Ident___exception_code, *Ident_GetExceptionCode; // __except block 81328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_info, *Ident___exception_info, *Ident_GetExceptionInfo; // __except filter expression 81428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__abnormal_termination, *Ident___abnormal_termination, *Ident_AbnormalTermination; // __finally 81528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 81628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 81728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 8185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 8195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 8205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 8215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 822d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 8235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 8265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 8275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 8285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 829d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 8301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 831fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 832fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 833fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 8341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 8361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 8375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 8385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 839d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 8405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 84184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 84284021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 843ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 844ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 8451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 846478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 84784021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 848478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 8491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8507c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 8517c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 8527c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 8537c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 8547c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 855c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 856c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 8571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 858f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 859f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// SourceLocation. 860f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 861f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 862f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// CloneMacroInfo - Allocate a new MacroInfo object which is clone of MI. 863f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 8641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 865a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 866a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// checked and spelled filename, e.g. as an operand of #include. This returns 867a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// true if the input filename was in <>'s or false if it were in ""'s. The 868a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// caller is expected to provide a buffer that is large enough to hold the 869a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// spelling of the filename, but is also expected to handle the case when 870a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// this method decides to use a different buffer. 871a139481e62fdb209d9d87a54a5733f989d2e8d51Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,llvm::StringRef &Filename); 872a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 873a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 874a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// return null on failure. isAngled indicates whether the file reference is 875a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// for system #include's or not (i.e. using <> instead of ""). 876a139481e62fdb209d9d87a54a5733f989d2e8d51Chris Lattner const FileEntry *LookupFile(llvm::StringRef Filename, 877f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 878b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 8797412494982c8b50c90961302c3a718633b2c3ab7Manuel Klimek llvm::SmallVectorImpl<char> *SearchPath, 8807412494982c8b50c90961302c3a718633b2c3ab7Manuel Klimek llvm::SmallVectorImpl<char> *RelativePath); 881a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 882a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 883a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 884a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// implement #include_next and find directory-specific properties. 885a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 886a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 887a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// isInPrimaryFile - Return true if we're in the top-level file, not in a 888a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include. 889a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 890a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 891a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// ConcatenateIncludeName - Handle cases where the #include name is expanded 892a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 893a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 894a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #define FOO <a/b.h> 895a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include FOO 896a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 897a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 898321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 899321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 90084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 901ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor bool ConcatenateIncludeName(llvm::SmallString<128> &FilenameBuffer, 902ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 903a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 9049d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 90584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 9069d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 9079d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 9085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 9091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 910d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 9119c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 9129c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 9139c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 9149c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 9159c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 916f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 917d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 919d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 920caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 9219c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 9229c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 923caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 9249c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 925d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 926d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 9271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 928f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object. 929f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 930f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 9310ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 9320ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 9330301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 9341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 93684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// #define or #undef. This emits a diagnostic, sets the token kind to eod, 9375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 938d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 9391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 9415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 9425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 9435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 9445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 9475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 9485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 9495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 9505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 9515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 9525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 9535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 9545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 9555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 9561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 957268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 958268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 959268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 9601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 9625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 9635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 9645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 9651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 9675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 9685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 9691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 9715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 9725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 9731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 9755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 9765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 977d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 9781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 9805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 9815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 9825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 9831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 9855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 9865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 987e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 988e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner SourceLocation &InstantiationEnd); 9895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 9915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 992d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 9931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 9955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 9965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 997d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9991ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 10001ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 10011ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 10021ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 10035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 10045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 10055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 10066137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 10076137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 10086137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 10096137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 10101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101134eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 101234eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 101334eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 101434eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 101541938c8493b4380df738263166b746eacb33c309Ted Kremenek } 101641938c8493b4380df738263166b746eacb33c309Ted Kremenek 101781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 101881d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 101941938c8493b4380df738263166b746eacb33c309Ted Kremenek } 102041938c8493b4380df738263166b746eacb33c309Ted Kremenek 102181d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 102281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 102341938c8493b4380df738263166b746eacb33c309Ted Kremenek } 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 102603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 102703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 102803569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 102903569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 103003569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 103156eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 103256eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 103303569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 103403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 103503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 103603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 103703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 103803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 103903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 10403604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 104103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 104203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 10435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 10445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 10455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1046359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1047478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1048d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1049d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1052ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1053ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 10545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 10555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1056ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1057ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1058ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 10591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 106142e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1062d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 10631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1065d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 10665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1067d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1068d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1069d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1070d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 10711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 107380c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 10745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1075d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 10762243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1077d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1078d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1079d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1080636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1081abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1082f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1083f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 1084f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1085f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1086046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1087046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1088046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 10890827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 10900827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 10910827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 10920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 10935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 10945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 10951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 10962e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 10972e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 10982e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 10992e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 11001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1101046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1102046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1103046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 11042e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 11051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 11075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1109