Preprocessor.h revision 4207edaf03da28fa917a94b31c5c1eef0e6417dc
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" 24d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer#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" 325b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis#include "llvm/ADT/ArrayRef.h" 330ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 342e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor#include <vector> 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 368fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramernamespace llvm { 378fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer template<unsigned InternalLen> class SmallString; 388fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer} 398fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 4388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregorclass ExternalPreprocessorSource; 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 492e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler; 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 53f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregorclass CodeCompletionHandler; 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 5594dc8f640ebea52241412512ed48601626edbc58Douglas Gregorclass PreprocessingRecord; 566aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ModuleLoader; 57ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 58e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 63c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass Preprocessor : public RefCountedBase<Preprocessor> { 64d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticsEngine *Diags; 654e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie LangOptions &LangOpts; 66998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *Target; 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 716aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader; 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 7488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 75a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 76ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 776137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 786137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 796f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHManager> PTH; 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 810ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 820ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 830ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 91c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 921ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma 931ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__ 94148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 95c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne IdentifierInfo *Ident__has_extension; // __has_extension 96148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 97cae5095c116c29a4e52c91fa0ad88df09dd2b45fAnders Carlsson IdentifierInfo *Ident__has_attribute; // __has_attribute 9892bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 9992bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 100d768150ef57f617c8d9fef48f3c92e8f21698024Ted Kremenek IdentifierInfo *Ident__has_warning; // __has_warning 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 103c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 113f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool SuppressIncludeNotFoundError : 1; 114ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1185814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1195814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1205814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1211d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1221d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1231d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 12488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 12588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 126a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 129c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 13268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1339e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 13468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 13668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 137083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 13829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1392e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1401b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1411b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1482e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1492e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 151e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief True if we want to ignore EOF token and continue later on (thus 152e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// avoid tearing the Lexer and etc. down). 153e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrementalProcessing; 154e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 155f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 156f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 157ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1582968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1592968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1602968442603b029949246467253eeac8139a5b6d8Douglas Gregor 1617d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The offset in file for the code-completion point. 1627d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis unsigned CodeCompletionOffset; 1637d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 1647d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The location for the code-completion point. This gets instantiated 1657d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// when the CodeCompletionFile gets #include'ed for preprocessing. 1667d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionLoc; 1677d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 1687d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The start location for the file of the code-completion point. 1697d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// This gets instantiated when the CodeCompletionFile gets #include'ed 1707d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// for preprocessing. 1717d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionFileLoc; 1727d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 173c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// \brief The source location of the 'import' contextual keyword we just 174c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// lexed, if any. 175b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor SourceLocation ModuleImportLoc; 1768dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 177b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief The module import path that we're currently processing. 178b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> 179b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor ModuleImportPath; 180b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 181b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief Whether the module import expectes an identifier next. Otherwise, 182b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// it expects a '.' or ';'. 183b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor bool ModuleImportExpectsIdentifier; 184b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 1858dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The source location of the currently-active 1868dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// #pragma clang arc_cf_code_audited begin. 1878dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation PragmaARCCFCodeAuditedLoc; 188ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1897d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief True if we hit the code-completion point. 1907d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool CodeCompletionReached; 1917d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 192f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 193f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 194f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 195f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 196f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 197ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1999c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 2009c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2016f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Lexer> CurLexer; 2021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2039c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 2049c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 2059c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2066f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHLexer> CurPTHLexer; 2071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2089c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 2099c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 2109c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 21123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 212ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2186cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 2196cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 2206f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<TokenLexer> CurTokenLexer; 2211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 222b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The kind of lexer we're currently working with. 223ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie enum CurLexerKind { 224ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_Lexer, 225ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_PTHLexer, 226ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_TokenLexer, 227b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_CachingLexer, 228b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_LexAfterModuleImport 229b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } CurLexerKind; 230b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 2336cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 235b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind CurLexerKind; 2369c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 2379c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 2389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 2391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 2419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 242ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IncludeStackInfo(enum CurLexerKind K, Lexer *L, PTHLexer* P, 243b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor PreprocessorLexer* PPL, 2449c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 245ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie : CurLexerKind(K), TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), 246b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor TheTokenLexer(TL), TheDirLookup(D) {} 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 2491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 254cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 255cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 256cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 2571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 2670827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 26823f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 26923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 27023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 27123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 272ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 273ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 274ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// push_macro directive, we keep a MacroInfo stack used to restore 275f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 276f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 2815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 2845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 2851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 286aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 287aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 288aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 2891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2906cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 2916cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 2926cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 2936cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 2949e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 2955b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 2965b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 2975b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 2985b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 2995b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 300686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 3015b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 3025b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 3039e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 304ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// occurred during preprocessing. 30594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 30694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 30794dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 308b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 309ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 310e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 311686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 31203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 31303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 31403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 31503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 31603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 31703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 31803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 31903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 32003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 32103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 322a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 323a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 324a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 325a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 326a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 32703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 328af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 329af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 330af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 3319714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 332af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 333af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 334af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 335af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 336af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 337af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 3389714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 3399714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 3409714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 3419714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 342295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor MacroInfo *getInfoForMacro(IdentifierInfo *II) const; 343ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 345d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie Preprocessor(DiagnosticsEngine &diags, LangOptions &opts, 346998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *target, 34772b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 3486aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 3495814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 350998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool OwnsHeaderSearch = false, 351e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool DelayInitialization = false, 352e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrProcessing = false); 35372b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 3555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 356998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \brief Initialize the preprocessor, if the constructor did not already 357998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// perform the initialization. 358998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// 359998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \param Target Information about the target. 360998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor void Initialize(const TargetInfo &Target); 361ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 362d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return *Diags; } 363d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; } 3647c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 3654e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &getLangOpts() const { return LangOpts; } 366998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo &getTargetInfo() const { return *Target; } 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 3705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 37229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 3731b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 37432fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 376337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 3771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 378880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 3792e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 38088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 38188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 38288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 383a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 38488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 38588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 38688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 387a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 3886aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 3896aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 390ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 3915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 3925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 3935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 3945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 3955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 3991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 400f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman void SetSuppressIncludeNotFoundError(bool Suppress) { 401f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman SuppressIncludeNotFoundError = Suppress; 402f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 403f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 404f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool GetSuppressIncludeNotFoundError() { 405f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman return SuppressIncludeNotFoundError; 406f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 407f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 4085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 4107062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 4117062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 414a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 415a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 416a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 417a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 418a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 419321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 420321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 4215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 42268e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 4231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 424a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 425eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 426eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 4275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 428a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 429e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 430e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 4315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 434cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 435cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 436cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 437295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 438295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 439ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 440295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return getInfoForMacro(II); 441cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 443cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 444cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 4455d5051f3e79bf754134ccdf7a1dc7778cd80c73eDouglas Gregor void setMacroInfo(IdentifierInfo *II, MacroInfo *MI, 4465d5051f3e79bf754134ccdf7a1dc7778cd80c73eDouglas Gregor bool LoadedFromAST = false); 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44809b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 44909b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// state of the macro table. This visits every currently-defined macro. 4501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 45109b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 45288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 45388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 454a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 455e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 456aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 457aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 458aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 459aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 4625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 4635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 4645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 4655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 466686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 4673da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 4685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 4715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 4725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 473686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4749b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 475686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 4769b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4784095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 4794095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 4804095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 4814095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 482686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4839b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 484686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 4859b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4864095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 4872e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 4882e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void AddCommentHandler(CommentHandler *Handler); 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4902e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 4912e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 4922e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 4932e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void RemoveCommentHandler(CommentHandler *Handler); 4941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 495f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 496f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 497f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 498f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 499ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 5001fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 5011fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 5021fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 5031fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 504ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 505f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 506f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 507f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 508f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 509ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 51055817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 51155817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 51255817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 513ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 51494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 51594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 516b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 517ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 518ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// \brief Create a new preprocessing record, which will keep track of 51994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 520c6c54521f95760a5eaf29b668d4bf41fe2af49d7Argyrios Kyrtzidis void createPreprocessingRecord(bool RecordConditionalDirectives); 521ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 52253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 5237dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 524e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 5251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 526dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 527dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 528dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 529dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 5305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 531e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 532e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 533e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 534e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 5375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 5385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 539e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 540e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 541e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 542e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 5431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 5456b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 5466b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5476b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 5486b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 5496b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 5506b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5516b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 5526b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 5536b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 5546b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 5556b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5566b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 5576b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 5581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 5605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 5615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 5625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 56303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 56403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 565ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 566ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 567ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 56803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 569a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 570ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 571ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 57203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 573ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 574ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 575ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 57603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 577a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 57803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 579ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 580ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 58103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 58203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 5831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 584a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 58503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 58603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 58703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 588fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 58903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 5905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 5915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 592d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 593b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor switch (CurLexerKind) { 594b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_Lexer: CurLexer->Lex(Result); break; 595b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_PTHLexer: CurPTHLexer->Lex(Result); break; 596b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_TokenLexer: CurTokenLexer->Lex(Result); break; 597b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_CachingLexer: CachingLex(Result); break; 598b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_LexAfterModuleImport: LexAfterModuleImport(Result); break; 599b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } 6005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 602b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor void LexAfterModuleImport(Token &Result); 603ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 607d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 6085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 6095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 6105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 6115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 612d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 6135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 6145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 615d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 6165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 6175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 6185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 6195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 6205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 6235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 6245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 62788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 62888710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 62988710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 63088710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 63188710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 63288710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 63388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 6346b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 6356b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 6366b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 6376b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 6386b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 63903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 64003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 64103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 64203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 64303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 6449e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 6453604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 64608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 64708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 64808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 64908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 65008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 65108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 65208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 65308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 65408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 65508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 65608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 65708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 65808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 65908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 6603604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 6613604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 6623604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 6633604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 6643604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 6653604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 6663604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 6673604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 6683604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 6693604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 6703604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 6713604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 6723604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 6733604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 6743604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 6753604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 6763604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 67747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 67883cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 6793604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 6803604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 68139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 68339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 68439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 68539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 68639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 68739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 68839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 68939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 69039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 69139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 69239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 69339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 69439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 69539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 696d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// \brief Recompute the current lexer kind based on the CurLexer/CurPTHLexer/ 697d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// CurTokenLexer pointers. 698d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor void recomputeCurLexerKind(); 699e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 700e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Returns true if incremental processing is enabled 701e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool isIncrementalProcessingEnabled() const { return IncrementalProcessing; } 702e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 703e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Enables the incremental processing 704e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann void enableIncrementalProcessing(bool value = true) { 705e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann IncrementalProcessing = value; 706e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann } 707d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor 7082968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 7092968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 7102968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 7112968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 7122968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 7132968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 7142968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 7152968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 7162968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 7172968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 7182968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 7192968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 7202968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 7212968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 722a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 7232968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 7242968442603b029949246467253eeac8139a5b6d8Douglas Gregor 7253437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 7263437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 7273437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 7287d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the location of the code-completion point. 7297d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 7307d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 7317d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; } 7327d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7337d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the start location of the file of code-completion point. 7347d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 7357d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 7367d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionFileLoc() const { 7377d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis return CodeCompletionFileLoc; 7387d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 7397d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7407d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns true if code-completion is enabled and we have hit the 7417d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// code-completion point. 7427d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool isCodeCompletionReached() const { return CodeCompletionReached; } 7437d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7447d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Note that we hit the code-completion point. 745d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer void setCodeCompletionReached() { 746d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer assert(isCodeCompletionEnabled() && "Code-completion not enabled!"); 747d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer CodeCompletionReached = true; 748d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer // Silence any diagnostics that occur after we hit the code-completion. 749d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer getDiagnostics().setSuppressAllDiagnostics(true); 750d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 7517d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7528dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The location of the currently-active #pragma clang 7538dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. Returns an invalid location if there 7548dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// is no such pragma active. 7558dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation getPragmaARCCFCodeAuditedLoc() const { 7568dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall return PragmaARCCFCodeAuditedLoc; 7578dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 7588dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 7598dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief Set the location of the currently-active #pragma clang 7608dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. An invalid location ends the pragma. 7618dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc) { 7628dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall PragmaARCCFCodeAuditedLoc = Loc; 7638dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 7648dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 765f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Instruct the preprocessor to skip part of the main 766f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// the main source file. 767f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 768f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Bytes The number of bytes in the preamble to skip. 769f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 770f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief StartOfLine Whether skipping these bytes puts the lexer at the 771f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 772ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 773f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 774f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 775f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 776ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 7775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 778d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 7795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 780d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const { 781d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Loc, DiagID); 782d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 7831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 784d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const { 785d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Tok.getLocation(), DiagID); 786d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 7871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 788834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 789834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 7909e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 79130900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 792834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 793834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 79430900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 795686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 796686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 797834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 7984e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(loc, buffer, SourceMgr, LangOpts, invalid); 799834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 80030900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 8015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 8025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 8035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 8045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 8055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 80650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 80730900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 808b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 8094e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, SourceMgr, LangOpts, Invalid); 810b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 8110ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 8125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 8135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 8145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 8155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 8165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 8175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 8185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 8195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 8205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 8215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 822ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned getSpelling(const Token &Tok, const char *&Buffer, 82348cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 8244e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, Buffer, SourceMgr, LangOpts, Invalid); 82548cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 826b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 827ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 828ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 829ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 830686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 831f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber SmallVectorImpl<char> &Buffer, 832f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber bool *Invalid = 0) const; 833ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 8347216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 8357216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 836ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 83750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 8387216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 8397216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 8407216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 8417216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 8427216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 8437216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 8447216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 84528396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 8467216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 8477216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 848a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 84928396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 8501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 851c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// \brief Retrieve the name of the immediate macro expansion. 852c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// 853c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// This routine starts from a source location, and finds the name of the macro 854c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// responsible for its immediate expansion. It looks through any intervening 855c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// macro argument expansions to compute this. It returns a StringRef which 856c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// refers to the SourceManager-owned buffer of the source where that macro 857c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// name is spelled. Thus, the result shouldn't out-live the SourceManager. 858c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks StringRef getImmediateMacroName(SourceLocation Loc) { 8594e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getImmediateMacroName(Loc, SourceMgr, getLangOpts()); 860c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks } 861c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks 86247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 86347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 8649e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 865a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara void CreateString(const char *Buf, unsigned Len, Token &Tok, 866a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocStart = SourceLocation(), 867a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocEnd = SourceLocation()); 868b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 869b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 870b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 871b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 872b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 873b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 874b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 875b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 876b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 877b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 878b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 87933e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 88033e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 88133e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 88233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 88333e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 8847ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 8854e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, LangOpts); 8867ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 8871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8887a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 8899e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 89069bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 89169bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to 89269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// begin location of the macro. 89369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtStartOfMacroExpansion(SourceLocation loc, 89469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroBegin = 0) const { 8954e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, LangOpts, 89669bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis MacroBegin); 8977a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 8987a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 8997a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 9009e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 90169bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 90269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to 90369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// end location of the macro. 90469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtEndOfMacroExpansion(SourceLocation loc, 90569bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroEnd = 0) const { 9064e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, LangOpts, MacroEnd); 9077a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 9087a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 9095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 9105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 911d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 912c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 9135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 9141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 91597ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 91697ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 917872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 918872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 9194e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, LangOpts); 920872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 921872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 9225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 9235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 9245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 9251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 9265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 9275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 9285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 9295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 9305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 9315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 9321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 9345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 935c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 936c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 9373f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 9383f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 9393f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 9403f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 9411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 9435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 9445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 9455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 946c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 947c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 948c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 949c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 9501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 95228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 95328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 95428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 95528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 95628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 95728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 95828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 95928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 96028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 96128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 96228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 96328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 96428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 96528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 96628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 96728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 96828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 96928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 97028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 97128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 97228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 97328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 97428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 97528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 97628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 977ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except block 978ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_code, 979ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_code, 980ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionCode; 981ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except filter expression 982ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_info, 983ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_info, 984ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionInfo; 985ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __finally 986ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__abnormal_termination, 987ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___abnormal_termination, 988ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_AbnormalTermination; 98928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 99028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 99128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 9925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 9935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 9945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 9955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 996d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 9975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 10005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 10015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 10025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 1003d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 10041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1005fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 1006fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 1007fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 10081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 10101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 10115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 10125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 1013d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 10145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 101584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 101684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 1017ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 1018ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 10191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1020478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 102184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 1022478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 10231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10247c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 10257c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 10267c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 10277c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 10287c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 1029c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 1030c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 10311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103290db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Retrieves the module that we're currently building, if any. 103390db26000aefe9335370013eec64c85232d80227Douglas Gregor Module *getCurrentModule(); 103490db26000aefe9335370013eec64c85232d80227Douglas Gregor 1035f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 1036f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// SourceLocation. 1037f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 1038f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1039f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// CloneMacroInfo - Allocate a new MacroInfo object which is clone of MI. 1040f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 10411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1042a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 1043a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// checked and spelled filename, e.g. as an operand of #include. This returns 1044a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// true if the input filename was in <>'s or false if it were in ""'s. The 1045a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// caller is expected to provide a buffer that is large enough to hold the 1046a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// spelling of the filename, but is also expected to handle the case when 1047a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// this method decides to use a different buffer. 1048686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 1049a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1050a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 1051a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// return null on failure. isAngled indicates whether the file reference is 1052a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// for system #include's or not (i.e. using <> instead of ""). 1053686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 1054f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 1055b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 1056686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 1057fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor SmallVectorImpl<char> *RelativePath, 10581a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor Module **SuggestedModule, 10591c2e9332fa69727425a3a2b912e36e2ab62083f8Douglas Gregor bool SkipCache = false); 1060a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1061a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 1062a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1063a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// implement #include_next and find directory-specific properties. 1064a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 1065a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1066a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// isInPrimaryFile - Return true if we're in the top-level file, not in a 1067a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include. 1068a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 1069a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1070a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// ConcatenateIncludeName - Handle cases where the #include name is expanded 1071a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 1072a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 1073a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #define FOO <a/b.h> 1074a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include FOO 1075a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 1076a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 1077321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 1078321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 107984021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 1080f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith bool ConcatenateIncludeName(SmallString<128> &FilenameBuffer, 1081ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 1082a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 10839d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 108484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 10859d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 10869d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 10875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 10881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1089d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 1090b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeMacroStack.push_back(IncludeStackInfo(CurLexerKind, 1091b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexer.take(), 10929c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 10939c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 10949c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 10959c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 1096f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 1097d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 10981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1099d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 1100caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 11019c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 11029c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 1103caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 11049c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 1105b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexerKind = IncludeMacroStack.back().CurLexerKind; 1106d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 1107d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 11081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1109f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object. 1110f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 1111f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 11120ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 11130ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 11140301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 11151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 111784021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// #define or #undef. This emits a diagnostic, sets the token kind to eod, 11185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 1119d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 11201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 11225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 11235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 11245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 11255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 11261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 11285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 11295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 11305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 11315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 11325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 11335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 11345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 11355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 11366b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis bool FoundNonSkipPortion, bool FoundElse, 11376b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis SourceLocation ElseLoc = SourceLocation()); 11381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1139268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 1140268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 1141268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 11421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 11445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 11455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 11465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 11471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 11495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 11505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 11511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 11535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 11545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 11551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 11575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 11585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1159d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 11601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11615b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 11625b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 11635b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 11645b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 11655b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 11665b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 11672d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 11685b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 11695b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 11705b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 11715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 11725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 11735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 11745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 11751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 11775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 11785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1179e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 11809e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 11815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 11835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1184d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 11851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 11875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 11885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1189d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 11901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11911ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 11921ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 11931ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 11941ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 11955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 11965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 11975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 11986137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 11996137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 12006137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 12016137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 12021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120334eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 120434eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 120534eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 120634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 120741938c8493b4380df738263166b746eacb33c309Ted Kremenek } 120841938c8493b4380df738263166b746eacb33c309Ted Kremenek 120981d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 121081d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 121141938c8493b4380df738263166b746eacb33c309Ted Kremenek } 121241938c8493b4380df738263166b746eacb33c309Ted Kremenek 121381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 121481d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 121541938c8493b4380df738263166b746eacb33c309Ted Kremenek } 12161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 121803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 121903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 122003569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 122103569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 122203569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 1223ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 122456eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 122503569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 122603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 122703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 122803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 122903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 123003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 123103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 12323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 123303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 123403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 12355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 12365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 12375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1238359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1239478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1240d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1241d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 124294ad28b31433058445a27db722f60402ee820beaDouglas Gregor void HandleMacroPublicDirective(Token &Tok); 1243aa93a875605536d72a10359a0098396192b7d4ecDouglas Gregor void HandleMacroPrivateDirective(Token &Tok); 1244ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 12455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1246ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1247ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 12485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 12495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1250ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1251ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1252ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 12534207edaf03da28fa917a94b31c5c1eef0e6417dcAaron Ballman void HandleMicrosoftImportDirective(Token &Tok); 12541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 125642e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1257d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 12581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1260d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 12615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1262d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1263d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1264d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1265d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 12661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 126880c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 12695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1270d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 12712243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1272d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1273d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1274d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1275636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1276abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1277f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1278f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 12794c55c54db8e676aa3e042188773d9d82d59fff91Aaron Ballman void HandlePragmaIncludeAlias(Token &Tok); 1280f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1281f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1282046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1283046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1284046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 12850827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 12860827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 12870827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 12880827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 12895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 12922e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 12932e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 12942e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 12952e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 12961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1297046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1298046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1299046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 13002e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 13011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 13035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1305