Preprocessor.h revision 31672b1745195d709b641f1c0f44e203742fa73b
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 171b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner#include "clang/Basic/Builtins.h" 18d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer#include "clang/Basic/Diagnostic.h" 19c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 2130a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/Lexer.h" 2230a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/MacroInfo.h" 2330a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/PPCallbacks.h" 2430a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/PPMutationListener.h" 2530a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/PTHLexer.h" 2630a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/PTHManager.h" 2730a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Lex/TokenLexer.h" 2830a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/ArrayRef.h" 29cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 304f32786ac45210143654390177105eb749b614e9Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 31caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 3230a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/SmallPtrSet.h" 33f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer#include "llvm/ADT/SmallVector.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; 5836a16498ff911a218f26c7955376bbe99ddb16dfDouglas Gregorclass PreprocessorOptions; 59ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 601952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko/// \brief Stores token information for comparing actual tokens with 611952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko/// predefined values. Only handles simple tokens and identifiers. 621952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenkoclass TokenValue { 631952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko tok::TokenKind Kind; 641952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko IdentifierInfo *II; 651952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 661952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenkopublic: 671952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko TokenValue(tok::TokenKind Kind) : Kind(Kind), II(0) { 681952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(Kind != tok::raw_identifier && "Raw identifiers are not supported."); 691952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(Kind != tok::identifier && 701952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko "Identifiers should be created by TokenValue(IdentifierInfo *)"); 711952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(!tok::isLiteral(Kind) && "Literals are not supported."); 721952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko assert(!tok::isAnnotation(Kind) && "Annotations are not supported."); 731952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko } 741952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko TokenValue(IdentifierInfo *II) : Kind(tok::identifier), II(II) {} 751952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko bool operator==(const Token &Tok) const { 761952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko return Tok.getKind() == Kind && 771952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko (!II || II == Tok.getIdentifierInfo()); 781952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko } 791952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko}; 801952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 81e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 8458bf98725b6d4588338e191d2ab981b104471dabJames Dennett/// like the \#include stack, token expansion, etc. 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 86c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass Preprocessor : public RefCountedBase<Preprocessor> { 87cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko IntrusiveRefCntPtr<PreprocessorOptions> PPOpts; 88d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticsEngine *Diags; 894e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie LangOptions &LangOpts; 90998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *Target; 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 956aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader; 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 9888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 99a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 100ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1016137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 1026137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 1036f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHManager> PTH; 1041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1050ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 1060ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 1070ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 115c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 1161ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma 1171ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__ 118148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 119c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne IdentifierInfo *Ident__has_extension; // __has_extension 120148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 121cae5095c116c29a4e52c91fa0ad88df09dd2b45fAnders Carlsson IdentifierInfo *Ident__has_attribute; // __has_attribute 12292bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 12392bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 124d768150ef57f617c8d9fef48f3c92e8f21698024Ted Kremenek IdentifierInfo *Ident__has_warning; // __has_warning 125b09de5177ee8101818a59dcd0038c75b190a2509Douglas Gregor IdentifierInfo *Ident__building_module; // __building_module 126b09de5177ee8101818a59dcd0038c75b190a2509Douglas Gregor IdentifierInfo *Ident__MODULE__; // __MODULE__ 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 129c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 13258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// MaxIncludeStackDepth - Maximum depth of \#includes. 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 139f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool SuppressIncludeNotFoundError : 1; 140ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1445814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1455814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1465814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1471d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1481d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1491d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 1508c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// MacroExpansionInDirectivesOverride - Temporarily disables 1518c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// DisableMacroExpansion (i.e. enables expansion) when parsing preprocessor 1528c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// directives. 1538c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie bool MacroExpansionInDirectivesOverride : 1; 1548c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 1558c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie class ResetMacroExpansionHelper; 1568c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 15788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 15888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 159a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1606fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose /// \brief True if pragmas are enabled. 1616fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool PragmasEnabled : 1; 1626fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 16331672b1745195d709b641f1c0f44e203742fa73bAaron Ballman /// \brief True if we are currently preprocessing a #if or #elif directive 16431672b1745195d709b641f1c0f44e203742fa73bAaron Ballman bool ParsingIfOrElifDirective; 16531672b1745195d709b641f1c0f44e203742fa73bAaron Ballman 16614e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis /// \brief True if we are pre-expanding macro arguments. 16714e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis bool InMacroArgPreExpansion; 16814e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 171c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 17468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1759e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 17668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 17868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 179083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 18029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1812e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1821b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1831b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1902e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1912e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 193e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief True if we want to ignore EOF token and continue later on (thus 194e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// avoid tearing the Lexer and etc. down). 195e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrementalProcessing; 196e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 197f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 198f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 199ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2002968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 2012968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 2022968442603b029949246467253eeac8139a5b6d8Douglas Gregor 2037d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The offset in file for the code-completion point. 2047d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis unsigned CodeCompletionOffset; 2057d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2067d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The location for the code-completion point. This gets instantiated 20758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when the CodeCompletionFile gets \#include'ed for preprocessing. 2087d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionLoc; 2097d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2107d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The start location for the file of the code-completion point. 21158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 21258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This gets instantiated when the CodeCompletionFile gets \#include'ed 2137d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// for preprocessing. 2147d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionFileLoc; 2157d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 216c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// \brief The source location of the 'import' contextual keyword we just 217c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// lexed, if any. 218b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor SourceLocation ModuleImportLoc; 2198dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 220b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief The module import path that we're currently processing. 221cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> ModuleImportPath; 222b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 223b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief Whether the module import expectes an identifier next. Otherwise, 224b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// it expects a '.' or ';'. 225b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor bool ModuleImportExpectsIdentifier; 226b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 2278dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The source location of the currently-active 2288dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// #pragma clang arc_cf_code_audited begin. 2298dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation PragmaARCCFCodeAuditedLoc; 230ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2317d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief True if we hit the code-completion point. 2327d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool CodeCompletionReached; 2337d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 234f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 235f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 236f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 237f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 238f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 239ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 2419c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 2429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2436f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Lexer> CurLexer; 2441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2459c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 2469c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 2479c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2486f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHLexer> CurPTHLexer; 2491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2509c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 2519c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 2529c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 25323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 254ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 25758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2606cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 2616cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 2626f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<TokenLexer> CurTokenLexer; 2631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 264b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The kind of lexer we're currently working with. 265ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie enum CurLexerKind { 266ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_Lexer, 267ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_PTHLexer, 268ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_TokenLexer, 269b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_CachingLexer, 270b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_LexAfterModuleImport 271b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } CurLexerKind; 272b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 27458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#included, and macros currently being expanded from, not counting 2756cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 277b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind CurLexerKind; 2789c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 2799c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 2809c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 2811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 2839c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 284ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IncludeStackInfo(enum CurLexerKind K, Lexer *L, PTHLexer* P, 285b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor PreprocessorLexer* PPL, 2869c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 287ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie : CurLexerKind(K), TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), 288b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor TheTokenLexer(TL), TheDirLookup(D) {} 2895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 29358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// encountered (e.g. a file is \#included, etc). 2945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 296a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Listener whose actions are invoked when an entity in the 297a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// preprocessor (e.g., a macro) that was loaded from an AST file is 298a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// later mutated. 299a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *Listener; 300a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 30166c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis struct MacroExpandsInfo { 30266c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis Token Tok; 30366c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroInfo *MI; 30466c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SourceRange Range; 30566c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroExpandsInfo(Token Tok, MacroInfo *MI, SourceRange Range) 30666c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis : Tok(Tok), MI(MI), Range(Range) { } 30766c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis }; 30866c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SmallVector<MacroExpandsInfo, 2> DelayedMacroExpandsCallbacks; 30966c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis 3108a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// Macros - For each IdentifierInfo that was associated with a macro, we 3118a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// keep a mapping to the history of all macro definitions and #undefs in 3128a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// the reverse order (the latest one is in the head of the list). 313b3958476b21702a15f64f09d2862506d03dffe7bDmitri Gribenko llvm::DenseMap<const IdentifierInfo*, MacroInfo*> Macros; 314c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor friend class ASTReader; 315c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor 3160827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 3170827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 3180827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 3190827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 3200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 3210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 3220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 3230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 3240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 3250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 32623f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 32723f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 32823f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 32923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 330ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 331ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 332ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// push_macro directive, we keep a MacroInfo stack used to restore 333f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 334f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 344aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 345aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 346aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 3471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3486cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 3496cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 3506cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 3516cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 3529e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 3535b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 3545b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 3555b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 3565b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 3575b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 358686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 3595b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 3605b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 3619e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 362ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// occurred during preprocessing. 36394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 36494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 36594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 366b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 367ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 368e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 369686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 37003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 37103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 37203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 37303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 37403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 37503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 37603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 37703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 37803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 37903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 380a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 381a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 382a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 383a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 384a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 38503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 386af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 387af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 388af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 3899714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 390af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 391af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 392af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 393af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 394af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 395af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 3969714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 3979714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 3989714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 3999714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 4005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 401cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko Preprocessor(IntrusiveRefCntPtr<PreprocessorOptions> PPOpts, 40236a16498ff911a218f26c7955376bbe99ddb16dfDouglas Gregor DiagnosticsEngine &diags, LangOptions &opts, 403998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *target, 40472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 4056aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 4065814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 407998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool OwnsHeaderSearch = false, 408e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool DelayInitialization = false, 409e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrProcessing = false); 41072b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 4115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 413998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \brief Initialize the preprocessor, if the constructor did not already 414998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// perform the initialization. 415998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// 416998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \param Target Information about the target. 417998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor void Initialize(const TargetInfo &Target); 418ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 419a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor /// \brief Retrieve the preprocessor options used to initialize this 420a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor /// preprocessor. 421a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor PreprocessorOptions &getPreprocessorOpts() const { return *PPOpts; } 422a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor 423d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return *Diags; } 424d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; } 4257c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 4264e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &getLangOpts() const { return LangOpts; } 427998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo &getTargetInfo() const { return *Target; } 4285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 4295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 4305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 4315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 43329238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 4341b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 43532fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 4361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 437337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 4381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 439880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 4402e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 44188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 44288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 44388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 444a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 44588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 44688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 44788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 448a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 4496aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 4506aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 451ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 45231672b1745195d709b641f1c0f44e203742fa73bAaron Ballman /// \brief True if we are currently preprocessing a #if or #elif directive 45331672b1745195d709b641f1c0f44e203742fa73bAaron Ballman bool isParsingIfOrElifDirective() const { 45431672b1745195d709b641f1c0f44e203742fa73bAaron Ballman return ParsingIfOrElifDirective; 45531672b1745195d709b641f1c0f44e203742fa73bAaron Ballman } 45631672b1745195d709b641f1c0f44e203742fa73bAaron Ballman 4575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 4585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 4605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 4615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 4625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 4651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4666fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose void setPragmasEnabled(bool Enabled) { PragmasEnabled = Enabled; } 4676fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool getPragmasEnabled() const { return PragmasEnabled; } 4686fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 469f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman void SetSuppressIncludeNotFoundError(bool Suppress) { 470f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman SuppressIncludeNotFoundError = Suppress; 471f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 472f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 473f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool GetSuppressIncludeNotFoundError() { 474f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman return SuppressIncludeNotFoundError; 475f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 476f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 4775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 4785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 4797062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 4807062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 4815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 483a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 484a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 485a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 486a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 487a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 488321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 489321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 4905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 49168e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 4921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 493a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 494eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 495eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 4965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 497a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 498e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 499e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 5005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 5015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 503a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Attach an preprocessor mutation listener to the preprocessor. 504a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// 505a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// The preprocessor mutation listener provides the ability to track 506a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// modifications to the preprocessor entities committed after they were 507a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// initially created. 508a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor void setPPMutationListener(PPMutationListener *Listener) { 509a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor this->Listener = Listener; 510a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor } 511a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 512a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Retrieve a pointer to the preprocessor mutation listener 513a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// associated with this preprocessor, if any. 514a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *getPPMutationListener() const { return Listener; } 515a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 51658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given an identifier, return the MacroInfo it is \#defined to 51758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// or null if it isn't \#define'd. 518cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 519295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 520295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 521ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 5224d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko MacroInfo *MI = getMacroInfoHistory(II); 5234d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko assert(MI->getUndefLoc().isInvalid() && "Macro is undefined!"); 5244d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko return MI; 525cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 5261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5274d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// \brief Given an identifier, return the (probably #undef'd) MacroInfo 5284d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// representing the most recent macro definition. One can iterate over all 5294d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// previous macro definitions from it. This method should only be called for 5304d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// identifiers that hadMacroDefinition(). 531b3958476b21702a15f64f09d2862506d03dffe7bDmitri Gribenko MacroInfo *getMacroInfoHistory(const IdentifierInfo *II) const; 5324d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko 53358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Specify a macro for this identifier. 5346c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 5356c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// \brief Add a MacroInfo that was loaded from an AST file. 5367f69b1ab4f63ded511dddd7fb7e1cd8860757016Argyrios Kyrtzidis void addLoadedMacroInfo(IdentifierInfo *II, MacroInfo *MI); 5376c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// \brief Make the given MacroInfo, that was loaded from an AST file and 5386c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// previously hidden, visible. 5396c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor void makeLoadedMacroInfoVisible(IdentifierInfo *II, MacroInfo *MI); 540e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko /// \brief Undefine a macro for this identifier. 541e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko void clearMacroInfo(IdentifierInfo *II); 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5438a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// macro_iterator/macro_begin/macro_end - This allows you to walk the macro 5448a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// history table. Currently defined macros have 5458a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// IdentifierInfo::hasMacroDefinition() set and an empty 5468a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// MacroInfo::getUndefLoc() at the head of the list. 547b3958476b21702a15f64f09d2862506d03dffe7bDmitri Gribenko typedef llvm::DenseMap<const IdentifierInfo *, 54809b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 54988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 55088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 551a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 5521952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// \brief Return the name of the macro defined before \p Loc that has 5531952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// spelling \p Tokens. If there are multiple macros with same spelling, 5541952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// return the last one defined. 5551952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko StringRef getLastMacroWithSpelling(SourceLocation Loc, 5561952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko ArrayRef<TokenValue> Tokens) const; 5571952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 558e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 559aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 560aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 561aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 562aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56403e67fbf7a2646447972742b6bb97c82ce4698fbNico Weber /// Return information about the specified preprocessor 56503e67fbf7a2646447972742b6bb97c82ce4698fbNico Weber /// identifier token. 566686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 5673da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 5685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 5715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 5725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 573686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 5749b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 575686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 5769b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 5775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5784095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 5791824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// the preprocessor. If \p Namespace is non-null, then it should 5801824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// be the namespace that \p Handler was added to. It is an error 5814095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 582686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 5839b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 584686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 5859b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 5864095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 5872e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 588aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void addCommentHandler(CommentHandler *Handler); 5891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5902e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 5912e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 5922e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 593aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void removeCommentHandler(CommentHandler *Handler); 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 595f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 596f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 597f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 598f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 599ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 6001fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 6011fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 6021fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 6031fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 604ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 605f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 606f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 607f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 608f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 609ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 61055817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 61155817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 61255817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 613ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 61494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 61594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 616b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 617ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 618ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// \brief Create a new preprocessing record, which will keep track of 61994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 62037ed12720a35b7bfa1c4de73ad6f1c6c1c88ee17Argyrios Kyrtzidis void createPreprocessingRecord(); 621ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 62253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 6237dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 624e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 6251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 626dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 627dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 628dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 629dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 6305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 631e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 632e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 633e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 634e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 6355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 6375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 6385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 639e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 640e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 641e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 642c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroInfo *Macro, 643c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith MacroArgs *Args); 6441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 6466b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 6476b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6486b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 6496b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 6506b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 6516b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6526b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 6536b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 6546b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 6556b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 6566b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6576b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 6586b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 6591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 6615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 6625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 6635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 66403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 66503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 666ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 667ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 668ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 66903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 670a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 671ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 672ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 67303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 674ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 675ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 676ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 67703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 678a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 67903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 680ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 681ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 68203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 68303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 6841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 685a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 68603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 68703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 68803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 689fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 69003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 6915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 6925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 693d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 694b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor switch (CurLexerKind) { 695b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_Lexer: CurLexer->Lex(Result); break; 696b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_PTHLexer: CurPTHLexer->Lex(Result); break; 697b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_TokenLexer: CurTokenLexer->Lex(Result); break; 698b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_CachingLexer: CachingLex(Result); break; 699b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_LexAfterModuleImport: LexAfterModuleImport(Result); break; 700b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } 7015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 703b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor void LexAfterModuleImport(Token &Result); 704ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 70502a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \brief Lex a string literal, which may be the concatenation of multiple 70602a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// string literals and may even come from macro expansion. 70702a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \returns true on success, false if a error diagnostic has been generated. 70802a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool LexStringLiteral(Token &Result, std::string &String, 70997f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs const char *DiagnosticTag, bool AllowMacroExpansion) { 71002a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs if (AllowMacroExpansion) 71102a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs Lex(Result); 71202a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs else 71302a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs LexUnexpandedToken(Result); 71497f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs return FinishLexStringLiteral(Result, String, DiagnosticTag, 71597f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs AllowMacroExpansion); 71602a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs } 71702a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs 71802a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \brief Complete the lexing of a string literal where the first token has 71902a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// already been lexed (see LexStringLiteral). 72002a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool FinishLexStringLiteral(Token &Result, std::string &String, 72197f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs const char *DiagnosticTag, 72202a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool AllowMacroExpansion); 72302a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs 7245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 7255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 7265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 727d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 7285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 7295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 7305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 7315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 732d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 7335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 7345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 735d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 7365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 7375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 7385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 7395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 7405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 7435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 7445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 74788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 74888710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 74988710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 75088710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 75188710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 75288710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 75388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 7548c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// Disables macro expansion everywhere except for preprocessor directives. 7558c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie void SetMacroExpansionOnlyInDirectives() { 7568c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie DisableMacroExpansion = true; 7578c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie MacroExpansionInDirectivesOverride = true; 7588c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie } 7598c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 7606b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 7616b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 7626b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 7636b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 7646b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 76503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 76603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 76703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 76803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 76903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 7709e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 7713604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 77208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 77308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 77408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 77508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 77608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 77708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 77808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 77908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 78008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 78108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 78208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 78308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 78408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 78508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 7863604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 7873604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 7883604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 7893604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 7903604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 7913604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 7923604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 7933604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 7943604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 7953604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 7963604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 7973604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 7983604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 7993604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 8003604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 8013604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 8023604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 80347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 80483cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 8053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 8063604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 80739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 8081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 80939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 81039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 81139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 81239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 81339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 81439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 81539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 81639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 81739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 81839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 81939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 82039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 82139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 8220576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// TypoCorrectToken - Update the current token to represent the provided 8230576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// identifier, in order to cache an action performed by typo correction. 8240576681bac125be07f77f66b02a3dba2c3a24557Richard Smith void TypoCorrectToken(const Token &Tok) { 8250576681bac125be07f77f66b02a3dba2c3a24557Richard Smith assert(Tok.getIdentifierInfo() && "Expected identifier token"); 8260576681bac125be07f77f66b02a3dba2c3a24557Richard Smith if (CachedLexPos != 0 && isBacktrackEnabled()) 8270576681bac125be07f77f66b02a3dba2c3a24557Richard Smith CachedTokens[CachedLexPos-1] = Tok; 8280576681bac125be07f77f66b02a3dba2c3a24557Richard Smith } 8290576681bac125be07f77f66b02a3dba2c3a24557Richard Smith 830d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// \brief Recompute the current lexer kind based on the CurLexer/CurPTHLexer/ 831d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// CurTokenLexer pointers. 832d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor void recomputeCurLexerKind(); 833e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 834e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Returns true if incremental processing is enabled 835e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool isIncrementalProcessingEnabled() const { return IncrementalProcessing; } 836e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 837e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Enables the incremental processing 838e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann void enableIncrementalProcessing(bool value = true) { 839e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann IncrementalProcessing = value; 840e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann } 841d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor 8422968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 8432968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8442968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 8452968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 8462968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 8472968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 8482968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8492968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 8502968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8512968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8522968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 8532968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8542968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8552968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 856a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 8572968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 8582968442603b029949246467253eeac8139a5b6d8Douglas Gregor 8593437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 8603437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 8613437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 8627d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the location of the code-completion point. 8637d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 8647d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 8657d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; } 8667d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8677d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the start location of the file of code-completion point. 8687d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 8697d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 8707d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionFileLoc() const { 8717d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis return CodeCompletionFileLoc; 8727d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 8737d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8747d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns true if code-completion is enabled and we have hit the 8757d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// code-completion point. 8767d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool isCodeCompletionReached() const { return CodeCompletionReached; } 8777d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 8787d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Note that we hit the code-completion point. 879d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer void setCodeCompletionReached() { 880d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer assert(isCodeCompletionEnabled() && "Code-completion not enabled!"); 881d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer CodeCompletionReached = true; 882d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer // Silence any diagnostics that occur after we hit the code-completion. 883d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer getDiagnostics().setSuppressAllDiagnostics(true); 884d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 8857d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 886809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief The location of the currently-active \#pragma clang 8878dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. Returns an invalid location if there 8888dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// is no such pragma active. 8898dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation getPragmaARCCFCodeAuditedLoc() const { 8908dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall return PragmaARCCFCodeAuditedLoc; 8918dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 8928dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 893809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Set the location of the currently-active \#pragma clang 8948dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. An invalid location ends the pragma. 8958dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc) { 8968dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall PragmaARCCFCodeAuditedLoc = Loc; 8978dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 8988dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 899809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Instruct the preprocessor to skip part of the main source file. 900f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 901809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param Bytes The number of bytes in the preamble to skip. 902f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 903809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param StartOfLine Whether skipping these bytes puts the lexer at the 904f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 905ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 906f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 907f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 908f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 909ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 9105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 911d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 9125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 913d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const { 914d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Loc, DiagID); 915d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 9161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 917d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const { 918d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Tok.getLocation(), DiagID); 919d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 9201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 921834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 922834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 9239e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 92430900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 925834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 926834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 92730900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 928686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 929686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 930834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 9314e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(loc, buffer, SourceMgr, LangOpts, invalid); 932834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 93330900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 9345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 9355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 9365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 9375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 9385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 93950f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 94030900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 941b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 9424e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, SourceMgr, LangOpts, Invalid); 943b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 9440ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 9455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 9465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 9475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 9485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 9495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 9505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 9515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 9525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 9535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 9545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 955ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned getSpelling(const Token &Tok, const char *&Buffer, 95648cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 9574e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, Buffer, SourceMgr, LangOpts, Invalid); 95848cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 959b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 960ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 961ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 962ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 963686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 964f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber SmallVectorImpl<char> &Buffer, 965f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber bool *Invalid = 0) const; 966ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 967d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis /// \brief Relex the token at the specified location. 968d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis /// \returns true if there was a failure, false on success. 969d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis bool getRawToken(SourceLocation Loc, Token &Result) { 970d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis return Lexer::getRawToken(Loc, Result, SourceMgr, LangOpts); 971d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis } 972d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis 9737216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 9747216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 975ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 97650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 9777216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 9787216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 9797216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 9807216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 9817216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 9827216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 9837216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 98428396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 9857216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 9867216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 987a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 98828396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 9891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 990c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// \brief Retrieve the name of the immediate macro expansion. 991c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// 992c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// This routine starts from a source location, and finds the name of the macro 993c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// responsible for its immediate expansion. It looks through any intervening 994c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// macro argument expansions to compute this. It returns a StringRef which 995c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// refers to the SourceManager-owned buffer of the source where that macro 996c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// name is spelled. Thus, the result shouldn't out-live the SourceManager. 997c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks StringRef getImmediateMacroName(SourceLocation Loc) { 9984e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getImmediateMacroName(Loc, SourceMgr, getLangOpts()); 999c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks } 1000c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks 100147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 100247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 10039e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 1004374b3837d676133fcc1eb70a25c8baf8ec4a5c4aDmitri Gribenko void CreateString(StringRef Str, Token &Tok, 1005a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocStart = SourceLocation(), 1006a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocEnd = SourceLocation()); 1007b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 1008b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 1009b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 1010b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 1011b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 1012b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 1013b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 1014b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 1015b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 1016b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 1017b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 101833e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 101933e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 102033e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 102133e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 102233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 10237ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 10244e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, LangOpts); 10257ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 10261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10277a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 10289e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 102969bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 103069bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to 103169bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// begin location of the macro. 103269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtStartOfMacroExpansion(SourceLocation loc, 103369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroBegin = 0) const { 10344e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, LangOpts, 103569bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis MacroBegin); 10367a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 10377a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 10387a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 10399e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 104069bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 1041ad0fe03b897f9486191e75c8d90c3ffa9b4fd6a5Ted Kremenek /// \param MacroEnd If non-null and function returns true, it is set to 104269bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// end location of the macro. 104369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtEndOfMacroExpansion(SourceLocation loc, 104469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroEnd = 0) const { 10454e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, LangOpts, MacroEnd); 10467a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 10477a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 10485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 10495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1050d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 1051c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 10525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 10531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105497ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 105597ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 1056872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 1057872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 10584e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, LangOpts); 1059872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 1060872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 10615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 10625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 10635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 10641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 10655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 10665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 10675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 10685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 10695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 10705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 10711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 10735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1074c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 1075c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 10763f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 10773f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 10783f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 10793f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 10801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 10825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 10835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 10845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1085c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 1086c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 1087c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 1088c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 109128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 109228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 109328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 109428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 109528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 109628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 109728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 109828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 109928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 110028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 110128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 110228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 110328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 110428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 110528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 110628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 110728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 110828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 110928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 111028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 111128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 111228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 111328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 111428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 111528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 1116ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except block 1117ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_code, 1118ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_code, 1119ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionCode; 1120ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except filter expression 1121ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_info, 1122ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_info, 1123ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionInfo; 1124ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __finally 1125ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__abnormal_termination, 1126ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___abnormal_termination, 1127ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_AbnormalTermination; 112828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 112928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 113028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 11315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 11325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 11335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 11345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 1135d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 11365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 11395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 11405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 11415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 1142d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 11431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1144fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 1145fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 1146fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 11471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 11491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 11505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 11515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 1152d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 11535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 115484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 115584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 1156ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 1157ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 11581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1159478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 116084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 1161478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 11621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11637c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 11647c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 11657c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 11667c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 11677c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 1168c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 1169c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 11701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 117190db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Retrieves the module that we're currently building, if any. 117290db26000aefe9335370013eec64c85232d80227Douglas Gregor Module *getCurrentModule(); 117390db26000aefe9335370013eec64c85232d80227Douglas Gregor 117458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object with the provided SourceLocation. 1175f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 1176f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 117758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object which is clone of \p MI. 1178f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 11791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 118058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Turn the specified lexer token into a fully checked and spelled 118158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// filename, e.g. as an operand of \#include. 118258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 118358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// The caller is expected to provide a buffer that is large enough to hold 118458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// the spelling of the filename, but is also expected to handle the case 118558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when this method decides to use a different buffer. 118658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 118758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \returns true if the input filename was in <>'s or false if it was 118858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// in ""'s. 1189686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 1190a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 119158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given a "foo" or \<foo> reference, look up the indicated file. 119258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 119358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// Returns null on failure. \p isAngled indicates whether the file 119458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// reference is for system \#include's or not (i.e. using <> instead of ""). 1195686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 1196f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 1197b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 1198686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 1199fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor SmallVectorImpl<char> *RelativePath, 12001a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor Module **SuggestedModule, 12011c2e9332fa69727425a3a2b912e36e2ab62083f8Douglas Gregor bool SkipCache = false); 1202a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1203a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 1204a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 120558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 1206a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 1207a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 120858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Return true if we're in the top-level file, not in a \#include. 1209a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 1210a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 121158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// ConcatenateIncludeName - Handle cases where the \#include name is expanded 1212a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 1213a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 121458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \code 121570517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// \#define FOO <x/y.h> 121658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#include FOO 121758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \endcode 121870517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// because in this case, "<x/y.h>" is returned as 7 tokens, not one. 1219a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 1220321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 1221321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 122284021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 1223f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith bool ConcatenateIncludeName(SmallString<128> &FilenameBuffer, 1224ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 1225a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 12269d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 122784021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 12289d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 12299d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 12305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 12311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1232d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 1233b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeMacroStack.push_back(IncludeStackInfo(CurLexerKind, 1234b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexer.take(), 12359c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 12369c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 12379c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 12389c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 1239f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 1240d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1242d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 1243caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 12449c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 12459c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 1246caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 12479c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 1248b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexerKind = IncludeMacroStack.back().CurLexerKind; 1249d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 1250d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object. 1253f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 1254f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 125558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Release the specified MacroInfo for re-use. 125658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 125758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This memory will be reused for allocating new MacroInfo objects. 12580301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 12591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 126158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#define or \#undef. This emits a diagnostic, sets the token kind to eod, 12625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 1263d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 12641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 12665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 1267e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// closing ), updating MI with what we learn and saving in LastTok the 1268e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// last token read. 1269e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// Return true if an error occurs parsing the arg list. 1270e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara bool ReadMacroDefinitionArgList(MacroInfo *MI, Token& LastTok); 12711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 127258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// We just read a \#if or related directive and decided that the 127358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// subsequent tokens are in the \#if'd out portion of the 127458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// file. Lex the rest of the file, until we see an \#endif. If \p 12755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 127658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// this \#if directive, so \#else/\#elif blocks should never be entered. If 127758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \p FoundElse is false, then \#else directives are ok, if not, then we have 127858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// already seen one so a \#else directive is a duplicate. When this returns, 12795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 12805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 12816b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis bool FoundNonSkipPortion, bool FoundElse, 12826b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis SourceLocation ElseLoc = SourceLocation()); 12831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief A fast PTH version of SkipExcludedConditionalBlock. 1285268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 12861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 12885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 12895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 12905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 12911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 129358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#pragma GCC poison/system_header/dependency and \#pragma once. 12945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 12951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Register builtin macros such as __LINE__ with the identifier table. 12975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 12981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 13005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 13015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1302d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 13031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13045b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 13055b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 13065b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 13075b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 13085b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 13095b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 13102d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 13115b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 13125b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 13135b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 13145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 13155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 13165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 13175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 13181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 13205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 13215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1322e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 13239e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 13245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 13265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1327d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 13281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 13305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 13315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1332d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 13331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13341ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 13351ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 13361ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 13371ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 13385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 13395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 13405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 13416137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 13426137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 13436137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 13446137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 13451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 134734eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 134834eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 134934eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 135041938c8493b4380df738263166b746eacb33c309Ted Kremenek } 135141938c8493b4380df738263166b746eacb33c309Ted Kremenek 135281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 135381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 135441938c8493b4380df738263166b746eacb33c309Ted Kremenek } 135541938c8493b4380df738263166b746eacb33c309Ted Kremenek 135681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 135781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 135841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 13591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 136103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 136203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 136303569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 136403569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 136503569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 1366ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 136756eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 136803569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 136903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 137003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 137103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 137203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 137303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 137403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 13753604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 137603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 137703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 13785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 13795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 13805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1381359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1382478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1383d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1384d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 138594ad28b31433058445a27db722f60402ee820beaDouglas Gregor void HandleMacroPublicDirective(Token &Tok); 1386aa93a875605536d72a10359a0098396192b7d4ecDouglas Gregor void HandleMacroPrivateDirective(Token &Tok); 1387ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 13885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1389ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1390ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 13915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 13925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1393ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1394ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1395ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 13964207edaf03da28fa917a94b31c5c1eef0e6417dcAaron Ballman void HandleMicrosoftImportDirective(Token &Tok); 13971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 139942e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1400d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 1401a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor void UndefineMacro(IdentifierInfo *II, MacroInfo *MI, 1402a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor SourceLocation UndefLoc); 14031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1405d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 14065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1407d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1408d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1409d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1410d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 14111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 141380c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 14145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1415d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 14162243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1417d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1418d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1419d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1420636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1421abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1422f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1423f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 14244c55c54db8e676aa3e042188773d9d82d59fff91Aaron Ballman void HandlePragmaIncludeAlias(Token &Tok); 1425f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1426f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1427046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1428046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1429046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 14300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 14310827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 14320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 14330827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 14345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 14355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 14372e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 14382e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 14392e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 14402e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 14411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1442046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1443046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1444046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 14452e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 14461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 14485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1450