Preprocessor.h revision 9818a1d443e97677dd3422305de9cc2b1fb2a8c1
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 16374c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose /// \brief True if the current build action is a preprocessing action. 16474c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose bool PreprocessedOutput : 1; 16574c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose 16631672b1745195d709b641f1c0f44e203742fa73bAaron Ballman /// \brief True if we are currently preprocessing a #if or #elif directive 16731672b1745195d709b641f1c0f44e203742fa73bAaron Ballman bool ParsingIfOrElifDirective; 16831672b1745195d709b641f1c0f44e203742fa73bAaron Ballman 16914e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis /// \brief True if we are pre-expanding macro arguments. 17014e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis bool InMacroArgPreExpansion; 17114e645557ae91c6770d62beb00a1c522e0bfd5d6Argyrios Kyrtzidis 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 174c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 17768d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1789e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 17968d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 18168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 182083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 18329238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1842e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1851b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1861b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1932e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1942e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 196e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief True if we want to ignore EOF token and continue later on (thus 197e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// avoid tearing the Lexer and etc. down). 198e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrementalProcessing; 199e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 200f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 201f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 202ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2032968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 2042968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 2052968442603b029949246467253eeac8139a5b6d8Douglas Gregor 2067d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The offset in file for the code-completion point. 2077d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis unsigned CodeCompletionOffset; 2087d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2097d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The location for the code-completion point. This gets instantiated 21058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when the CodeCompletionFile gets \#include'ed for preprocessing. 2117d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionLoc; 2127d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 2137d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The start location for the file of the code-completion point. 21458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 21558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This gets instantiated when the CodeCompletionFile gets \#include'ed 2167d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// for preprocessing. 2177d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionFileLoc; 2187d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 219c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// \brief The source location of the 'import' contextual keyword we just 220c13a34b690d2dc2a03c2fea75a0a1438636c19ceDouglas Gregor /// lexed, if any. 221b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor SourceLocation ModuleImportLoc; 2228dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 223b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief The module import path that we're currently processing. 224cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> ModuleImportPath; 225b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 226b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// \brief Whether the module import expectes an identifier next. Otherwise, 227b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor /// it expects a '.' or ';'. 228b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor bool ModuleImportExpectsIdentifier; 229b514c792821a8f053027d88444e13bfaa8efef76Douglas Gregor 2308dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The source location of the currently-active 2318dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// #pragma clang arc_cf_code_audited begin. 2328dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation PragmaARCCFCodeAuditedLoc; 233ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2347d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief True if we hit the code-completion point. 2357d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool CodeCompletionReached; 2367d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 237f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 238f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 239f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 240f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 241f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 242ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 2449c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 2459c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2466f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<Lexer> CurLexer; 2471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2489c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 2499c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 2509c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 2516f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PTHLexer> CurPTHLexer; 2521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2539c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 2549c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 2559c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 25623f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 257ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 26058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 2615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2636cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 2646cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 2656f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<TokenLexer> CurTokenLexer; 2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 267b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The kind of lexer we're currently working with. 268ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie enum CurLexerKind { 269ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_Lexer, 270ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_PTHLexer, 271ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie CLK_TokenLexer, 272b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_CachingLexer, 273b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_LexAfterModuleImport 274b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } CurLexerKind; 275b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 27758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#included, and macros currently being expanded from, not counting 2786cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 280b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind CurLexerKind; 2819c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 2829c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 2839c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 2855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 2869c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 287ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IncludeStackInfo(enum CurLexerKind K, Lexer *L, PTHLexer* P, 288b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor PreprocessorLexer* PPL, 2899c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 290ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie : CurLexerKind(K), TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), 291b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor TheTokenLexer(TL), TheDirLookup(D) {} 2925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 2941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 29658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// encountered (e.g. a file is \#included, etc). 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 299a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Listener whose actions are invoked when an entity in the 300a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// preprocessor (e.g., a macro) that was loaded from an AST file is 301a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// later mutated. 302a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *Listener; 303a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 30466c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis struct MacroExpandsInfo { 30566c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis Token Tok; 30666c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroInfo *MI; 30766c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SourceRange Range; 30866c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis MacroExpandsInfo(Token Tok, MacroInfo *MI, SourceRange Range) 30966c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis : Tok(Tok), MI(MI), Range(Range) { } 31066c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis }; 31166c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis SmallVector<MacroExpandsInfo, 2> DelayedMacroExpandsCallbacks; 31266c44e700fb3f244b2c443bfbd6a05b5f1843ec0Argyrios Kyrtzidis 3138a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// Macros - For each IdentifierInfo that was associated with a macro, we 3148a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// keep a mapping to the history of all macro definitions and #undefs in 3158a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// the reverse order (the latest one is in the head of the list). 3169818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis llvm::DenseMap<const IdentifierInfo*, MacroDirective*> Macros; 317c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor friend class ASTReader; 318c12906ee78e006df6a71acf52ca9dd3171ddbf07Douglas Gregor 3190827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 3200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 3210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 3220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 3230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 3240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 3250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 3260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 3270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 3280827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 32923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 33023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 33123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 33223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 333ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 334ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 335ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// push_macro directive, we keep a MacroInfo stack used to restore 336f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 337f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 3381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 3461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 347aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 348aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 349aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 3501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35195d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis /// \brief The file ID for the preprocessor predefines. 35295d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis FileID PredefinesFileID; 35395d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis 3546cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 3556cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 3566cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 3576cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 3589e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 3595b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 3605b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 3615b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 3625b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 3635b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 364686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 3655b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 3665b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 3679e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 368ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// occurred during preprocessing. 36994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 37094dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 37194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 372b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 373ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 374e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 375686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 37603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 37703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 37803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 37903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 38003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 38103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 38203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 38303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 38403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 38503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 386a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 387a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 388a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 389a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 390a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 39103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 392af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 393af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 394af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 3959714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 396af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 397af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 398af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 399af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 400af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 401af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 4029714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 4039714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 4049714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 4059714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 4065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 407cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko Preprocessor(IntrusiveRefCntPtr<PreprocessorOptions> PPOpts, 40836a16498ff911a218f26c7955376bbe99ddb16dfDouglas Gregor DiagnosticsEngine &diags, LangOptions &opts, 409998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *target, 41072b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 4116aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 4125814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 413998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool OwnsHeaderSearch = false, 414e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool DelayInitialization = false, 415e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool IncrProcessing = false); 41672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 4175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 419998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \brief Initialize the preprocessor, if the constructor did not already 420998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// perform the initialization. 421998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// 422998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \param Target Information about the target. 423998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor void Initialize(const TargetInfo &Target); 424ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 425a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor /// \brief Retrieve the preprocessor options used to initialize this 426a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor /// preprocessor. 427a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor PreprocessorOptions &getPreprocessorOpts() const { return *PPOpts; } 428a71a7d8a1ce4474e7bdb680658fb58b6caf391d3Douglas Gregor 429d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return *Diags; } 430d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; } 4317c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 4324e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &getLangOpts() const { return LangOpts; } 433998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo &getTargetInfo() const { return *Target; } 4345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 4365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 4375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 43929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 4401b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 44132fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 443337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 4441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 445880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 4462e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 44788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 44888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 44988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 450a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 45188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 45288a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 45388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 454a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 4556aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 4566aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 457ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 45831672b1745195d709b641f1c0f44e203742fa73bAaron Ballman /// \brief True if we are currently preprocessing a #if or #elif directive 45931672b1745195d709b641f1c0f44e203742fa73bAaron Ballman bool isParsingIfOrElifDirective() const { 46031672b1745195d709b641f1c0f44e203742fa73bAaron Ballman return ParsingIfOrElifDirective; 46131672b1745195d709b641f1c0f44e203742fa73bAaron Ballman } 46231672b1745195d709b641f1c0f44e203742fa73bAaron Ballman 4635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 4645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 4655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 4665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 4675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 4685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 4711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4726fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose void setPragmasEnabled(bool Enabled) { PragmasEnabled = Enabled; } 4736fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool getPragmasEnabled() const { return PragmasEnabled; } 4746fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 475f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman void SetSuppressIncludeNotFoundError(bool Suppress) { 476f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman SuppressIncludeNotFoundError = Suppress; 477f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 478f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 479f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool GetSuppressIncludeNotFoundError() { 480f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman return SuppressIncludeNotFoundError; 481f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 482f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 48374c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose /// Sets whether the preprocessor is responsible for producing output or if 48474c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose /// it is producing tokens to be consumed by Parse and Sema. 48574c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose void setPreprocessedOutput(bool IsPreprocessedOutput) { 48674c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose PreprocessedOutput = IsPreprocessedOutput; 48774c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose } 48874c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose 48974c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose /// Returns true if the preprocessor is responsible for generating output, 49074c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose /// false if it is producing tokens to be consumed by Parse and Sema. 49174c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose bool isPreprocessedOutput() const { return PreprocessedOutput; } 49274c2498bb9e339345ee32bdd095e76157cec3b86Jordan Rose 4935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 4945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 4957062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 4967062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 4975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 499a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 500a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 501a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 502a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 503a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 504321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 505321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 5065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 50768e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 5081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50995d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis /// \brief Returns the file ID for the preprocessor predefines. 5109484c1dcf084452228aae439edcd00e1b4ce7470Argyrios Kyrtzidis FileID getPredefinesFileID() const { return PredefinesFileID; } 51195d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis 512a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 513eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 514eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 5155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 516a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 517e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 518e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 5195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 5205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 522a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Attach an preprocessor mutation listener to the preprocessor. 523a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// 524a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// The preprocessor mutation listener provides the ability to track 525a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// modifications to the preprocessor entities committed after they were 526a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// initially created. 527a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor void setPPMutationListener(PPMutationListener *Listener) { 528a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor this->Listener = Listener; 529a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor } 530a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 531a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// \brief Retrieve a pointer to the preprocessor mutation listener 532a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor /// associated with this preprocessor, if any. 533a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor PPMutationListener *getPPMutationListener() const { return Listener; } 534a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor 53558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given an identifier, return the MacroInfo it is \#defined to 53658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// or null if it isn't \#define'd. 5379818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective *getMacroDirective(IdentifierInfo *II) const { 538295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 539295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 540ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 5419818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective *MD = getMacroDirectiveHistory(II); 5429818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis assert(MD->getUndefLoc().isInvalid() && "Macro is undefined!"); 5439818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis return MD; 5449818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis } 5459818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis 5469818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis const MacroInfo *getMacroInfo(IdentifierInfo *II) const { 5479818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis return const_cast<Preprocessor*>(this)->getMacroInfo(II); 5489818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis } 5499818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis 5509818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroInfo *getMacroInfo(IdentifierInfo *II) { 5519818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis if (MacroDirective *MD = getMacroDirective(II)) 5529818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis return MD->getInfo(); 5539818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis return 0; 554cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 5551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5564d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// \brief Given an identifier, return the (probably #undef'd) MacroInfo 5574d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// representing the most recent macro definition. One can iterate over all 5584d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// previous macro definitions from it. This method should only be called for 5594d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko /// identifiers that hadMacroDefinition(). 5609818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective *getMacroDirectiveHistory(const IdentifierInfo *II) const; 5614d7e0ced7f16a04aabe2d8d91cbbb52fb1162810Alexander Kornienko 56258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Specify a macro for this identifier. 5639818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis void setMacroDirective(IdentifierInfo *II, MacroInfo *MI, 5649818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis SourceLocation Loc, bool isImported); 5659818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis void setMacroDirective(IdentifierInfo *II, MacroInfo *MI) { 5669818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis setMacroDirective(II, MI, MI->getDefinitionLoc(), false); 5679818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis } 5686c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// \brief Add a MacroInfo that was loaded from an AST file. 5699818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis void addLoadedMacroInfo(IdentifierInfo *II, MacroDirective *MD, 5709818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective *Hint = 0); 5716c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// \brief Make the given MacroInfo, that was loaded from an AST file and 5726c6c54a59a6e7dbe63ff6a9bbab76f6e0c7c8462Douglas Gregor /// previously hidden, visible. 5739818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis void makeLoadedMacroInfoVisible(IdentifierInfo *II, MacroDirective *MD); 574e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko /// \brief Undefine a macro for this identifier. 575e40c4238a572bf8241a04e0005f70550cbfc1cfbAlexander Kornienko void clearMacroInfo(IdentifierInfo *II); 5761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5778a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// macro_iterator/macro_begin/macro_end - This allows you to walk the macro 5788a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// history table. Currently defined macros have 5798a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// IdentifierInfo::hasMacroDefinition() set and an empty 5808a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko /// MacroInfo::getUndefLoc() at the head of the list. 581b3958476b21702a15f64f09d2862506d03dffe7bDmitri Gribenko typedef llvm::DenseMap<const IdentifierInfo *, 5829818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective*>::const_iterator macro_iterator; 58388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 58488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 585a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 5861952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// \brief Return the name of the macro defined before \p Loc that has 5871952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// spelling \p Tokens. If there are multiple macros with same spelling, 5881952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko /// return the last one defined. 5891952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko StringRef getLastMacroWithSpelling(SourceLocation Loc, 5901952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko ArrayRef<TokenValue> Tokens) const; 5911952354bd376062c3ab3d328c0fc6c36530c9309Dmitri Gribenko 592e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 593aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 594aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 595aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 596aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 5971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59803e67fbf7a2646447972742b6bb97c82ce4698fbNico Weber /// Return information about the specified preprocessor 59903e67fbf7a2646447972742b6bb97c82ce4698fbNico Weber /// identifier token. 600686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 6013da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 6025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 607686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 6089b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 609686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 6109b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 6115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6124095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 6131824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// the preprocessor. If \p Namespace is non-null, then it should 6141824d54df85a462ada812dadda18130f951d40f3Dmitri Gribenko /// be the namespace that \p Handler was added to. It is an error 6154095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 616686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 6179b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 618686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 6199b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 6204095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 6212e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 622aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void addCommentHandler(CommentHandler *Handler); 6231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6242e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 6252e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 6262e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 627aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko void removeCommentHandler(CommentHandler *Handler); 6281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 629f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 630f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 631f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 632f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 633ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 6341fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 6351fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 6361fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 6371fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 638ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 639f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 640f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 641f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 642f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 643ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 64455817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 64555817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 64655817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 647ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 64894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 64994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 650b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 651ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 652ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// \brief Create a new preprocessing record, which will keep track of 65394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 65437ed12720a35b7bfa1c4de73ad6f1c6c1c88ee17Argyrios Kyrtzidis void createPreprocessingRecord(); 655ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 65653b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 6577dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 658e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 6591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 660dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 661dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 662dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 663dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 6645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 665e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 666e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 667e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 668e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 6695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 6715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 673e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 674e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 675e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 676c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroInfo *Macro, 677c30981a563a8947cb26b1e308d122fa2ef90fcebRichard Smith MacroArgs *Args); 6781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 6806b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 6816b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6826b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 6836b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 6846b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 6856b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6866b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 6876b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 6886b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 6896b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 6906b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 6916b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 6926b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 6955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 6965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 6975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 69803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 69903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 700ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 701ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 702ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 70303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 704a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 705ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 706ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 70703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 708ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 709ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 710ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 71103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 712a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 71303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 714ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 715ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 71603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 71703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 7181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 719a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 72003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 72103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 72203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 723fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 72403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 7255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 7265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 727d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 728b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor switch (CurLexerKind) { 729b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_Lexer: CurLexer->Lex(Result); break; 730b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_PTHLexer: CurPTHLexer->Lex(Result); break; 731b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_TokenLexer: CurTokenLexer->Lex(Result); break; 732b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_CachingLexer: CachingLex(Result); break; 733b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_LexAfterModuleImport: LexAfterModuleImport(Result); break; 734b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } 7355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 737b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor void LexAfterModuleImport(Token &Result); 738ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 73902a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \brief Lex a string literal, which may be the concatenation of multiple 74002a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// string literals and may even come from macro expansion. 74102a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \returns true on success, false if a error diagnostic has been generated. 74202a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool LexStringLiteral(Token &Result, std::string &String, 74397f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs const char *DiagnosticTag, bool AllowMacroExpansion) { 74402a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs if (AllowMacroExpansion) 74502a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs Lex(Result); 74602a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs else 74702a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs LexUnexpandedToken(Result); 74897f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs return FinishLexStringLiteral(Result, String, DiagnosticTag, 74997f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs AllowMacroExpansion); 75002a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs } 75102a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs 75202a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// \brief Complete the lexing of a string literal where the first token has 75302a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs /// already been lexed (see LexStringLiteral). 75402a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool FinishLexStringLiteral(Token &Result, std::string &String, 75597f8461a2c553f68a258612d2322e4281c3f0915Andy Gibbs const char *DiagnosticTag, 75602a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs bool AllowMacroExpansion); 75702a176871d91bba3004e4f94b2d4d588ae4b2122Andy Gibbs 7585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 7595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 7605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 761d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 7625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 7635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 7645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 7655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 766d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 7675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 7685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 769d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 7705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 7715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 7725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 7735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 7745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 7751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 7775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 7785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78088710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 78188710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 78288710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 78388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 78488710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 78588710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 78688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 78788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 7888c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie /// Disables macro expansion everywhere except for preprocessor directives. 7898c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie void SetMacroExpansionOnlyInDirectives() { 7908c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie DisableMacroExpansion = true; 7918c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie MacroExpansionInDirectivesOverride = true; 7928c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie } 7938c0b3787e7ccc7978b42dfbb84da2b802c743a5dDavid Blaikie 7946b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 7956b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 7966b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 7976b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 7986b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 79903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 80003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 80103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 80203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 80303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 8049e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 8053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 80608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 80708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 80808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 80908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 81008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 81108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 81208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 81308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 81408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 81508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 81608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 81708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 81808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 81908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 8203604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 8213604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 8223604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 8233604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 8243604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 8253604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 8263604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 8273604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 8283604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 8293604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 8303604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 8313604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 8323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 8333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 8343604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 8353604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 8363604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 83747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 83883cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 8393604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 8403604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 84139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 8421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 84339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 84439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 84539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 84639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 84739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 84839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 84939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 85039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 85139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 85239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 85339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 85439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 85539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 8560576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// TypoCorrectToken - Update the current token to represent the provided 8570576681bac125be07f77f66b02a3dba2c3a24557Richard Smith /// identifier, in order to cache an action performed by typo correction. 8580576681bac125be07f77f66b02a3dba2c3a24557Richard Smith void TypoCorrectToken(const Token &Tok) { 8590576681bac125be07f77f66b02a3dba2c3a24557Richard Smith assert(Tok.getIdentifierInfo() && "Expected identifier token"); 8600576681bac125be07f77f66b02a3dba2c3a24557Richard Smith if (CachedLexPos != 0 && isBacktrackEnabled()) 8610576681bac125be07f77f66b02a3dba2c3a24557Richard Smith CachedTokens[CachedLexPos-1] = Tok; 8620576681bac125be07f77f66b02a3dba2c3a24557Richard Smith } 8630576681bac125be07f77f66b02a3dba2c3a24557Richard Smith 864d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// \brief Recompute the current lexer kind based on the CurLexer/CurPTHLexer/ 865d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor /// CurTokenLexer pointers. 866d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor void recomputeCurLexerKind(); 867e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 868e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Returns true if incremental processing is enabled 869e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann bool isIncrementalProcessingEnabled() const { return IncrementalProcessing; } 870e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann 871e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann /// \brief Enables the incremental processing 872e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann void enableIncrementalProcessing(bool value = true) { 873e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann IncrementalProcessing = value; 874e55329d6834647ba0e06f8a319e5d84c77310035Axel Naumann } 875d6aba06861c41ccbc4926e5fe3cecd97b20410c0Douglas Gregor 8762968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 8772968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8782968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 8792968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 8802968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 8812968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 8822968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8832968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 8842968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8852968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8862968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 8872968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 8882968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8892968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 890a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 8912968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 8922968442603b029949246467253eeac8139a5b6d8Douglas Gregor 8933437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 8943437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 8953437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 8967d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the location of the code-completion point. 8977d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 8987d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 8997d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; } 9007d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 9017d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the start location of the file of code-completion point. 9027d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 9037d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 9047d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionFileLoc() const { 9057d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis return CodeCompletionFileLoc; 9067d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 9077d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 9087d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns true if code-completion is enabled and we have hit the 9097d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// code-completion point. 9107d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool isCodeCompletionReached() const { return CodeCompletionReached; } 9117d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 9127d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Note that we hit the code-completion point. 913d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer void setCodeCompletionReached() { 914d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer assert(isCodeCompletionEnabled() && "Code-completion not enabled!"); 915d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer CodeCompletionReached = true; 916d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer // Silence any diagnostics that occur after we hit the code-completion. 917d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer getDiagnostics().setSuppressAllDiagnostics(true); 918d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 9197d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 920809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief The location of the currently-active \#pragma clang 9218dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. Returns an invalid location if there 9228dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// is no such pragma active. 9238dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation getPragmaARCCFCodeAuditedLoc() const { 9248dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall return PragmaARCCFCodeAuditedLoc; 9258dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 9268dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 927809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Set the location of the currently-active \#pragma clang 9288dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. An invalid location ends the pragma. 9298dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc) { 9308dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall PragmaARCCFCodeAuditedLoc = Loc; 9318dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 9328dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 933809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Instruct the preprocessor to skip part of the main source file. 934f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 935809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param Bytes The number of bytes in the preamble to skip. 936f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 937809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \param StartOfLine Whether skipping these bytes puts the lexer at the 938f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 939ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 940f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 941f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 942f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 943ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 9445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 945d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 9465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 947d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const { 948d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Loc, DiagID); 949d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 9501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 951d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) const { 952d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer return Diags->Report(Tok.getLocation(), DiagID); 953d7a3e2c5f61cd4893f95b69a424fe4def3aa0f69Benjamin Kramer } 9541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 955834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 956834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 9579e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 95830900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 959834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 960834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 96130900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 962686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 963686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 964834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 9654e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(loc, buffer, SourceMgr, LangOpts, invalid); 966834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 96730900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 9685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 9695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 9705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 9715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 9725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 97350f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 97430900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 975b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 9764e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, SourceMgr, LangOpts, Invalid); 977b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 9780ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 9795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 9805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 9815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 9825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 9835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 9845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 9855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 9865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 9875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 9885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 989ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned getSpelling(const Token &Tok, const char *&Buffer, 99048cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 9914e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getSpelling(Tok, Buffer, SourceMgr, LangOpts, Invalid); 99248cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 993b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 994ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 995ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 996ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 997686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 998f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber SmallVectorImpl<char> &Buffer, 999f4fb07ed4dfd144a39d904fc77b3b0bab580eb2eNico Weber bool *Invalid = 0) const; 1000ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 1001d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis /// \brief Relex the token at the specified location. 1002d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis /// \returns true if there was a failure, false on success. 1003d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis bool getRawToken(SourceLocation Loc, Token &Result) { 1004d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis return Lexer::getRawToken(Loc, Result, SourceMgr, LangOpts); 1005d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis } 1006d93335c43fd462145fee3ea8f4d84d430577c821Argyrios Kyrtzidis 10077216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 10087216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 1009ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 101050f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 10117216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 10127216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 10137216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 10147216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 10157216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 10167216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 10177216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 101828396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 10197216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 10207216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 1021a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 102228396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 10231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1024c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// \brief Retrieve the name of the immediate macro expansion. 1025c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// 1026c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// This routine starts from a source location, and finds the name of the macro 1027c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// responsible for its immediate expansion. It looks through any intervening 1028c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// macro argument expansions to compute this. It returns a StringRef which 1029c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// refers to the SourceManager-owned buffer of the source where that macro 1030c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks /// name is spelled. Thus, the result shouldn't out-live the SourceManager. 1031c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks StringRef getImmediateMacroName(SourceLocation Loc) { 10324e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getImmediateMacroName(Loc, SourceMgr, getLangOpts()); 1033c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks } 1034c2a8d6cee01fc4845f5409bf5c021a64616ac8c3Anna Zaks 103547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 103647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 10379e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 1038374b3837d676133fcc1eb70a25c8baf8ec4a5c4aDmitri Gribenko void CreateString(StringRef Str, Token &Tok, 1039a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocStart = SourceLocation(), 1040a08529cc3f00e0b47a3c028823634129ac46847bAbramo Bagnara SourceLocation ExpansionLocEnd = SourceLocation()); 1041b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 1042b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 1043b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 1044b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 1045b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 1046b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 1047b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 1048b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 1049b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 1050b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 1051b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 105233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 105333e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 105433e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 105533e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 105633e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 10577ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 10584e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, LangOpts); 10597ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 10601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10617a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 10629e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 106369bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 106469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to 106569bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// begin location of the macro. 106669bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtStartOfMacroExpansion(SourceLocation loc, 106769bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroBegin = 0) const { 10684e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, LangOpts, 106969bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis MacroBegin); 10707a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 10717a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 10727a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 10739e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 107469bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// 1075ad0fe03b897f9486191e75c8d90c3ffa9b4fd6a5Ted Kremenek /// \param MacroEnd If non-null and function returns true, it is set to 107669bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis /// end location of the macro. 107769bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis bool isAtEndOfMacroExpansion(SourceLocation loc, 107869bda4c027671df7163619f215209529eb236620Argyrios Kyrtzidis SourceLocation *MacroEnd = 0) const { 10794e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, LangOpts, MacroEnd); 10807a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 10817a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 10825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 10835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1084d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 1085c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 10865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 10871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 108897ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 108997ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 1090872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 1091872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 10924e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, LangOpts); 1093872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 1094872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 10955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 10965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 10975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 10981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 10995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 11005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 11015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 11025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 11035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 11045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 11051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 11075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1108c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 1109c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 11103f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 11113f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 11123f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 11133f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 11141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 11165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 11175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 11185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1119c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 1120c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 1121c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 1122c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 11231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 112428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 112528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 112628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 112728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 112828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 112928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 113028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 113128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 113228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 113328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 113428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 113528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 113628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 113728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 113828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 113928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 114028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 114128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 114228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 114328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 114428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 114528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 114628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 114728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 114828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 114928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 1150ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except block 1151ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_code, 1152ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_code, 1153ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionCode; 1154ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __except filter expression 1155ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__exception_info, 1156ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___exception_info, 1157ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_GetExceptionInfo; 1158ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // __finally 1159ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie IdentifierInfo *Ident__abnormal_termination, 1160ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident___abnormal_termination, 1161ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie *Ident_AbnormalTermination; 116228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 116328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 116428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 11655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 11665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 11675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 11685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 1169d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 11705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 11735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 11745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 11755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 1176d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 11771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1178fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 1179fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 1180fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 11811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 11831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 11845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 11855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 1186d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 11875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 118884021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 118984021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 1190ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 1191ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 11921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1193478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 119484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 1195478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 11961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11977c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 11987c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 11997c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 12007c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 12017c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 1202c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 1203c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 12041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120590db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Retrieves the module that we're currently building, if any. 120690db26000aefe9335370013eec64c85232d80227Douglas Gregor Module *getCurrentModule(); 120790db26000aefe9335370013eec64c85232d80227Douglas Gregor 120858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object with the provided SourceLocation. 1209f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 1210f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 121158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Turn the specified lexer token into a fully checked and spelled 121258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// filename, e.g. as an operand of \#include. 121358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 121458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// The caller is expected to provide a buffer that is large enough to hold 121558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// the spelling of the filename, but is also expected to handle the case 121658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// when this method decides to use a different buffer. 121758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 121858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \returns true if the input filename was in <>'s or false if it was 121958bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// in ""'s. 1220686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 1221a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 122258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Given a "foo" or \<foo> reference, look up the indicated file. 122358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 122458bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// Returns null on failure. \p isAngled indicates whether the file 122558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// reference is for system \#include's or not (i.e. using <> instead of ""). 1226686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 1227f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 1228b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 1229686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 1230fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor SmallVectorImpl<char> *RelativePath, 12311a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor Module **SuggestedModule, 12321c2e9332fa69727425a3a2b912e36e2ab62083f8Douglas Gregor bool SkipCache = false); 1233a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1234a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 1235a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 123658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// implement \#include_next and find directory-specific properties. 1237a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 1238a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 123958bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Return true if we're in the top-level file, not in a \#include. 1240a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 1241a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 124258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// ConcatenateIncludeName - Handle cases where the \#include name is expanded 1243a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 1244a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 124558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \code 124670517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// \#define FOO <x/y.h> 124758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#include FOO 124858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \endcode 124970517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko /// because in this case, "<x/y.h>" is returned as 7 tokens, not one. 1250a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 1251321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 1252321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 125384021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 1254f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith bool ConcatenateIncludeName(SmallString<128> &FilenameBuffer, 1255ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 1256a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 12579d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 125884021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 12599d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 12609d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 12615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 12621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1263d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 1264b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeMacroStack.push_back(IncludeStackInfo(CurLexerKind, 1265b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexer.take(), 12669c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 12679c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 12689c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 12699c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 1270f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 1271d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1273d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 1274caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 12759c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 12769c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 1277caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 12789c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 1279b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexerKind = IncludeMacroStack.back().CurLexerKind; 1280d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 1281d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 12821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128358bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Allocate a new MacroInfo object. 1284f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 1285f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 12869818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis MacroDirective *AllocateMacroDirective(MacroInfo *MI, SourceLocation Loc, 12879818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis bool isImported); 12889818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis 128958bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Release the specified MacroInfo for re-use. 129058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// 129158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// This memory will be reused for allocating new MacroInfo objects. 12920301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 12931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 129558bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#define or \#undef. This emits a diagnostic, sets the token kind to eod, 12965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 1297d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 12981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 13005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 1301e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// closing ), updating MI with what we learn and saving in LastTok the 1302e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// last token read. 1303e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara /// Return true if an error occurs parsing the arg list. 1304e2e8768c290ceceb3ac2e369b5243f40d6c0e3e2Abramo Bagnara bool ReadMacroDefinitionArgList(MacroInfo *MI, Token& LastTok); 13051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 130658bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// We just read a \#if or related directive and decided that the 130758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// subsequent tokens are in the \#if'd out portion of the 130858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// file. Lex the rest of the file, until we see an \#endif. If \p 13095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 131058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// this \#if directive, so \#else/\#elif blocks should never be entered. If 131158bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \p FoundElse is false, then \#else directives are ok, if not, then we have 131258bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// already seen one so a \#else directive is a duplicate. When this returns, 13135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 13145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 13156b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis bool FoundNonSkipPortion, bool FoundElse, 13166b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis SourceLocation ElseLoc = SourceLocation()); 13171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 131858bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief A fast PTH version of SkipExcludedConditionalBlock. 1319268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 13201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 13225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 13235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 13245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 13251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 132758bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \#pragma GCC poison/system_header/dependency and \#pragma once. 13285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 13291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133058bf98725b6d4588338e191d2ab981b104471dabJames Dennett /// \brief Register builtin macros such as __LINE__ with the identifier table. 13315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 13321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 13345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 13355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1336d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 13371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13385b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 13395b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 13405b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 13415b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 13425b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 13435b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 13442d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 13455b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 13465b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 13475b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 13485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 13495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 13505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 13515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 13521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 13545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 13555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1356e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 13579e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 13585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 13605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1361d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 13621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 13645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 13655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1366d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 13671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13681ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 13691ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 13701ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 13711ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 13725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 13735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 13745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 13756137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 13766137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 13776137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 13786137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 13791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 138095d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis /// \brief Set the file ID for the preprocessor predefines. 138195d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis void setPredefinesFileID(FileID FID) { 138295d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis assert(PredefinesFileID.isInvalid() && "PredefinesFileID already set!"); 138395d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis PredefinesFileID = FID; 138495d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis } 138595d912c994832333a998bc7d4ae0e8e830a2d38bArgyrios Kyrtzidis 138634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 138734eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 138834eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 138934eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 139041938c8493b4380df738263166b746eacb33c309Ted Kremenek } 139141938c8493b4380df738263166b746eacb33c309Ted Kremenek 139281d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 139381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 139441938c8493b4380df738263166b746eacb33c309Ted Kremenek } 139541938c8493b4380df738263166b746eacb33c309Ted Kremenek 139681d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 139781d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 139841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 13991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 140103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 140203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 140303569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 140403569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 140503569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 1406ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 140756eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 140803569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 140903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 141003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 141103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 141203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 141303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 141403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 14153604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 141603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 141703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 14185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 14195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 14205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1421359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1422478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1423d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1424d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 142594ad28b31433058445a27db722f60402ee820beaDouglas Gregor void HandleMacroPublicDirective(Token &Tok); 1426aa93a875605536d72a10359a0098396192b7d4ecDouglas Gregor void HandleMacroPrivateDirective(Token &Tok); 1427ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 14285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1429ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1430ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 14315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 14325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1433ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1434ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1435ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 14364207edaf03da28fa917a94b31c5c1eef0e6417dcAaron Ballman void HandleMicrosoftImportDirective(Token &Tok); 14371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 143942e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1440d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 14419818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis void UndefineMacro(IdentifierInfo *II, MacroDirective *MD, 1442a8235d6c4093cd38dcf742909651f867de62e55bDouglas Gregor SourceLocation UndefLoc); 14431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1445d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 14465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1447d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1448d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1449d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1450d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 14511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 145380c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 14545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1455d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 14562243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1457d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1458d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1459d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1460636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1461abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1462f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1463f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 14644c55c54db8e676aa3e042188773d9d82d59fff91Aaron Ballman void HandlePragmaIncludeAlias(Token &Tok); 1465f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1466f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1467046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1468046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1469046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 14700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 14710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 14720827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 14730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 14745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 14755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 14772e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 14782e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 14792e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 14802e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 14811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1482046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1483046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1484046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 14852e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 14861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 14885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1490