Preprocessor.h revision 8dfac0baaf0f81d3945bcb306480e358ba8d1f08
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> { 60d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine *Diags; 613e3cd93b2fd9644e970c389e715c13883faf68b6Douglas Gregor LangOptions &Features; 62998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor 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; 108f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool SuppressIncludeNotFoundError : 1; 109fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor bool AutoModuleImport : 1; 110fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1145814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar /// Whether the preprocessor owns the header search object. 1155814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar bool OwnsHeaderSearch : 1; 1165814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar 1171d9c54df56391ac4740db27d551782e81189cb51Chris Lattner /// DisableMacroExpansion - True if macro expansion is disabled. 1181d9c54df56391ac4740db27d551782e81189cb51Chris Lattner bool DisableMacroExpansion : 1; 1191d9c54df56391ac4740db27d551782e81189cb51Chris Lattner 12088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor /// \brief Whether we have already loaded macros from the external source. 12188a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor mutable bool ReadMacrosFromExternalSource : 1; 122a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 125c3222091e1ffa35d0264ca6b680a88c9dc84ede2Daniel Dunbar mutable IdentifierTable Identifiers; 1261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12768d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 12868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 1299e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// It is declared/expanded here because it's role/lifetime is 13068d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 1311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// flow (in clang::ParseAST()), make it convenient to put here. 13268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 133083abdf67f157e9d2ab5a8c9d5e71240479d3c99Sebastian Redl /// the lifetime of the preprocessor. 13429238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 1352e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 1361b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner /// BuiltinInfo - Information about builtins. 1371b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context BuiltinInfo; 1381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Tracks all of the comment handlers that the client registered 1442e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// with this preprocessor. 1452e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor std::vector<CommentHandler *> CommentHandlers; 1461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 147f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief The code-completion handler. 148f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeCompletionHandler *CodeComplete; 149f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 1502968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief The file that we're performing code-completion for, if any. 1512968442603b029949246467253eeac8139a5b6d8Douglas Gregor const FileEntry *CodeCompletionFile; 1522968442603b029949246467253eeac8139a5b6d8Douglas Gregor 1537d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The offset in file for the code-completion point. 1547d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis unsigned CodeCompletionOffset; 1557d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 1567d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The location for the code-completion point. This gets instantiated 1577d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// when the CodeCompletionFile gets #include'ed for preprocessing. 1587d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionLoc; 1597d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 1607d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief The start location for the file of the code-completion point. 1617d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// This gets instantiated when the CodeCompletionFile gets #include'ed 1627d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// for preprocessing. 1637d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation CodeCompletionFileLoc; 1647d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 165b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The source location of the __import_module__ keyword we just 166b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// lexed, if any. 167b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor SourceLocation ModuleImportLoc; 1688dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 1698dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The source location of the currently-active 1708dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// #pragma clang arc_cf_code_audited begin. 1718dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation PragmaARCCFCodeAuditedLoc; 172b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 1737d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief True if we hit the code-completion point. 1747d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool CodeCompletionReached; 1757d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 176f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief The number of bytes that we will initially skip when entering the 177f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// main file, which is used when loading a precompiled preamble, along 178f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// with a flag that indicates whether skipping this number of bytes will 179f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// place the lexer at the start of a line. 180f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor std::pair<unsigned, bool> SkipMainFilePreamble; 181f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 1839c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding a macro and we are lexing directly from source code. 1849c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 185caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<Lexer> CurLexer; 1861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1879c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer - This is the current top of stack that we're lexing from if 1889c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// not expanding from a macro and we are lexing from a PTH cache. 1899c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 1909c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek llvm::OwningPtr<PTHLexer> CurPTHLexer; 1911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1929c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPPLexer - This is the current top of the stack what we're lexing from 1939c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// if not expanding a macro. This is an alias for either CurLexer or 1949c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek /// CurPTHLexer. 19523f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner PreprocessorLexer *CurPPLexer; 196b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2026cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurTokenLexer - This is the current macro we are expanding, if we are 2036cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 204caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek llvm::OwningPtr<TokenLexer> CurTokenLexer; 2051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 206b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor /// \brief The kind of lexer we're currently working with. 207b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind { 208b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_Lexer, 209b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_PTHLexer, 210b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_TokenLexer, 211b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_CachingLexer, 212b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CLK_LexAfterModuleImport 213b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } CurLexerKind; 214b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 2176cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// CurLexer/CurTokenLexer. 2185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 219b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor enum CurLexerKind CurLexerKind; 2209c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek Lexer *TheLexer; 2219c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PTHLexer *ThePTHLexer; 2229c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek PreprocessorLexer *ThePPLexer; 2231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump TokenLexer *TheTokenLexer; 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 2259c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek 226b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeStackInfo(enum CurLexerKind K, Lexer *L, PTHLexer* P, 227b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor PreprocessorLexer* PPL, 2289c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek TokenLexer* TL, const DirectoryLookup *D) 229b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor : CurLexerKind(K), TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), 230b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor TheTokenLexer(TL), TheDirLookup(D) {} 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 2331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 2371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 238cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 239cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 240cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 2411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Macros that we want to warn because they are not used at the end 2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// of the translation unit; we store just their SourceLocations instead 2440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// something like MacroInfo*. The benefit of this is that when we are 2450827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// deserializing from PCH, we don't need to deserialize identifier & macros 2460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// just so that we can report that they are unused, we just warn using 2470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocations of this set (that will be filled by the ASTReader). 2480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// We are using SmallPtrSet instead of a vector for faster removal. 2490827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef llvm::SmallPtrSet<SourceLocation, 32> WarnUnusedMacroLocsTy; 2500827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis WarnUnusedMacroLocsTy WarnUnusedMacroLocs; 2510827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 25223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// MacroArgCache - This is a "freelist" of MacroArg objects that can be 25323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// reused for quick allocation. 25423f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *MacroArgCache; 25523f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner friend class MacroArgs; 256f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 257f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// PragmaPushMacroInfo - For each IdentifierInfo used in a #pragma 258f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// push_macro directive, we keep a MacroInfo stack used to restore 259f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// previous macro value. 260f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner llvm::DenseMap<IdentifierInfo*, std::vector<MacroInfo*> > PragmaPushMacroInfo; 2611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 2685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 2691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 270aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// Predefines - This string is the predefined macros that preprocessor 271aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// should use from the command line etc. 272aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner std::string Predefines; 2731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2746cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 2756cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner enum { TokenLexerCacheSize = 8 }; 2766cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner unsigned NumCachedTokenLexers; 2776cfe7594a46b5d270142cfcb688a9c1a3a487a48Chris Lattner TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 2789e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis 2795b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Keeps macro expanded tokens for TokenLexers. 2805b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 2815b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 2825b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 2835b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 284686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVector<Token, 16> MacroExpandedTokens; 2855b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis std::vector<std::pair<TokenLexer *, size_t> > MacroExpandingLexersStack; 2865b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 2879e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// \brief A record of the macro definitions and expansions that 28894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// occurred during preprocessing. 28994dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// 29094dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// This is an optional side structure that can be enabled with 29194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \c createPreprocessingRecord() prior to preprocessing. 292b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *Record; 29394dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 294e671e1bc73615eda155059a772266ed2882d758cChris Lattnerprivate: // Cached tokens state. 295686775deca8b8685eb90801495880e3abdd844c2Chris Lattner typedef SmallVector<Token, 1> CachedTokensTy; 29603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 29703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedTokens - Cached tokens are stored here when we do backtracking or 29803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// lookahead. They are "lexed" by the CachingLex() method. 29903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy CachedTokens; 30003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 30103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// CachedLexPos - The position of the cached token that CachingLex() should 30203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// "lex" next. If it points beyond the CachedTokens vector, it means that 30303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// a normal Lex() should be invoked. 30403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis CachedTokensTy::size_type CachedLexPos; 30503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 306a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// BacktrackPositions - Stack of backtrack positions, allowing nested 307a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 308a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// indicate where CachedLexPos should be set when the BackTrack() method is 309a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// invoked (at which point the last position is popped). 310a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis std::vector<CachedTokensTy::size_type> BacktrackPositions; 31103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 312af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek struct MacroInfoChain { 313af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfo MI; 314af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *Next; 3159714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *Prev; 316af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek }; 317af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 318af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// MacroInfos are managed as a chain for easy disposal. This is the head 319af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek /// of that list. 320af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek MacroInfoChain *MIChainHead; 321af8fa25c0d4e0540952a50bbd06dc1558954ccd9Ted Kremenek 3229714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 3239714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek /// allocation. 3249714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek MacroInfoChain *MICache; 3259714a2385cb66b6efa373fc668641de602dd9adbTed Kremenek 326295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor MacroInfo *getInfoForMacro(IdentifierInfo *II) const; 327295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 3285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 329d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie Preprocessor(DiagnosticsEngine &diags, LangOptions &opts, 330998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo *target, 33172b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek SourceManager &SM, HeaderSearch &Headers, 3326aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &TheModuleLoader, 3335814e657c9ad9ef6049a2a4af0d2aad248a8a15cDaniel Dunbar IdentifierInfoLookup *IILookup = 0, 334998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool OwnsHeaderSearch = false, 335998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor bool DelayInitialization = false); 33672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 339998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \brief Initialize the preprocessor, if the constructor did not already 340998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// perform the initialization. 341998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// 342998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor /// \param Target Information about the target. 343998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor void Initialize(const TargetInfo &Target); 344998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor 345d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return *Diags; } 346d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void setDiagnostics(DiagnosticsEngine &D) { Diags = &D; } 3477c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 3485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 349998b3d3e8528ebd9d2c5d78d3a82edd90a8953a4Douglas Gregor const TargetInfo &getTargetInfo() const { return *Target; } 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 3535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 35529238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 3561b63e4f732dbc73d90abf886b4d21f8e3a165f6dChris Lattner Builtin::Context &getBuiltinInfo() { return BuiltinInfo; } 35732fca722dd974b8202d0fb9c71b6c185c0767da6Chris Lattner llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 359337edcdbec05316b407d0d64865c88ff8597d910Ted Kremenek void setPTHManager(PTHManager* pm); 3601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 361880dcf21dfdb3ff763c60195b6794bab0d913095Ted Kremenek PTHManager *getPTHManager() { return PTH.get(); } 3622e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 36388a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor void setExternalSource(ExternalPreprocessorSource *Source) { 36488a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalSource = Source; 36588a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 366a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 36788a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor ExternalPreprocessorSource *getExternalSource() const { 36888a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor return ExternalSource; 36988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor } 370a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 3716aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor /// \brief Retrieve the module loader associated with this preprocessor. 3726aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor ModuleLoader &getModuleLoader() const { return TheModuleLoader; } 3736aa52ec6b969faabf3764baf79d89810b8249a7eDouglas Gregor 3745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 3755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 3765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 3775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 3785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 3795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 383f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman void SetSuppressIncludeNotFoundError(bool Suppress) { 384f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman SuppressIncludeNotFoundError = Suppress; 385f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 386f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 387f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman bool GetSuppressIncludeNotFoundError() { 388f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman return SuppressIncludeNotFoundError; 389f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman } 390f84139a1331c63c998e8b7d54148c75ac0b48ccdEli Friedman 391fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor /// \brief Specify whether automatic module imports are enabled. 392fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor void setAutoModuleImport(bool AutoModuleImport = true) { 393fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor this->AutoModuleImport = AutoModuleImport; 394fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor } 395fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 3975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 3987062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek bool isCurrentLexer(const PreprocessorLexer *L) const { 3997062d9e9fc3ed89c4e4ea7055efea6585b7bac8dTed Kremenek return CurPPLexer == L; 4005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 402a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// getCurrentLexer - Return the current lexer being lexed from. Note 403a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// that this ignores any potentially active macro expansions and _Pragma 404a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// expansions going on at the time. 405a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson PreprocessorLexer *getCurrentLexer() const { return CurPPLexer; } 406a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 407321c2688198f6f1a4086964e505f239683423cecChris Lattner /// getCurrentFileLexer - Return the current file lexer being lexed from. 408321c2688198f6f1a4086964e505f239683423cecChris Lattner /// Note that this ignores any potentially active macro expansions and _Pragma 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 41068e48e4a81767997ef0231e47eca4f665102c95eTed Kremenek PreprocessorLexer *getCurrentFileLexer() const; 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 412a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam /// getPPCallbacks/addPPCallbacks - Accessors for preprocessor callbacks. 413eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// Note that this class takes ownership of any PPCallbacks object given to 414eb50ed88c2aa040fac08bf2a50bde4dd3da6eb19Chris Lattner /// it. 4155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 416a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam void addPPCallbacks(PPCallbacks *C) { 417e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar if (Callbacks) 418e5393fb93eb879d9ebbef102ae9311fa77e023ccDaniel Dunbar C = new PPChainedCallbacks(C, Callbacks); 4195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 422cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 423cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 424cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 425295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor if (!II->hasMacroDefinition()) 426295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return 0; 427295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 428295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor return getInfoForMacro(II); 429cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 4301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 431cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 432cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 433cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 4341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43509b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 43609b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner /// state of the macro table. This visits every currently-defined macro. 4371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::DenseMap<IdentifierInfo*, 43809b5c1d08a33ecf5d9c61b922fbe679867336684Chris Lattner MacroInfo*>::const_iterator macro_iterator; 43988a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_begin(bool IncludeExternalMacros = true) const; 44088a35862fbe473f2a4f0c19f24dbe536937e1dc6Douglas Gregor macro_iterator macro_end(bool IncludeExternalMacros = true) const; 441a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam 442e3d5e3ae5bd8028774f07d7c3751d4db82118942Chris Lattner const std::string &getPredefines() const { return Predefines; } 443aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// setPredefines - Set the predefines for this Preprocessor. These 444aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner /// predefines are automatically injected when parsing the main file. 445aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const char *P) { Predefines = P; } 446aa39197431a0a0b1326ecf6b3be6a11f6e2f8503Chris Lattner void setPredefines(const std::string &P) { Predefines = P; } 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 4495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 4525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 453686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo *getIdentifierInfo(StringRef Name) const { 4543da736c1143126be19b253804b3b135ebcd3d6ffDaniel Dunbar return &Identifiers.get(Name); 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 4585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 460686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddPragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4619b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void AddPragmaHandler(PragmaHandler *Handler) { 462686775deca8b8685eb90801495880e3abdd844c2Chris Lattner AddPragmaHandler(StringRef(), Handler); 4639b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4654095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// RemovePragmaHandler - Remove the specific pragma handler from 4664095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// the preprocessor. If \arg Namespace is non-null, then it should 4674095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// be the namespace that \arg Handler was added to. It is an error 4684095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar /// to remove a handler that has not been registered. 469686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); 4709b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis void RemovePragmaHandler(PragmaHandler *Handler) { 471686775deca8b8685eb90801495880e3abdd844c2Chris Lattner RemovePragmaHandler(StringRef(), Handler); 4729b36c3f0de0105e903130bbda3c4aea7d792c0afArgyrios Kyrtzidis } 4734095080aff204008eefb26b100906c6ca2bc4bb6Daniel Dunbar 4742e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Add the specified comment handler to the preprocessor. 4752e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void AddCommentHandler(CommentHandler *Handler); 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4772e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// \brief Remove the specified comment handler. 4782e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// 4792e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor /// It is an error to remove a handler that has not been registered. 4802e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor void RemoveCommentHandler(CommentHandler *Handler); 4811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 482f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Set the code completion handler to the given object. 483f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void setCodeCompletionHandler(CodeCompletionHandler &Handler) { 484f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = &Handler; 485f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 486f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 4871fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor /// \brief Retrieve the current code-completion handler. 4881fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor CodeCompletionHandler *getCodeCompletionHandler() const { 4891fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor return CodeComplete; 4901fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor } 4911fbb447e9d43c2c676e94081fbfee7eb6cbe933bDouglas Gregor 492f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor /// \brief Clear out the code completion handler. 493f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor void clearCodeCompletionHandler() { 494f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor CodeComplete = 0; 495f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor } 496f44e854ed1e3aa86d2ed6d615ccd109d50ddcff9Douglas Gregor 49755817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// \brief Hook used by the lexer to invoke the "natural language" code 49855817afdf9d453a443262a733f6caf6692dca118Douglas Gregor /// completion point. 49955817afdf9d453a443262a733f6caf6692dca118Douglas Gregor void CodeCompleteNaturalLanguage(); 50055817afdf9d453a443262a733f6caf6692dca118Douglas Gregor 50194dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Retrieve the preprocessing record, or NULL if there is no 50294dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// preprocessing record. 503b9e1b75772db2c7db566c6034ba90a07f22e35ebDouglas Gregor PreprocessingRecord *getPreprocessingRecord() const { return Record; } 50494dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 50594dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// \brief Create a new preprocessing record, which will keep track of 50694dc8f640ebea52241412512ed48601626edbc58Douglas Gregor /// all macro expansions, macro definitions, etc. 5079e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth void createPreprocessingRecord(bool IncludeNestedMacroExpansions); 50894dc8f640ebea52241412512ed48601626edbc58Douglas Gregor 50953b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 5107dcc968f17a6ff9088c9651dddccc8d4025a1271Ted Kremenek /// which implicitly adds the builtin defines etc. 511e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterMainSourceFile(); 5121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 513dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// EndSourceFile - Inform the preprocessor callbacks that processing is 514dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar /// complete. 515dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar void EndSourceFile(); 516dbd8209b33e6c9f151e4913a9c095d64a95439c4Daniel Dunbar 5175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 518e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// start lexing tokens from it instead of the current buffer. Emit an error 519e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// and don't enter the file on error. 520e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir, 521e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc); 5225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 5245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 5255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 526e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// 527e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// ILEnd specifies the location of the ')' for a function-like macro or the 528e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// identifier for an object-like macro. 529e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 5301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 5326b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// which will cause the lexer to start returning the specified tokens. 5336b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5346b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If DisableMacroExpansion is true, tokens lexed from the token stream will 5356b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// not be subject to further macro expansion. Otherwise, these tokens will 5366b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// be re-macro-expanded when/if expansion is enabled. 5376b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5386b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If OwnsTokens is false, this method assumes that the specified stream of 5396b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// tokens has a permanent owner somewhere, so they do not need to be copied. 5406b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// If it is true, it assumes the array of tokens is allocated with new[] and 5416b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// must be freed. 5426b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 5436b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks, 5446b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner bool DisableMacroExpansion, bool OwnsTokens); 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 5475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 5485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 55003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 55103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// EnableBacktrackAtThisPos - From the point that this method is called, and 552ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 553ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 554ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// make the Preprocessor re-lex the same tokens. 55503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 556a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 557ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 558ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 55903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 560ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 561ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 562ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// tokens will continue indefinitely. 56303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// 564a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void EnableBacktrackAtThisPos(); 56503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 566ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 567ed5c38682c056c147c8a4abb748b4f285de206ddArgyrios Kyrtzidis void CommitBacktrackedTokens(); 56803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 56903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// EnableBacktrackAtThisPos() was previously called. 571a9e274c01ebae45629d93aaa07be450fb77dd3cbArgyrios Kyrtzidis void Backtrack(); 57203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 57303db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 57403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis /// caching of tokens is on. 575fad03b2b38a3baea4b67e79e676fee15078e3258Argyrios Kyrtzidis bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 57603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 5775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 5785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 579d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 580b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor switch (CurLexerKind) { 581b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_Lexer: CurLexer->Lex(Result); break; 582b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_PTHLexer: CurPTHLexer->Lex(Result); break; 583b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_TokenLexer: CurTokenLexer->Lex(Result); break; 584b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_CachingLexer: CachingLex(Result); break; 585b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor case CLK_LexAfterModuleImport: LexAfterModuleImport(Result); break; 586b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor } 5875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 589b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor void LexAfterModuleImport(Token &Result); 590b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor 5915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 5925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 5935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 594d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 5955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 5965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 5975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 5985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 599d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek 6005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 6015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 602d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 6035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 6075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 6081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 6105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 6115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61388710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// LexUnexpandedNonComment - Like LexNonComment, but this disables macro 61488710f22be1acb04b7d812aebe87bea56394c07cEli Friedman /// expansion of identifier tokens. 61588710f22be1acb04b7d812aebe87bea56394c07cEli Friedman void LexUnexpandedNonComment(Token &Result) { 61688710f22be1acb04b7d812aebe87bea56394c07cEli Friedman do 61788710f22be1acb04b7d812aebe87bea56394c07cEli Friedman LexUnexpandedToken(Result); 61888710f22be1acb04b7d812aebe87bea56394c07cEli Friedman while (Result.getKind() == tok::comment); 61988710f22be1acb04b7d812aebe87bea56394c07cEli Friedman } 62088710f22be1acb04b7d812aebe87bea56394c07cEli Friedman 6216b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// LookAhead - This peeks ahead N tokens and returns that token without 6226b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// consuming any tokens. LookAhead(0) returns the next token that would be 6236b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 6246b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// returns normal tokens after phase 5. As such, it is equivalent to using 6256b884508c3bc97cc9df9516adb92fbf88dd0a2e4Chris Lattner /// 'Lex', not 'LexUnexpandedToken'. 62603db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &LookAhead(unsigned N) { 62703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (CachedLexPos + N < CachedTokens.size()) 62803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return CachedTokens[CachedLexPos+N]; 62903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis else 63003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis return PeekAhead(N+1); 6319e0ed0bd5a3a7bac73973980ff32132a7724e674Argyrios Kyrtzidis } 6323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 63308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 63408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// this allows to revert a specific number of tokens. 63508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// Note that the number of tokens being reverted should be up to the last 63608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis /// backtrack position, not more. 63708b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis void RevertCachedTokens(unsigned N) { 63808b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(isBacktrackEnabled() && 63908b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Should only be called when tokens are cached for backtracking"); 64008b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 64108b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis && "Should revert tokens up to the last backtrack position, not more"); 64208b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis assert(signed(CachedLexPos) - signed(N) >= 0 && 64308b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis "Corrupted backtrack positions ?"); 64408b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis CachedLexPos -= N; 64508b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis } 64608b2c3743a29a2dddcf72e95f747760e213cdde7Argyrios Kyrtzidis 6473604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// EnterToken - Enters a token in the token stream to be lexed next. If 6483604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// BackTrack() is called afterwards, the token will remain at the insertion 6493604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// point. 6503604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void EnterToken(const Token &Tok) { 6513604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis EnterCachingLexMode(); 6523604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 6533604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 6543604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 6553604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 6563604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// tokens (because backtrack is enabled) it should replace the most recent 6573604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens with the given annotation token. This function has no effect 6583604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// if backtracking is not enabled. 6593604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// 6603604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// Note that the use of this function is just for optimization; so that the 6613604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 6623604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// invoked. 6633604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotateCachedTokens(const Token &Tok) { 66447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(Tok.isAnnotation() && "Expected annotation token"); 66583cf05a3b0e655dc8ea1cb4c4e1eef541b770992Chris Lattner if (CachedLexPos != 0 && isBacktrackEnabled()) 6663604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis AnnotatePreviousCachedTokens(Tok); 6673604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 66839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// \brief Replace the last token with an annotation token. 67039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// 67139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// Like AnnotateCachedTokens(), this routine replaces an 67239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// already-parsed (and resolved) token with an annotation 67339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// token. However, this routine only replaces the last token with 67439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// the annotation token; it does not affect any other cached 67539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// tokens. This function has no effect if backtracking is not 67639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// enabled. 67739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void ReplaceLastTokenWithAnnotation(const Token &Tok) { 67839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor assert(Tok.isAnnotation() && "Expected annotation token"); 67939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor if (CachedLexPos != 0 && isBacktrackEnabled()) 68039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor CachedTokens[CachedLexPos-1] = Tok; 68139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 68239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 6832968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Specify the point at which code-completion will be performed. 6842968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6852968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param File the file in which code completion should occur. If 6862968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// this file is included multiple times, code-completion will 6872968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// perform completion the first time it is included. If NULL, this 6882968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// function clears out the code-completion point. 6892968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6902968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Line the line at which code completion should occur 6912968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6922968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6932968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Column the column at which code completion should occur 6942968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// (1-based). 6952968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6962968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \returns true if an error occurred, false otherwise. 697a5d10c4df435964600e104ebef6a96b106e416b7Kovarththanan Rajaratnam bool SetCodeCompletionPoint(const FileEntry *File, 6982968442603b029949246467253eeac8139a5b6d8Douglas Gregor unsigned Line, unsigned Column); 6992968442603b029949246467253eeac8139a5b6d8Douglas Gregor 7003437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis /// \brief Determine if we are performing code completion. 7013437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis bool isCodeCompletionEnabled() const { return CodeCompletionFile != 0; } 7023437f1f1294499d4ef306c1089fcb3e29ec2aa68Argyrios Kyrtzidis 7037d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the location of the code-completion point. 7047d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 7057d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 7067d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionLoc() const { return CodeCompletionLoc; } 7077d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7087d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns the start location of the file of code-completion point. 7097d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// Returns an invalid location if code-completion is not enabled or the file 7107d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// containing the code-completion point has not been lexed yet. 7117d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis SourceLocation getCodeCompletionFileLoc() const { 7127d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis return CodeCompletionFileLoc; 7137d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 7147d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7157d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Returns true if code-completion is enabled and we have hit the 7167d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// code-completion point. 7177d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis bool isCodeCompletionReached() const { return CodeCompletionReached; } 7187d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7197d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis /// \brief Note that we hit the code-completion point. 7207d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis void setCodeCompletionReached() { 7217d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis assert(isCodeCompletionEnabled() && "Code-completion not enabled!"); 7227d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis CodeCompletionReached = true; 7237d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis // Silence any diagnostics that occur after we hit the code-completion. 7247d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis getDiagnostics().setSuppressAllDiagnostics(true); 7257d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis } 7267d100872341f233c81e1d7b72b40457e62c36862Argyrios Kyrtzidis 7278dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief The location of the currently-active #pragma clang 7288dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. Returns an invalid location if there 7298dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// is no such pragma active. 7308dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall SourceLocation getPragmaARCCFCodeAuditedLoc() const { 7318dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall return PragmaARCCFCodeAuditedLoc; 7328dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 7338dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 7348dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// \brief Set the location of the currently-active #pragma clang 7358dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall /// arc_cf_code_audited begin. An invalid location ends the pragma. 7368dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall void setPragmaARCCFCodeAuditedLoc(SourceLocation Loc) { 7378dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall PragmaARCCFCodeAuditedLoc = Loc; 7388dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall } 7398dfac0baaf0f81d3945bcb306480e358ba8d1f08John McCall 740f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Instruct the preprocessor to skip part of the main 741f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// the main source file. 742f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 743f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Bytes The number of bytes in the preamble to skip. 744f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// 745f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief StartOfLine Whether skipping these bytes puts the lexer at the 746f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// start of a line. 747f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor void setSkipMainFilePreamble(unsigned Bytes, bool StartOfLine) { 748f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.first = Bytes; 749f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor SkipMainFilePreamble.second = StartOfLine; 750f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 751f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 7525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 753d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 7545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 755adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 75633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Loc, DiagID); 757adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 7581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 759adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 76033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->Report(Tok.getLocation(), DiagID); 761adc4eeb08042a35ae914fc557ffec0cef3df2374Chris Lattner } 7621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 763834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// getSpelling() - Return the 'spelling' of the token at the given 764834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// location; does not go up to the spelling location or down to the 7659e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// expansion location. 76630900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// 767834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// \param buffer A buffer which will be used only if the token requires 768834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall /// "cleaning", e.g. if it contains trigraphs or escaped newlines 76930900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param invalid If non-null, will be set \c true if an error occurs. 770686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(SourceLocation loc, 771686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &buffer, 772834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall bool *invalid = 0) const { 773834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall return Lexer::getSpelling(loc, buffer, SourceMgr, Features, invalid); 774834e3f6c77d9ac03997a3f0c56934edcf406a355John McCall } 77530900dafbe972f4802c2663262b4393edab0d1cdJohn McCall 7765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 7775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 7785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 7795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 7805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 78150f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 78230900dafbe972f4802c2663262b4393edab0d1cdJohn McCall /// \param Invalid If non-null, will be set \c true if an error occurs. 783b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner std::string getSpelling(const Token &Tok, bool *Invalid = 0) const { 784b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, SourceMgr, Features, Invalid); 785b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner } 7860ff1042ddaad1419264be0de6da17f3b378482a4Daniel Dunbar 7875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 7885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 7895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 7905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 7915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 7925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 7935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 7945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 7955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 7965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 79750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getSpelling(const Token &Tok, const char *&Buffer, 79848cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner bool *Invalid = 0) const { 799b0607279cb98bbf2bbfe0db170aed39ef91e86a2Chris Lattner return Lexer::getSpelling(Tok, Buffer, SourceMgr, Features, Invalid); 80048cf9824fbad42995f4d91d59d08d2620effd683Chris Lattner } 801b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 802ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// getSpelling - This method is used to get the spelling of a token into a 803ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// SmallVector. Note that the returned StringRef may not point to the 804ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer /// supplied buffer if a copy can be avoided. 805686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getSpelling(const Token &Tok, 806686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Buffer, 80750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const; 808ddeea5644367c9c153c9fee9e51bdea85ce43cbdBenjamin Kramer 8097216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 8107216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner /// with length 1, return the character. 81150f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor char getSpellingOfSingleCharacterNumericConstant(const Token &Tok, 81250f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const { 8137216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(Tok.is(tok::numeric_constant) && 8147216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner Tok.getLength() == 1 && "Called on unsupported token"); 8157216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 8167216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner 8177216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // If the token is carrying a literal data pointer, just use it. 8187216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner if (const char *D = Tok.getLiteralData()) 8197216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner return *D; 82028396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek 8217216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // Otherwise, fall back on getCharacterData, which is slower, but always 8227216dc9cb49f47254595120cf15a737cee53f0bdChris Lattner // works. 823a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor return *SourceMgr.getCharacterData(Tok.getLocation(), Invalid); 82428396608ec20d44e9d1470e1ea51689bb504d0deTed Kremenek } 8251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// CreateString - Plop the specified string into a scratch buffer and set the 82747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// specified token's location and length to it. If specified, the source 8289e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// location provides a location of the expansion point of the token. 82947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void CreateString(const char *Buf, unsigned Len, 83047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner Token &Tok, SourceLocation SourceLoc = SourceLocation()); 831b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor 832b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// \brief Computes the source location just past the end of the 833b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token at this source location. 834b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// 835b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// This routine can be used to produce a source location that 836b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// points just past the end of the token referenced by \p Loc, and 837b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// is generally used when a diagnostic needs to point just after a 838b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// token where it expected something different that it received. If 839b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// the returned source location would not be meaningful (e.g., if 840b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// it points into a macro), this routine returns an invalid 841b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor /// source location. 84233e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// 84333e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// \param Offset an offset from the end of the token, where the source 84433e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location should refer to. The default offset (0) produces a source 84533e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// location pointing just past the end of the token; an offset of 1 produces 84633e9abd21083a0191a7676a04b497006d2da184dDouglas Gregor /// a source location pointing to the last character in the token, etc. 8477ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset = 0) { 8487ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::getLocForEndOfToken(Loc, Offset, SourceMgr, Features); 8497ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner } 8501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8517a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the first 8529e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 853433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth bool isAtStartOfMacroExpansion(SourceLocation loc) const { 854433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth return Lexer::isAtStartOfMacroExpansion(loc, SourceMgr, Features); 8557a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 8567a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 8577a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the last 8589e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth /// token of the macro expansion. 859433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth bool isAtEndOfMacroExpansion(SourceLocation loc) const { 860433db06b614f26dc6829e86d6ff469e2cca7d4f9Chandler Carruth return Lexer::isAtEndOfMacroExpansion(loc, SourceMgr, Features); 8617a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis } 8627a759606d93975866051f67104ae58446e55f404Argyrios Kyrtzidis 8635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 8645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 865d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 866c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 8675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 8681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 86997ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 87097ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 871872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart, 872872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner unsigned Char) const { 8737ef5c27eb6e8ebe58b52013246c06753c3613263Chris Lattner return Lexer::AdvanceToTokenCharacter(TokStart, Char, SourceMgr, Features); 874872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner } 875872a45e91778eb0b706ff57272fe547d4512eb19Chris Lattner 8765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 8775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 8785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 8791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 8805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 8815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 8825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 8835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 8845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 8855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 8861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 8885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 889c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis size_t getTotalMemory() const; 890c5c5e92ec53f7e6ac7ebbbf77c6d8e4b7d88daecArgyrios Kyrtzidis 8913f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 8923f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// comment (/##/) in microsoft mode, this method handles updating the current 8933f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner /// state, returning the token on the next source line. 8943f1cc838f9caf469990f23fccd0940263c0c61ffChris Lattner void HandleMicrosoftCommentPaste(Token &Tok); 8951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 8975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 8985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 8995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 900c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the 901c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// identifier information for the token and install it into the token, 902c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// updating the token kind accordingly. 903c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara IdentifierInfo *LookUpIdentifierInfo(Token &Identifier) const; 9041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 90528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 90628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley llvm::DenseMap<IdentifierInfo*,unsigned> PoisonReasons; 90728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 90828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 90928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 91028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // SetPoisonReason - Call this function to indicate the reason for 91128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoning an identifier. If that identifier is accessed while 91228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // poisoned, then this reason will be used instead of the default 91328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // "poisoned" diagnostic. 91428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void SetPoisonReason(IdentifierInfo *II, unsigned DiagID); 91528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 91628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // HandlePoisonedIdentifier - Display reason for poisoned 91728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley // identifier. 91828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void HandlePoisonedIdentifier(Token & Tok); 91928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 92028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void MaybeHandlePoisonedIdentifier(Token & Identifier) { 92128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(IdentifierInfo * II = Identifier.getIdentifierInfo()) { 92228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II->isPoisoned()) { 92328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley HandlePoisonedIdentifier(Identifier); 92428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 92528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 92628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 92728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 92828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyprivate: 92928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// Identifiers used for SEH handling in Borland. These are only 93028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley /// allowed in particular circumstances 93128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_code, *Ident___exception_code, *Ident_GetExceptionCode; // __except block 93228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__exception_info, *Ident___exception_info, *Ident_GetExceptionInfo; // __except filter expression 93328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *Ident__abnormal_termination, *Ident___abnormal_termination, *Ident_AbnormalTermination; // __finally 93428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 93528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley void PoisonSEHIdentifiers(bool Poison = true); // Borland 93628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 9375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 9385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 9395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 9405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 941d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 9425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 9455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 9465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 9475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 948d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 9491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 950fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// HandleEndOfTokenLexer - This callback is invoked when the current 951fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner /// TokenLexer hits the end of its token stream. 952fde2bf9befede63e3f01f84519784c17b4c81480Chris Lattner bool HandleEndOfTokenLexer(Token &Result); 9531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 9551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// at the start of a line. This consumes the directive, modifies the 9565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 9575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 958d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 9595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 96084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 96184021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// not, emit a diagnostic and consume up until the eod. If EnableMacros is 962ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner /// true, then we consider macros that expand to zero tokens as being ok. 963ab82f41b217ce588a9456c0b4411f219d3ed0df8Chris Lattner void CheckEndOfDirective(const char *Directive, bool EnableMacros = false); 9641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 965478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 96684021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// current line until the tok::eod token is found. 967478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void DiscardUntilEndOfDirective(); 9681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9697c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// SawDateOrTime - This returns true if the preprocessor has seen a use of 9707c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner /// __DATE__ or __TIME__ in the file so far. 9717c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner bool SawDateOrTime() const { 9727c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner return DATELoc != SourceLocation() || TIMELoc != SourceLocation(); 9737c5d24efcd2e505b5739f7def08dfe25ce59a1b2Chris Lattner } 974c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner unsigned getCounterValue() const { return CounterValue; } 975c1f9d828c733ec1eba06d01070735d1f36fda733Chris Lattner void setCounterValue(unsigned V) { CounterValue = V; } 9761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 977f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 978f908c519c1625e81d9e33d8a2a306a92834fe317Chris Lattner /// SourceLocation. 979f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(SourceLocation L); 980f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 981f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// CloneMacroInfo - Allocate a new MacroInfo object which is clone of MI. 982f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *CloneMacroInfo(const MacroInfo &MI); 9831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 984a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 985a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// checked and spelled filename, e.g. as an operand of #include. This returns 986a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// true if the input filename was in <>'s or false if it were in ""'s. The 987a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// caller is expected to provide a buffer that is large enough to hold the 988a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// spelling of the filename, but is also expected to handle the case when 989a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// this method decides to use a different buffer. 990686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc,StringRef &Filename); 991a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 992a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 993a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// return null on failure. isAngled indicates whether the file reference is 994a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// for system #include's or not (i.e. using <> instead of ""). 995686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const FileEntry *LookupFile(StringRef Filename, 996f45b646244705410866d62f1d8bf017a047ed662Chris Lattner bool isAngled, const DirectoryLookup *FromDir, 997b5142bb7af5c70fffd09f05172a1379a35a9c29aChandler Carruth const DirectoryLookup *&CurDir, 998686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> *SearchPath, 999fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor SmallVectorImpl<char> *RelativePath, 1000fba18aa8f2cd1994dc65e8cb9f4be201c560dc0bDouglas Gregor StringRef *SuggestedModule); 1001a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1002a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// GetCurLookup - The DirectoryLookup structure used to find the current 1003a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 1004a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// implement #include_next and find directory-specific properties. 1005a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson const DirectoryLookup *GetCurDirLookup() { return CurDirLookup; } 1006a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1007a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// isInPrimaryFile - Return true if we're in the top-level file, not in a 1008a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include. 1009a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson bool isInPrimaryFile() const; 1010a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 1011a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// ConcatenateIncludeName - Handle cases where the #include name is expanded 1012a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// from a macro as multiple tokens, which need to be glued together. This 1013a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// occurs for code like: 1014a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #define FOO <a/b.h> 1015a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// #include FOO 1016a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 1017a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson /// 1018321c2688198f6f1a4086964e505f239683423cecChris Lattner /// This code concatenates and consumes tokens up to the '>' token. It 1019321c2688198f6f1a4086964e505f239683423cecChris Lattner /// returns false if the > was found, otherwise it returns true if it finds 102084021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// and consumes the EOD marker. 1021ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor bool ConcatenateIncludeName(llvm::SmallString<128> &FilenameBuffer, 1022ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor SourceLocation &End); 1023a28cc090f265d5bdaef9ebb24fb9d579928d3a18John Thompson 10249d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne /// LexOnOffSwitch - Lex an on-off-switch (C99 6.10.6p2) and verify that it is 102584021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// followed by EOD. Return true if the token is not a valid on-off-switch. 10269d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne bool LexOnOffSwitch(tok::OnOffSwitch &OOS); 10279d3f5f7550a2fab4178ed01425758c349b73a609Peter Collingbourne 10285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 10291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1030d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PushIncludeMacroStack() { 1031b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor IncludeMacroStack.push_back(IncludeStackInfo(CurLexerKind, 1032b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexer.take(), 10339c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.take(), 10349c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer, 10359c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurTokenLexer.take(), 10369c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup)); 1037f89963b1e819d5e73796a4f9d7cd70129846e2ecTed Kremenek CurPPLexer = 0; 1038d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 10391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1040d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek void PopIncludeMacroStack() { 1041caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurLexer.reset(IncludeMacroStack.back().TheLexer); 10429c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 10439c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurPPLexer = IncludeMacroStack.back().ThePPLexer; 1044caaa7df2c78bbd40197823034c0275f3dcbd63e7Ted Kremenek CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 10459c1b750c59d510e6c9eccb1f37bccc46ccfe6844Ted Kremenek CurDirLookup = IncludeMacroStack.back().TheDirLookup; 1046b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor CurLexerKind = IncludeMacroStack.back().CurLexerKind; 1047d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek IncludeMacroStack.pop_back(); 1048d038def6e3f33bebf8c12bb3a95b2492c154a5ddTed Kremenek } 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1050f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner /// AllocateMacroInfo - Allocate a new MacroInfo object. 1051f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner MacroInfo *AllocateMacroInfo(); 1052f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 10530ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 10540ea76727ae91bca918a8414ed85b530eddcfedebTed Kremenek /// be reused for allocating new MacroInfo objects. 10550301b3ff132a4d986c092d161cb77d74b04cd2a6Chris Lattner void ReleaseMacroInfo(MacroInfo* MI); 10561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 105884021556baceb76eedf7d44be8ba71d9b8cfaccePeter Collingbourne /// #define or #undef. This emits a diagnostic, sets the token kind to eod, 10595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 1060d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 10611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 10635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 10645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 10655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 10665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 10671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 10695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 10705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 10715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 10725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 10735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 10745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 10755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 10765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 10776b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis bool FoundNonSkipPortion, bool FoundElse, 10786b4ff04dd22e7159887ea6c1bb8b1c01fc9c70a9Argyrios Kyrtzidis SourceLocation ElseLoc = SourceLocation()); 10791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1080268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// PTHSkipExcludedConditionalBlock - A fast PTH version of 1081268ee7016a2811803989487c0ad3799486092c63Ted Kremenek /// SkipExcludedConditionalBlock. 1082268ee7016a2811803989487c0ad3799486092c63Ted Kremenek void PTHSkipExcludedConditionalBlock(); 10831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 10855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 10865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 10875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 10881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 10905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 10915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 10921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 10945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 10955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 10961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 10985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 10995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 1100d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 11011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11025b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// \brief Cache macro expanded tokens for TokenLexers. 11035b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis // 11045b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 11055b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// going to lex in the cache and when it finishes the tokens are removed 11065b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis /// from the end of the cache. 11075b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis Token *cacheMacroExpandedTokens(TokenLexer *tokLexer, 11082d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<Token> tokens); 11095b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis void removeCachedMacroExpandedTokensOfLastLexer(); 11105b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis friend void TokenLexer::ExpandFunctionArguments(); 11115b3284a9275a27f5c4410e25eb8933be540601d6Argyrios Kyrtzidis 11125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 11135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 11145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 11155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 11161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 11185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 11195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 1120e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 11219e5bb85ac899eeab7c21b5ff9030c3da6ff4837bChandler Carruth SourceLocation &ExpansionEnd); 11225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 11235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 11245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 1125d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 11261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 11285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 11295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 1130d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 11311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11321ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text 11331ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall /// is not enclosed within a string literal. 11341ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall void HandleMicrosoft__pragma(Token &Tok); 11351ef8a2e7675f3d8b6e8d9963b00378086e1dcdc7John McCall 11365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 11375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 11385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 11396137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek 11406137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 11416137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek /// start getting tokens from it using the PTH cache. 11426137dc99ef0c2b14050631367057758b0d596cb3Ted Kremenek void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 11431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 114434eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// IsFileLexer - Returns true if we are lexing from a file and not a 114534eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek /// pragma or a macro. 114634eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 114734eaa24e6c2dc72bbbd5ad09694368cfd09c5f14Ted Kremenek return L ? !L->isPragmaLexer() : P != 0; 114841938c8493b4380df738263166b746eacb33c309Ted Kremenek } 114941938c8493b4380df738263166b746eacb33c309Ted Kremenek 115081d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek static bool IsFileLexer(const IncludeStackInfo& I) { 115181d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(I.TheLexer, I.ThePPLexer); 115241938c8493b4380df738263166b746eacb33c309Ted Kremenek } 115341938c8493b4380df738263166b746eacb33c309Ted Kremenek 115481d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek bool IsFileLexer() const { 115581d24e135c60dcbe421864e6a4334ba99b8fe7ecTed Kremenek return IsFileLexer(CurLexer.get(), CurPPLexer); 115641938c8493b4380df738263166b746eacb33c309Ted Kremenek } 11571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 115903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis // Caching stuff. 116003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void CachingLex(Token &Result); 116103569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis bool InCachingLexMode() const { 116203569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // If the Lexer pointers are 0 and IncludeMacroStack is empty, it means 116303569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis // that we are past EOF, not that we are in CachingLex mode. 116456eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek return CurPPLexer == 0 && CurTokenLexer == 0 && CurPTHLexer == 0 && 116556eb1ec6e54080e47bbc62412737c25afb5211edTed Kremenek !IncludeMacroStack.empty(); 116603569eaabceb14a20e23d043135fdccbc7309a96Argyrios Kyrtzidis } 116703db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void EnterCachingLexMode(); 116803db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis void ExitCachingLexMode() { 116903db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis if (InCachingLexMode()) 117003db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis RemoveTopOfLexerStack(); 117103db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis } 117203db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis const Token &PeekAhead(unsigned N); 11733604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void AnnotatePreviousCachedTokens(const Token &Tok); 117403db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis 117503db1b31dd926409b7defc1c90b66549464652c0Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 11765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 11775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 11785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 1179359cc4475487ea0a660b3e8918334a2866e71c66Chris Lattner void HandleLineDirective(Token &Tok); 1180478a18ec47fdb7e0e580a2635648456e9db9ad4fChris Lattner void HandleDigitDirective(Token &Tok); 1181d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 1182d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 11837143aab97c6e849a5a5005b7853b8c7d5af008edDouglas Gregor void HandleMacroExportDirective(Token &Tok); 11847143aab97c6e849a5a5005b7853b8c7d5af008edDouglas Gregor 11855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 1186ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeDirective(SourceLocation HashLoc, 1187ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor Token &Tok, 11885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 11895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 1190ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeNextDirective(SourceLocation HashLoc, Token &Tok); 1191ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleIncludeMacrosDirective(SourceLocation HashLoc, Token &Tok); 1192ecdcb883cbc6bb4a2445dc6f02d58d9bdb54a0edDouglas Gregor void HandleImportDirective(SourceLocation HashLoc, Token &Tok); 11931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 119542e6737f2efb113563140ad794c21c7709250402Chris Lattner void HandleDefineDirective(Token &Tok); 1196d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 11971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 1199d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 12005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 1201d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 1202d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 1203d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 1204d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 12051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 120780c60f72848896f867f6b7e664e7060d9e78f019Douglas Gregor void HandlePragmaDirective(unsigned Introducer); 12085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1209d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 12102243449253475574fc6f14986ff8f7fce5d46799Chris Lattner void HandlePragmaMark(); 1211d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 1212d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 1213d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 1214636c5ef6572e899d36cec1b0023fb28ba65189e1Chris Lattner void HandlePragmaComment(Token &CommentTok); 1215abfe094ce71c42656dcb84a3bdc3e79cb3c16fc3Chris Lattner void HandlePragmaMessage(Token &MessageTok); 1216f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPushMacro(Token &Tok); 1217f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner void HandlePragmaPopMacro(Token &Tok); 1218f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner IdentifierInfo *ParsePragmaPushOrPopMacro(Token &Tok); 1219f47724bf78299c7a50f008e0443c5f9f9f279ddcChris Lattner 1220046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // Return true and store the first token only if any CommentHandler 1221046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // has inserted some tokens and getCommentRetentionState() is false. 1222046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner bool HandleComment(Token &Token, SourceRange Comment); 12230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 12240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A macro is used, update information about macros that need unused 12250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// warnings. 12260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void markMacroAsUsed(MacroInfo *MI); 12275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// \brief Abstract base class that describes a handler that will receive 12302e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor/// source ranges for each of the comments encountered in the source file. 12312e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorclass CommentHandler { 12322e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregorpublic: 12332e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor virtual ~CommentHandler(); 12341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1235046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // The handler shall return true if it has pushed any tokens 1236046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner // to be read using e.g. EnterToken or EnterTokenStream. 1237046c2277dcbcc8eb89dbb5b1b8c5226b7cb81635Chris Lattner virtual bool HandleComment(Preprocessor &PP, SourceRange Comment) = 0; 12382e22253e03e175144aeb9d13350a12fd83f858beDouglas Gregor}; 12391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 12415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1243