Preprocessor.h revision 6aa52ec6b969faabf3764baf79d89810b8249a7e
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Preprocessor.h - C Language Family Preprocessor --------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Preprocessor interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_LEX_PREPROCESSOR_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_LEX_PREPROCESSOR_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 17af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek#include "clang/Lex/MacroInfo.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/Lexer.h" 199c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek#include "clang/Lex/PTHLexer.h" 20eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner#include "clang/Lex/PPCallbacks.h" 215d75de0f821023f4ed4815825bf3aea8a0b5e40dChris Lattner#include "clang/Lex/TokenLexer.h" 226137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek#include "clang/Lex/PTHManager.h" 231b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner#include "clang/Basic/Builtins.h" 24adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner#include "clang/Basic/Diagnostic.h" 25c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 27cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 284f32786ac45210143654390177105eb749b614e9Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 290827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/SmallPtrSet.h" 30caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek#include "llvm/ADT/OwningPtr.h" 31f4d5eb4866a27d497f0bb75b12c2ffd48ad4d9c0Benjamin Kramer#include "llvm/ADT/SmallVector.h" 325b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis#include "llvm/ADT/ArrayRef.h" 330ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek#include "llvm/Support/Allocator.h" 342e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor#include <vector> 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 3988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregorclass ExternalPreprocessorSource; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 452e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 49f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregorclass CodeCompletionHandler; 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 5194dc8f640ebea52241412512ed48601626edbc58Douglas Gregorclass PreprocessingRecord; 526aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregorclass ModuleLoader; 5394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 54e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 594f32786ac45210143654390177105eb749b614e9Ted Kremenekclass Preprocessor : public llvm::RefCountedBase<Preprocessor> { 60836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic *Diags; 61ba1e898c64048e25cb65afec3807ad463e41914bArgyrios Kyrtzidis LangOptions Features; 62444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &Target; 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 676aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader; 681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief External source of macros. 7088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *ExternalSource; 71a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 726aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 736137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// PTH - An optional PTHManager object used for getting tokens from 746137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// a token cache rather than lexing the original source file. 756137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek llvm::OwningPtr<PTHManager> PTH; 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 770ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// BP - A BumpPtrAllocator object used to quickly allocate and release 780ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// objects internal to the Preprocessor. 790ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek llvm::BumpPtrAllocator BP; 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 87c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner IdentifierInfo *Ident__COUNTER__; // __COUNTER__ 881ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident_Pragma, *Ident__pragma; // _Pragma, __pragma 891ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall IdentifierInfo *Ident__VA_ARGS__; // __VA_ARGS__ 90148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_feature; // __has_feature 91c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne IdentifierInfo *Ident__has_extension; // __has_extension 92148772a841cae6f32db16d890e788b92a763bb3fChris Lattner IdentifierInfo *Ident__has_builtin; // __has_builtin 93cae5095c116c29a4e52c91fa0ad88df09dd2b45fAnders Carlsson IdentifierInfo *Ident__has_attribute; // __has_attribute 9492bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include; // __has_include 9592bd8c70a6837b647a6c55964f8d0a50bf561dbcJohn Thompson IdentifierInfo *Ident__has_include_next; // __has_include_next 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 98c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned CounterValue; // Next __COUNTER__ value. 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1125814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1135814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1145814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1151d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1161d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1171d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 11888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 11988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 120a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 123c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12568d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 12668d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1279e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 12868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 13068d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 131083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 13229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1332e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1341b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1351b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1422e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1432e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 145f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 146f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 147f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 1482968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1492968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1502968442603b029949246467253eeac8139a5b6d8Douglas Gregor 151f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 152f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 153f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 154f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 155f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 156f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1589c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 1599c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 160caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 1611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1629c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 1639c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1649c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1659c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1679c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1689c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1699c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 17023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 1711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1776cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 1786cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 179caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1836cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1859c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 1869c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 1879c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 1881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1909c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 1919c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 1929c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 1939c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 1949c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TheDirLookup(D) {} 1955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 202cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 203cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 204cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 2051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2060827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 2070827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 2080827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 2090827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 2100827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 2110827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 2120827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 2130827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 2140827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 2150827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 21623f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 21723f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 21823f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 21923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 220f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 221f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 222f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// push_macro directive, we keep a MacroInfo stack used to restore 223f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 224f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 2251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2269e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief Expansion source location for the last macro that expanded 227b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// to no tokens. 2289e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation LastEmptyMacroExpansionLoc; 229b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 2371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 238aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 239aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 240aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 2411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2426cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 2436cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 2446cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 2456cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 2469e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 2475b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 2485b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 2495b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 2505b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 2515b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 252686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 2535b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 2545b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 2559e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 25694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// occurred during preprocessing. 25794dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 25894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 25994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 260b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 26194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 262e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 263686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 26403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 26503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 26603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 26703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 26803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 26903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 27003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 27103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 27203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 27303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 274a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 275a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 276a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 277a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 278a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 27903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 280af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 281af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 282af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 2839714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 284af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 285af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 286af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 287af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 288af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 289af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 2909714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 2919714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 2929714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 2939714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 294295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor MacroInfo *getInfoForMacro(IdentifierInfo *II) const; 295295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 2965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 297444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar Preprocessor(Diagnostic &diags, const LangOptions &opts, 298444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &target, 29972b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 3006aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 3015814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 3025814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch = false); 30372b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 3045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 306836040f9eafe862fb1607df5c30cd3df0c22c832Chris Lattner Diagnostic &getDiagnostics() const { return *Diags; } 3077c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner void setDiagnostics(Diagnostic &D) { Diags = &D; } 3087c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 3095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 310444be7366d0a1e172c0290a1ea54c1cb16b5947cDaniel Dunbar const TargetInfo &getTargetInfo() const { return Target; } 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 3125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 3135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 3145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 31629238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 3171b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 31832fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 3191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 320337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 3211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 322880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 3232e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 32488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 32588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 32688a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 327a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 32888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 32988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 33088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 331a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 3326aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 3336aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 3346aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 3467062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 3477062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 3485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 350a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 351a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 352a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 353a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 354a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 355321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 356321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 35868e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 360a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 361eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 362eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 3635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 364a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 365e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 366e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 370cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 371cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 372cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 373295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 374295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 375295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 376295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return getInfoForMacro(II); 377cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 379cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 380cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 381cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38309b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 38409b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// state of the macro table. This visits every currently-defined macro. 3851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 38609b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 38788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 38888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 389a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 3909e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief Expansion source location for the last macro that expanded 391b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis /// to no tokens. 3929e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation getLastEmptyMacroExpansionLoc() const { 3939e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth return LastEmptyMacroExpansionLoc; 394b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis } 395b7d98d35ea723624345f06e5895ddce2e0388ef0Argyrios Kyrtzidis 396e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 397aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 398aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 399aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 400aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 4011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 4035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 4045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 4055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 4065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 407686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 4083da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 4135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 414686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4159b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 416686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 4179b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4194095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 4204095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 4214095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 4224095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 423686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4249b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 425686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 4269b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4274095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 4282e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 4292e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void AddCommentHandler(CommentHandler *Handler); 4301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4312e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 4322e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 4332e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 4342e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void RemoveCommentHandler(CommentHandler *Handler); 4351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 436f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 437f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 438f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 439f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 440f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 4411fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 4421fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 4431fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 4441fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 4451fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor 446f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 447f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 448f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 449f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 450f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 45155817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 45255817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 45355817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 45455817afdf9d453a443262a733f6caf6692dca118Douglas Gregor 45594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 45694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 457b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 45894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 45994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Create a new preprocessing record, which will keep track of 46094dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 4619e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth void createPreprocessingRecord(bool IncludeNestedMacroExpansions); 46294dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 46353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 4647dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 465e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 4661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 467dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 468dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 469dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 470dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 4715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 472e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 473e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 474e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 475e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 4765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 4785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 4795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 480e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 481e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 482e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 483e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 4866b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 4876b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4886b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 4896b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 4906b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 4916b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4926b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 4936b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 4946b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 4956b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 4966b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 4976b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 4986b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 4991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 5015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 5025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 5035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 50403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 50503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 506ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 507ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 508ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 50903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 510a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 511ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 512ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 51303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 514ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 515ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 516ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 51703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 518a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 51903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 520ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 521ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 52203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 52303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 525a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 52603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 52703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 52803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 529fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 53003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 533d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 5345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 536f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek else if (CurPTHLexer) 537f6452c5421c5db5a7ceff581525f286931d97f1aTed Kremenek CurPTHLexer->Lex(Result); 5389e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis else if (CurTokenLexer) 5396cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner CurTokenLexer->Lex(Result); 54003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 54103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachingLex(Result); 5425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 5455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 547d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 5485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 5505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 5515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 552d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 5535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 5545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 555d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 5565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 5575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 5585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 5595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 5605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 5611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 5635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 5645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 56788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 56888710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 56988710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 57088710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 57188710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 57288710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 57388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 5746b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 5756b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 5766b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 5776b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 5786b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 57903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 58003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 58103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 58203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 58303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 5849e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 5853604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 58608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 58708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 58808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 58908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 59008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 59108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 59208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 59308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 59408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 59508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 59608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 59708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 59808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 59908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 6003604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 6013604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 6023604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 6033604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 6043604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 6053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 6063604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 6073604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 6083604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 6093604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 6103604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 6113604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 6123604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 6133604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 6143604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 6153604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 6163604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 61747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 61883cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 6193604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 6203604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 62139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 62339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 62439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 62539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 62639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 62739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 62839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 62939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 63039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 63139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 63239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 63339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 63439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 63539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6362968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 6372968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6382968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 6392968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 6402968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 6412968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 6422968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6432968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 6442968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6452968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6462968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 6472968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6482968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6492968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 650a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 6512968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 6522968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6532968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Determine if this source location refers into the file 6542968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// for which we are performing code completion. 655109ae73ec71a1d27358510ce049b59637b4a6b40Douglas Gregor bool isCodeCompletionFile(SourceLocation FileLoc) const; 6562968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6573437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 6583437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 6593437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 660f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Instruct the preprocessor to skip part of the main 661f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// the main source file. 662f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 663f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Bytes The number of bytes in the preamble to skip. 664f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 665f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief StartOfLine Whether skipping these bytes puts the lexer at the 666f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 667f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 668f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 669f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 670f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 671f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 673d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 6745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 675adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 67633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Loc, DiagID); 677adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 6781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 679adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 68033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Tok.getLocation(), DiagID); 681adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 683834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 684834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 6859e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 68630900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 687834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 688834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 68930900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 690686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 691686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 692834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 693834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall return Lexer::getSpelling(loc, buffer, SourceMgr, Features, invalid); 694834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 69530900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 6965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 6975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 6985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 6995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 7005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 70150f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 70230900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 703b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 704b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, SourceMgr, Features, Invalid); 705b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 7060ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 7075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 7085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 7095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 7105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 7115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 7125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 7135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 7145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 7155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 7165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 71750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getSpelling(const Token &Tok, const char *&Buffer, 71848cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 719b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, Buffer, SourceMgr, Features, Invalid); 72048cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 721b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 722ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 723ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 724ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 725686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 726686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Buffer, 72750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const; 728ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 7297216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 7307216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 73150f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 73250f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 7337216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 7347216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 7357216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 7367216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 7377216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 7387216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 7397216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 74028396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 7417216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 7427216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 743a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 74428396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 74747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 7489e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 74947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void CreateString(const char *Buf, unsigned Len, 75047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner Token &Tok, SourceLocation SourceLoc = SourceLocation()); 751b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 752b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 753b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 754b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 755b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 756b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 757b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 758b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 759b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 760b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 761b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 76233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 76333e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 76433e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 76533e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 76633e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 7677ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 7687ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, Features); 7697ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 7701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7717a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 7729e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 773433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth bool isAtStartOfMacroExpansion(SourceLocation loc) const { 774433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, Features); 7757a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 7767a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 7777a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 7789e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 779433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth bool isAtEndOfMacroExpansion(SourceLocation loc) const { 780433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, Features); 7817a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 7827a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 7835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 7845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 785d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 786c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 7875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 7881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78997ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 79097ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 791872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 792872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 7937ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, Features); 794872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 795872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 7965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 7975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 7985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 8005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 8015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 8025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 8035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 8045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 8055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 8061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 8085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 809c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 810c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 8113f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 8123f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 8133f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 8143f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 8151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 8175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 8185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 8195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 820c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 821c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 822c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 823c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 8241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 82628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 82728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 82828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 82928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 83028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 83128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 83228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 83328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 83428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 83528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 83628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 83728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 83828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 83928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 84028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 84128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 84228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 84328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 84428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 84528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 84628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 84728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 84828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 84928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 85028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 85128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_code, *Ident___exception_code, *Ident_GetExceptionCode; // __except block 85228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_info, *Ident___exception_info, *Ident_GetExceptionInfo; // __except filter expression 85328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__abnormal_termination, *Ident___abnormal_termination, *Ident_AbnormalTermination; // __finally 85428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 85528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 85628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 8575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 8585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 8595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 8605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 861d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 8625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 8655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 8665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 8675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 868d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 8691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 870fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 871fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 872fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 8731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 8751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 8765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 8775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 878d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 8795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 88084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 88184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 882ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 883ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 8841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 885478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 88684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 887478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 8881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8897c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 8907c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 8917c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 8927c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 8937c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 894c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 895c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 8961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 897f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 898f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// SourceLocation. 899f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 900f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 901f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// CloneMacroInfo - Allocate a new MacroInfo object which is clone of MI. 902f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 9031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 904a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 905a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// checked and spelled filename, e.g. as an operand of #include. This returns 906a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// true if the input filename was in <>'s or false if it were in ""'s. The 907a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// caller is expected to provide a buffer that is large enough to hold the 908a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// spelling of the filename, but is also expected to handle the case when 909a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// this method decides to use a different buffer. 910686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 911a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 912a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 913a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// return null on failure. isAngled indicates whether the file reference is 914a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// for system #include's or not (i.e. using <> instead of ""). 915686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 916f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 917b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 918686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 919686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *RelativePath); 920a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 921a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 922a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 923a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// implement #include_next and find directory-specific properties. 924a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 925a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 926a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// isInPrimaryFile - Return true if we're in the top-level file, not in a 927a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include. 928a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 929a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 930a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// ConcatenateIncludeName - Handle cases where the #include name is expanded 931a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 932a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 933a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #define FOO <a/b.h> 934a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include FOO 935a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 936a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 937321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 938321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 93984021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 940ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor bool ConcatenateIncludeName(llvm::SmallString<128> &FilenameBuffer, 941ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 942a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 9439d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 94484021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 9459d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 9469d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 9475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 9481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 949d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 9509c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 9519c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 9529c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 9539c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 9549c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 955f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 956d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 9571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 958d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 959caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 9609c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 9619c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 962caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 9639c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 964d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 965d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 9661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 967f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object. 968f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 969f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 9700ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 9710ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 9720301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 9731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 97584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// #define or #undef. This emits a diagnostic, sets the token kind to eod, 9765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 977d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 9781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 9805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 9815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 9825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 9835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 9841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 9865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 9875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 9885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 9895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 9905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 9915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 9925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 9935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 9945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 9951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 996268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 997268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 998268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 9991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 10015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 10025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 10035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 10041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 10065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 10075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 10081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 10105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 10115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 10121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 10145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 10155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1016d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 10171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10186aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Handle a module import directive. 10196aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor void HandleModuleImport(Token &Import); 10206aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 10215b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 10225b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 10235b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 10245b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 10255b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 10265b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 10272d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 10285b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 10295b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 10305b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 10315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 10325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 10335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 10345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 10351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 10375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 10385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1039e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 10409e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 10415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 10425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 10435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1044d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 10451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 10475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 10485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1049d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10511ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 10521ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 10531ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 10541ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 10555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 10565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 10575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 10586137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 10596137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 10606137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 10616137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 10621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 106334eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 106434eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 106534eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 106634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 106741938c8493b4380df738263166b746eacb33c309Ted Kremenek } 106841938c8493b4380df738263166b746eacb33c309Ted Kremenek 106981d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 107081d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 107141938c8493b4380df738263166b746eacb33c309Ted Kremenek } 107241938c8493b4380df738263166b746eacb33c309Ted Kremenek 107381d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 107481d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 107541938c8493b4380df738263166b746eacb33c309Ted Kremenek } 10761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 107803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 107903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 108003569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 108103569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 108203569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 108356eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 108456eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 108503569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 108603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 108703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 108803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 108903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 109003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 109103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 10923604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 109303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 109403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 10955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 10965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 10975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1098359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1099478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1100d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1101d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 11021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1104ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1105ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 11065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 11075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1108ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1109ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1110ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 11111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 111342e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1114d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 11151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1117d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 11185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1119d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1120d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1121d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1122d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 11231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 112580c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 11265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1127d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 11282243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1129d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1130d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1131d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1132636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1133abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1134f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1135f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 1136f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1137f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1138046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1139046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1140046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 11410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 11420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 11430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 11440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 11455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 11465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 11482e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 11492e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 11502e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 11512e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 11521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1153046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1154046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1155046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 11562e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 11571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 11595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1161