Preprocessor.h revision a8235d6c4093cd38dcf742909651f867de62e55b
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" 21a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor#include "clang/Lex/PPMutationListener.h" 225d75de0f821023f4ed4815825bf3aea8a0b5e40dChris Lattner#include "clang/Lex/TokenLexer.h" 236137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek#include "clang/Lex/PTHManager.h" 241b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner#include "clang/Basic/Builtins.h" 25d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer#include "clang/Basic/Diagnostic.h" 26c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 28cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 294f32786ac45210143654390177105eb749b614e9Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/SmallPtrSet.h" 31caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 32f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer#include "llvm/ADT/SmallVector.h" 335b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis#include "llvm/ADT/ArrayRef.h" 340ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 352e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor#include <vector> 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 378fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramernamespace llvm { 388fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer template<unsigned InternalLen> class SmallString; 398fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer} 408fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 4488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregorclass ExternalPreprocessorSource; 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 502e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 54f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregorclass CodeCompletionHandler; 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 5694dc8f640ebea52241412512ed48601626edbc58Douglas Gregorclass PreprocessingRecord; 576aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ModuleLoader; 58ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 591952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko/// \brief Stores token information for comparing actual tokens with 601952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko/// predefined values. Only handles simple tokens and identifiers. 611952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenkoclass TokenValue { 621952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko tok::TokenKind Kind; 631952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko IdentifierInfo *II; 641952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 651952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenkopublic: 661952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko TokenValue(tok::TokenKind Kind) : Kind(Kind), II(0) { 671952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(Kind != tok::raw_identifier && "Raw identifiers are not supported."); 681952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(Kind != tok::identifier && 691952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko "Identifiers should be created by TokenValue(IdentifierInfo *)"); 701952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(!tok::isLiteral(Kind) && "Literals are not supported."); 711952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(!tok::isAnnotation(Kind) && "Annotations are not supported."); 721952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko } 731952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko TokenValue(IdentifierInfo *II) : Kind(tok::identifier), II(II) {} 741952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko bool operator==(const Token &Tok) const { 751952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko return Tok.getKind() == Kind && 761952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko (!II || II == Tok.getIdentifierInfo()); 771952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko } 781952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko}; 791952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 80e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 8358bf98725b6d4588338e191d2ab981b104471dabJames Dennett/// like the \#include stack, token expansion, etc. 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 85c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass Preprocessor : public RefCountedBase<Preprocessor> { 86d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticsEngine *Diags; 874e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie LangOptions &LangOpts; 88998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *Target; 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 936aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader; 941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 9688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 97a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 98ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 996137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 1006137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 1016f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHManager> PTH; 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1030ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 1040ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 1050ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 1061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 113c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 1141ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma 1151ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__ 116148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 117c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne IdentifierInfo *Ident__has_extension; // __has_extension 118148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 119cae5095c116c29a4e52c91fa0ad88df09dd2b45fAnders Carlsson IdentifierInfo *Ident__has_attribute; // __has_attribute 12092bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 12192bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 122d768150ef57f617c8d9fef48f3c92e8f21698024Ted Kremenek IdentifierInfo *Ident__has_warning; // __has_warning 123b09de5177ee8101818a59dcd0038c75b190a2509Douglas Gregor IdentifierInfo *Ident__building_module; // __building_module 124b09de5177ee8101818a59dcd0038c75b190a2509Douglas Gregor IdentifierInfo *Ident__MODULE__; // __MODULE__ 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 127c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 13058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// MaxIncludeStackDepth - Maximum depth of \#includes. 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 137f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool SuppressIncludeNotFoundError : 1; 138ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1425814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1435814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1445814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1451d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1461d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1471d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 1488c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// MacroExpansionInDirectivesOverride - Temporarily disables 1498c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// DisableMacroExpansion (i.e. enables expansion) when parsing preprocessor 1508c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// directives. 1518c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie bool MacroExpansionInDirectivesOverride : 1; 1528c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 1538c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie class ResetMacroExpansionHelper; 1548c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 15588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 15688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 157a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1586fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose /// \brief True if pragmas are enabled. 1596fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool PragmasEnabled : 1; 1606fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 16114e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis /// \brief True if we are pre-expanding macro arguments. 16214e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis bool InMacroArgPreExpansion; 16314e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 166c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 16868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 16968d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1709e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 17168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 17368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 174083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 17529238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1762e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1771b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1781b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1852e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1862e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 188e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief True if we want to ignore EOF token and continue later on (thus 189e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// avoid tearing the Lexer and etc. down). 190e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrementalProcessing; 191e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 192f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 193f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 194ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1952968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1962968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1972968442603b029949246467253eeac8139a5b6d8Douglas Gregor 1987d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The offset in file for the code-completion point. 1997d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis unsigned CodeCompletionOffset; 2007d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2017d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The location for the code-completion point. This gets instantiated 20258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when the CodeCompletionFile gets \#include'ed for preprocessing. 2037d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionLoc; 2047d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2057d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The start location for the file of the code-completion point. 20658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 20758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This gets instantiated when the CodeCompletionFile gets \#include'ed 2087d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// for preprocessing. 2097d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionFileLoc; 2107d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 211c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// \brief The source location of the 'import' contextual keyword we just 212c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// lexed, if any. 213b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor SourceLocation ModuleImportLoc; 2148dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 215b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief The module import path that we're currently processing. 216b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> 217b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor ModuleImportPath; 218b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 219b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief Whether the module import expectes an identifier next. Otherwise, 220b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// it expects a '.' or ';'. 221b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor bool ModuleImportExpectsIdentifier; 222b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 2238dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The source location of the currently-active 2248dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// #pragma clang arc_cf_code_audited begin. 2258dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation PragmaARCCFCodeAuditedLoc; 226ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2277d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief True if we hit the code-completion point. 2287d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool CodeCompletionReached; 2297d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 230f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 231f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 232f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 233f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 234f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 235ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 2379c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 2389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2396f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Lexer> CurLexer; 2401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 2429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 2439c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2446f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHLexer> CurPTHLexer; 2451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2469c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 2479c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 2489c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 24923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 250ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 25358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2566cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 2576cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 2586f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<TokenLexer> CurTokenLexer; 2591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 260b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The kind of lexer we're currently working with. 261ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie enum CurLexerKind { 262ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_Lexer, 263ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_PTHLexer, 264ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_TokenLexer, 265b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_CachingLexer, 266b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_LexAfterModuleImport 267b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } CurLexerKind; 268b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 27058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#included, and macros currently being expanded from, not counting 2716cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 273b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind CurLexerKind; 2749c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 2759c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 2769c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 2799c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 280ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IncludeStackInfo(enum CurLexerKind K, Lexer *L, PTHLexer* P, 281b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor PreprocessorLexer* PPL, 2829c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 283ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie : CurLexerKind(K), TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), 284b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor TheTokenLexer(TL), TheDirLookup(D) {} 2855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 2871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 28958bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// encountered (e.g. a file is \#included, etc). 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 292a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Listener whose actions are invoked when an entity in the 293a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// preprocessor (e.g., a macro) that was loaded from an AST file is 294a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// later mutated. 295a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *Listener; 296a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 29766c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis struct MacroExpandsInfo { 29866c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis Token Tok; 29966c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroInfo *MI; 30066c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SourceRange Range; 30166c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroExpandsInfo(Token Tok, MacroInfo *MI, SourceRange Range) 30266c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis : Tok(Tok), MI(MI), Range(Range) { } 30366c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis }; 30466c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SmallVector<MacroExpandsInfo, 2> DelayedMacroExpandsCallbacks; 30566c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis 3068a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// Macros - For each IdentifierInfo that was associated with a macro, we 3078a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// keep a mapping to the history of all macro definitions and #undefs in 3088a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// the reverse order (the latest one is in the head of the list). 309cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 310c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor friend class ASTReader; 311c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor 3120827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 3130827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 3140827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 3150827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 3160827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 3170827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 3180827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 3190827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 3200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 3210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 32223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 32323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 32423f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 32523f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 326ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 327ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 328ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// push_macro directive, we keep a MacroInfo stack used to restore 329f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 330f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 3335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 3345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 3391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 340aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 341aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 342aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3446cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 3456cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 3466cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 3476cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 3489e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 3495b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 3505b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 3515b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 3525b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 3535b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 354686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 3555b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 3565b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 3579e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 358ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// occurred during preprocessing. 35994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 36094dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 36194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 362b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 363ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 364e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 365686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 36603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 36703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 36803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 36903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 37003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 37103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 37203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 37303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 37403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 37503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 376a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 377a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 378a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 379a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 380a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 38103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 382af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 383af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 384af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 3859714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 386af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 387af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 388af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 389af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 390af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 391af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 3929714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 3939714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 3949714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 3959714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 397d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie Preprocessor(DiagnosticsEngine &diags, LangOptions &opts, 398998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *target, 39972b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 4006aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 4015814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 402998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool OwnsHeaderSearch = false, 403e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool DelayInitialization = false, 404e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrProcessing = false); 40572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 4065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 408998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \brief Initialize the preprocessor, if the constructor did not already 409998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// perform the initialization. 410998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// 411998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \param Target Information about the target. 412998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor void Initialize(const TargetInfo &Target); 413ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 414d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return *Diags; } 415d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; } 4167c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 4174e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &getLangOpts() const { return LangOpts; } 418998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo &getTargetInfo() const { return *Target; } 4195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 4215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 4225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 42429238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 4251b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 42632fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 428337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 4291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 430880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 4312e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 43288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 43388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 43488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 435a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 43688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 43788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 43888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 439a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 4406aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 4416aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 442ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 4475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 4511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4526fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose void setPragmasEnabled(bool Enabled) { PragmasEnabled = Enabled; } 4536fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool getPragmasEnabled() const { return PragmasEnabled; } 4546fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 455f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman void SetSuppressIncludeNotFoundError(bool Suppress) { 456f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman SuppressIncludeNotFoundError = Suppress; 457f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 458f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 459f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool GetSuppressIncludeNotFoundError() { 460f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman return SuppressIncludeNotFoundError; 461f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 462f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 4635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 4645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 4657062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 4667062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 4675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 469a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 470a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 471a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 472a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 473a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 474321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 475321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 4765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 47768e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 479a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 480eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 481eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 4825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 483a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 484e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 485e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 4875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 489a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Attach an preprocessor mutation listener to the preprocessor. 490a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// 491a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// The preprocessor mutation listener provides the ability to track 492a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// modifications to the preprocessor entities committed after they were 493a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// initially created. 494a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor void setPPMutationListener(PPMutationListener *Listener) { 495a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor this->Listener = Listener; 496a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor } 497a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 498a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Retrieve a pointer to the preprocessor mutation listener 499a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// associated with this preprocessor, if any. 500a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *getPPMutationListener() const { return Listener; } 501a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 50258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given an identifier, return the MacroInfo it is \#defined to 50358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// or null if it isn't \#define'd. 504cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 505295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 506295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 507ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 5084d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko MacroInfo *MI = getMacroInfoHistory(II); 5094d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko assert(MI->getUndefLoc().isInvalid() && "Macro is undefined!"); 5104d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko return MI; 511cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 5121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5134d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// \brief Given an identifier, return the (probably #undef'd) MacroInfo 5144d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// representing the most recent macro definition. One can iterate over all 5154d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// previous macro definitions from it. This method should only be called for 5164d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// identifiers that hadMacroDefinition(). 5174d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko MacroInfo *getMacroInfoHistory(IdentifierInfo *II) const; 5184d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko 51958bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Specify a macro for this identifier. 5205d5051f3e79bf754134ccdf7a1dc7778cd80c73eDouglas Gregor void setMacroInfo(IdentifierInfo *II, MacroInfo *MI, 5215d5051f3e79bf754134ccdf7a1dc7778cd80c73eDouglas Gregor bool LoadedFromAST = false); 522e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko /// \brief Undefine a macro for this identifier. 523e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko void clearMacroInfo(IdentifierInfo *II); 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5258a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// macro_iterator/macro_begin/macro_end - This allows you to walk the macro 5268a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// history table. Currently defined macros have 5278a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// IdentifierInfo::hasMacroDefinition() set and an empty 5288a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// MacroInfo::getUndefLoc() at the head of the list. 5291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 53009b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 53188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 53288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 533a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 5341952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// \brief Return the name of the macro defined before \p Loc that has 5351952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// spelling \p Tokens. If there are multiple macros with same spelling, 5361952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// return the last one defined. 5371952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko StringRef getLastMacroWithSpelling(SourceLocation Loc, 5381952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko ArrayRef<TokenValue> Tokens) const; 5391952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 540e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 541aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 542aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 543aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 544aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 5475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 5485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 5505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 551686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 5523da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 5535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 5565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 5575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 558686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 5599b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 560686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 5619b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 5625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5634095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 5641824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// the preprocessor. If \p Namespace is non-null, then it should 5651824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// be the namespace that \p Handler was added to. It is an error 5664095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 567686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 5689b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 569686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 5709b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 5714095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 5722e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 573aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void addCommentHandler(CommentHandler *Handler); 5741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5752e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 5762e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 5772e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 578aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void removeCommentHandler(CommentHandler *Handler); 5791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 580f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 581f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 582f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 583f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 584ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 5851fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 5861fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 5871fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 5881fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 589ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 590f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 591f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 592f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 593f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 594ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 59555817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 59655817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 59755817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 598ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 59994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 60094dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 601b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 602ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 603ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// \brief Create a new preprocessing record, which will keep track of 60494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 605c6c54521f95760a5eaf29b668d4bf41fe2af49d7Argyrios Kyrtzidis void createPreprocessingRecord(bool RecordConditionalDirectives); 606ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 60753b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 6087dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 609e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 6101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 611dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 612dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 613dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 614dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 6155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 616e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 617e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 618e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 619e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 6205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 6225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 6235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 624e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 625e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 626e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 627c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroInfo *Macro, 628c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith MacroArgs *Args); 6291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 6316b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 6326b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6336b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 6346b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 6356b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 6366b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6376b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 6386b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 6396b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 6406b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 6416b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6426b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 6436b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 6441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 6465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 6485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 64903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 65003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 651ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 652ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 653ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 65403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 655a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 656ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 657ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 65803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 659ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 660ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 661ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 66203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 663a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 66403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 665ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 666ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 66703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 66803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 6691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 670a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 67103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 67203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 67303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 674fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 67503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 6765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 6775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 678d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 679b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor switch (CurLexerKind) { 680b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_Lexer: CurLexer->Lex(Result); break; 681b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_PTHLexer: CurPTHLexer->Lex(Result); break; 682b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_TokenLexer: CurTokenLexer->Lex(Result); break; 683b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_CachingLexer: CachingLex(Result); break; 684b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_LexAfterModuleImport: LexAfterModuleImport(Result); break; 685b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } 6865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 688b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor void LexAfterModuleImport(Token &Result); 689ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 6905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 6915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 6925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 693d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 6945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 6955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 6965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 6975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 698d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 6995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 7005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 701d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 7025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 7035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 7045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 7055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 7065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 7071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 7095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 7105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71288710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 71388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 71488710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 71588710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 71688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 71788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 71888710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 71988710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 7208c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// Disables macro expansion everywhere except for preprocessor directives. 7218c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie void SetMacroExpansionOnlyInDirectives() { 7228c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie DisableMacroExpansion = true; 7238c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie MacroExpansionInDirectivesOverride = true; 7248c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie } 7258c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 7266b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 7276b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 7286b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 7296b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 7306b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 73103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 73203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 73303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 73403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 73503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 7369e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 7373604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 73808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 73908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 74008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 74108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 74208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 74308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 74408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 74508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 74608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 74708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 74808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 74908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 75008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 75108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 7523604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 7533604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 7543604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 7553604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 7563604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 7573604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 7583604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 7593604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 7603604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 7613604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 7623604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 7633604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 7643604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 7653604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 7663604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 7673604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 7683604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 76947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 77083cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 7713604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 7723604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 77339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 7741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 77539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 77639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 77739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 77839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 77939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 78039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 78139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 78239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 78339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 78439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 78539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 78639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 78739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 7880576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// TypoCorrectToken - Update the current token to represent the provided 7890576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// identifier, in order to cache an action performed by typo correction. 7900576681bac125be07f77f66b02a3dba2c3a24557Richard Smith void TypoCorrectToken(const Token &Tok) { 7910576681bac125be07f77f66b02a3dba2c3a24557Richard Smith assert(Tok.getIdentifierInfo() && "Expected identifier token"); 7920576681bac125be07f77f66b02a3dba2c3a24557Richard Smith if (CachedLexPos != 0 && isBacktrackEnabled()) 7930576681bac125be07f77f66b02a3dba2c3a24557Richard Smith CachedTokens[CachedLexPos-1] = Tok; 7940576681bac125be07f77f66b02a3dba2c3a24557Richard Smith } 7950576681bac125be07f77f66b02a3dba2c3a24557Richard Smith 796d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// \brief Recompute the current lexer kind based on the CurLexer/CurPTHLexer/ 797d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// CurTokenLexer pointers. 798d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor void recomputeCurLexerKind(); 799e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 800e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Returns true if incremental processing is enabled 801e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool isIncrementalProcessingEnabled() const { return IncrementalProcessing; } 802e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 803e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Enables the incremental processing 804e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann void enableIncrementalProcessing(bool value = true) { 805e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann IncrementalProcessing = value; 806e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann } 807d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor 8082968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 8092968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8102968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 8112968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 8122968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 8132968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 8142968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8152968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 8162968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8172968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8182968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 8192968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8202968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8212968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 822a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 8232968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 8242968442603b029949246467253eeac8139a5b6d8Douglas Gregor 8253437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 8263437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 8273437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 8287d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the location of the code-completion point. 8297d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 8307d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 8317d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; } 8327d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8337d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the start location of the file of code-completion point. 8347d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 8357d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 8367d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionFileLoc() const { 8377d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis return CodeCompletionFileLoc; 8387d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 8397d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8407d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns true if code-completion is enabled and we have hit the 8417d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// code-completion point. 8427d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool isCodeCompletionReached() const { return CodeCompletionReached; } 8437d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8447d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Note that we hit the code-completion point. 845d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer void setCodeCompletionReached() { 846d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer assert(isCodeCompletionEnabled() && "Code-completion not enabled!"); 847d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer CodeCompletionReached = true; 848d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer // Silence any diagnostics that occur after we hit the code-completion. 849d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer getDiagnostics().setSuppressAllDiagnostics(true); 850d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 8517d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 852809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief The location of the currently-active \#pragma clang 8538dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. Returns an invalid location if there 8548dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// is no such pragma active. 8558dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation getPragmaARCCFCodeAuditedLoc() const { 8568dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall return PragmaARCCFCodeAuditedLoc; 8578dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 8588dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 859809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Set the location of the currently-active \#pragma clang 8608dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. An invalid location ends the pragma. 8618dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc) { 8628dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall PragmaARCCFCodeAuditedLoc = Loc; 8638dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 8648dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 865809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Instruct the preprocessor to skip part of the main source file. 866f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 867809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param Bytes The number of bytes in the preamble to skip. 868f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 869809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param StartOfLine Whether skipping these bytes puts the lexer at the 870f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 871ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 872f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 873f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 874f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 875ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 8765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 877d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 8785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 879d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const { 880d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Loc, DiagID); 881d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 8821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 883d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const { 884d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Tok.getLocation(), DiagID); 885d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 8861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 887834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 888834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 8899e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 89030900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 891834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 892834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 89330900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 894686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 895686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 896834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 8974e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(loc, buffer, SourceMgr, LangOpts, invalid); 898834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 89930900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 9005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 9015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 9025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 9035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 9045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 90550f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 90630900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 907b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 9084e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, SourceMgr, LangOpts, Invalid); 909b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 9100ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 9115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 9125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 9135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 9145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 9155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 9165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 9175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 9185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 9195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 9205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 921ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned getSpelling(const Token &Tok, const char *&Buffer, 92248cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 9234e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, Buffer, SourceMgr, LangOpts, Invalid); 92448cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 925b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 926ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 927ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 928ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 929686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 930f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber SmallVectorImpl<char> &Buffer, 931f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber bool *Invalid = 0) const; 932ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 9337216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 9347216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 935ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 93650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 9377216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 9387216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 9397216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 9407216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 9417216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 9427216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 9437216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 94428396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 9457216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 9467216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 947a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 94828396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 9491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 950c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// \brief Retrieve the name of the immediate macro expansion. 951c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// 952c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// This routine starts from a source location, and finds the name of the macro 953c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// responsible for its immediate expansion. It looks through any intervening 954c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// macro argument expansions to compute this. It returns a StringRef which 955c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// refers to the SourceManager-owned buffer of the source where that macro 956c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// name is spelled. Thus, the result shouldn't out-live the SourceManager. 957c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks StringRef getImmediateMacroName(SourceLocation Loc) { 9584e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getImmediateMacroName(Loc, SourceMgr, getLangOpts()); 959c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks } 960c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks 96147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 96247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 9639e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 964374b3837d676133fcc1eb70a25c8baf8ec4a5c4aDmitri Gribenko void CreateString(StringRef Str, Token &Tok, 965a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocStart = SourceLocation(), 966a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocEnd = SourceLocation()); 967b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 968b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 969b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 970b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 971b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 972b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 973b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 974b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 975b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 976b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 977b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 97833e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 97933e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 98033e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 98133e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 98233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 9837ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 9844e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, LangOpts); 9857ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 9861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9877a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 9889e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 98969bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 99069bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to 99169bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// begin location of the macro. 99269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtStartOfMacroExpansion(SourceLocation loc, 99369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroBegin = 0) const { 9944e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, LangOpts, 99569bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis MacroBegin); 9967a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 9977a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 9987a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 9999e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 100069bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 1001ad0fe03b897f9486191e75c8d90c3ffa9b4fd6a5Ted Kremenek /// \param MacroEnd If non-null and function returns true, it is set to 100269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// end location of the macro. 100369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtEndOfMacroExpansion(SourceLocation loc, 100469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroEnd = 0) const { 10054e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, LangOpts, MacroEnd); 10067a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 10077a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 10085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 10095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1010d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 1011c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 10125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 10131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101497ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 101597ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 1016872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 1017872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 10184e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, LangOpts); 1019872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 1020872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 10215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 10225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 10235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 10255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 10265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 10275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 10285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 10295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 10305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 10311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 10335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1034c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 1035c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 10363f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 10373f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 10383f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 10393f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 10401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 10425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 10435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 10445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1045c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 1046c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 1047c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 1048c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 105128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 105228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 105328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 105428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 105528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 105628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 105728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 105828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 105928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 106028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 106128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 106228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 106328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 106428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 106528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 106628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 106728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 106828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 106928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 107028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 107128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 107228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 107328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 107428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 107528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 1076ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except block 1077ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_code, 1078ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_code, 1079ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionCode; 1080ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except filter expression 1081ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_info, 1082ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_info, 1083ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionInfo; 1084ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __finally 1085ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__abnormal_termination, 1086ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___abnormal_termination, 1087ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_AbnormalTermination; 108828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 108928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 109028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 10915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 10925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 10935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 10945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 1095d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 10965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 10995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 11005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 11015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 1102d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 11031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1104fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 1105fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 1106fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 11071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 11091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 11105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 11115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 1112d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 11135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 111484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 111584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 1116ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 1117ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 11181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1119478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 112084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 1121478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 11221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11237c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 11247c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 11257c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 11267c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 11277c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 1128c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 1129c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 11301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 113190db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Retrieves the module that we're currently building, if any. 113290db26000aefe9335370013eec64c85232d80227Douglas Gregor Module *getCurrentModule(); 113390db26000aefe9335370013eec64c85232d80227Douglas Gregor 113458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object with the provided SourceLocation. 1135f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 1136f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 113758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object which is clone of \p MI. 1138f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 11391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 114058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Turn the specified lexer token into a fully checked and spelled 114158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// filename, e.g. as an operand of \#include. 114258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 114358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// The caller is expected to provide a buffer that is large enough to hold 114458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// the spelling of the filename, but is also expected to handle the case 114558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when this method decides to use a different buffer. 114658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 114758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \returns true if the input filename was in <>'s or false if it was 114858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// in ""'s. 1149686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 1150a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 115158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given a "foo" or \<foo> reference, look up the indicated file. 115258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 115358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// Returns null on failure. \p isAngled indicates whether the file 115458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// reference is for system \#include's or not (i.e. using <> instead of ""). 1155686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 1156f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 1157b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 1158686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 1159fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor SmallVectorImpl<char> *RelativePath, 11601a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor Module **SuggestedModule, 11611c2e9332fa69727425a3a2b912e36e2ab62083f8Douglas Gregor bool SkipCache = false); 1162a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1163a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 1164a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 116558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 1166a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 1167a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 116858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Return true if we're in the top-level file, not in a \#include. 1169a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 1170a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 117158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// ConcatenateIncludeName - Handle cases where the \#include name is expanded 1172a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 1173a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 117458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \code 117570517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// \#define FOO <x/y.h> 117658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#include FOO 117758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \endcode 117870517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// because in this case, "<x/y.h>" is returned as 7 tokens, not one. 1179a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 1180321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 1181321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 118284021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 1183f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith bool ConcatenateIncludeName(SmallString<128> &FilenameBuffer, 1184ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 1185a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 11869d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 118784021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 11889d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 11899d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 11905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 11911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1192d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 1193b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeMacroStack.push_back(IncludeStackInfo(CurLexerKind, 1194b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexer.take(), 11959c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 11969c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 11979c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 11989c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 1199f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 1200d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1202d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 1203caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 12049c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 12059c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 1206caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 12079c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 1208b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexerKind = IncludeMacroStack.back().CurLexerKind; 1209d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 1210d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 121258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object. 1213f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 1214f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 121558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Release the specified MacroInfo for re-use. 121658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 121758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This memory will be reused for allocating new MacroInfo objects. 12180301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 12191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 122158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#define or \#undef. This emits a diagnostic, sets the token kind to eod, 12225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 1223d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 12241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 12265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 1227e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// closing ), updating MI with what we learn and saving in LastTok the 1228e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// last token read. 1229e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// Return true if an error occurs parsing the arg list. 1230e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara bool ReadMacroDefinitionArgList(MacroInfo *MI, Token& LastTok); 12311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 123258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// We just read a \#if or related directive and decided that the 123358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// subsequent tokens are in the \#if'd out portion of the 123458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// file. Lex the rest of the file, until we see an \#endif. If \p 12355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 123658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// this \#if directive, so \#else/\#elif blocks should never be entered. If 123758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \p FoundElse is false, then \#else directives are ok, if not, then we have 123858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// already seen one so a \#else directive is a duplicate. When this returns, 12395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 12405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 12416b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis bool FoundNonSkipPortion, bool FoundElse, 12426b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis SourceLocation ElseLoc = SourceLocation()); 12431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 124458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief A fast PTH version of SkipExcludedConditionalBlock. 1245268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 12461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 12485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 12495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 12505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 12511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 125358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#pragma GCC poison/system_header/dependency and \#pragma once. 12545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 12551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Register builtin macros such as __LINE__ with the identifier table. 12575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 12581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 12605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 12615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1262d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 12631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12645b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 12655b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 12665b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 12675b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 12685b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 12695b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 12702d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 12715b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 12725b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 12735b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 12745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 12755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 12765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 12775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 12781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 12805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 12815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1282e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 12839e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 12845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 12865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1287d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 12881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 12905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 12915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1292d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 12931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12941ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 12951ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 12961ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 12971ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 12985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 12995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 13005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 13016137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 13026137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 13036137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 13046137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 13051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 130634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 130734eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 130834eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 130934eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 131041938c8493b4380df738263166b746eacb33c309Ted Kremenek } 131141938c8493b4380df738263166b746eacb33c309Ted Kremenek 131281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 131381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 131441938c8493b4380df738263166b746eacb33c309Ted Kremenek } 131541938c8493b4380df738263166b746eacb33c309Ted Kremenek 131681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 131781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 131841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 13191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 132103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 132203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 132303569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 132403569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 132503569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 1326ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 132756eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 132803569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 132903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 133003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 133103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 133203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 133303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 133403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 13353604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 133603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 133703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 13385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 13395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 13405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1341359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1342478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1343d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1344d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 134594ad28b31433058445a27db722f60402ee820beaDouglas Gregor void HandleMacroPublicDirective(Token &Tok); 1346aa93a875605536d72a10359a0098396192b7d4ecDouglas Gregor void HandleMacroPrivateDirective(Token &Tok); 1347ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 13485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1349ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1350ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 13515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 13525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1353ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1354ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1355ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 13564207edaf03da28fa917a94b31c5c1eef0e6417dcAaron Ballman void HandleMicrosoftImportDirective(Token &Tok); 13571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 135942e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1360d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 1361a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor void UndefineMacro(IdentifierInfo *II, MacroInfo *MI, 1362a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor SourceLocation UndefLoc); 13631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1365d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 13665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1367d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1368d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1369d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1370d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 13711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 137380c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 13745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1375d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 13762243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1377d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1378d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1379d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1380636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1381abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1382f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1383f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 13844c55c54db8e676aa3e042188773d9d82d59fff91Aaron Ballman void HandlePragmaIncludeAlias(Token &Tok); 1385f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1386f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1387046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1388046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1389046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 13900827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 13910827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 13920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 13930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 13945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 13972e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 13982e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 13992e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 14002e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 14011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1402046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1403046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1404046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 14052e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 14061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 14085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1410