Preprocessor.h revision c3d8d57b010e2ed15a2a7685d5761db14f5d2252
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Preprocessor.h - C Language Family Preprocessor --------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 55f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file was developed by Chris Lattner and is distributed under 65f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// the University of Illinois Open Source 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 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/Lexer.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/MacroExpander.h" 19c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#include "clang/Basic/IdentifierTable.h" 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 21cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner#include "llvm/ADT/DenseMap.h" 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileManager; 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass HeaderSearch; 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaNamespace; 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PragmaHandler; 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ScratchBuffer; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass TargetInfo; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass PPCallbacks; 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DirectoryLookup; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 36e5956bd2730c051835f9acd9e957c5d79f99e7c3Chris Lattner/// Preprocessor - This object engages in a tight little dance with the lexer to 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// efficiently preprocess tokens. Lexers know only about tokens within a 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// single source file, and don't know anything about preprocessor-level issues 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// like the #include stack, token expansion, etc. 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Preprocessor { 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &Diags; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &Features; 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &Target; 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &FileMgr; 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SourceMgr; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ScratchBuffer *ScratchBuf; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &HeaderInfo; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers for builtin macros and other builtins. 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *Ident_Pragma, *Ident__VA_ARGS__; // _Pragma, __VA_ARGS__ 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation DATELoc, TIMELoc; 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MaxIncludeStackDepth - Maximum depth of #includes. 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MaxAllowedIncludeStackDepth = 200 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that is set before the preprocessor begins. 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepComments : 1; 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool KeepMacroComments : 1; 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // State that changes while the preprocessor runs: 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool DisableMacroExpansion : 1; // True if macro expansion is disabled. 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool InMacroArgs : 1; // True if parsing fn macro invocation args. 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Identifiers - This is mapping/lookup information for all identifiers in 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the program, including program keywords. 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable Identifiers; 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7768d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// Selectors - This table contains all the selectors in the program. Unlike 7868d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// IdentifierTable above, this table *isn't* populated by the preprocessor. 7968d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// It is declared/instantiated here because it's role/lifetime is 8068d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// conceptually similar the IdentifierTable. In addition, the current control 8168d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// flow (in clang::ParseAST()), make it convenient to put here. 8268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 8368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff /// the lifetime fo the preprocessor. 8429238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable Selectors; 8568d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PragmaHandlers - This tracks all of the pragmas that the client registered 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// with this preprocessor. 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PragmaNamespace *PragmaHandlers; 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer - This is the current top of the stack that we're lexing from if 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// not expanding a macro. One of CurLexer and CurMacroExpander must be null. 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lexer *CurLexer; 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLookup - The DirectoryLookup structure used to find the current 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// implement #include_next and find directory-specific properties. 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *CurDirLookup; 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurMacroExpander - This is the current macro we are expanding, if we are 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expanding a macro. One of CurLexer and CurMacroExpander must be null. 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MacroExpander *CurMacroExpander; 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeMacroStack - This keeps track of the stack of files currently 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #included, and macros currently being expanded from, not counting 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CurLexer/CurMacroExpander. 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct IncludeStackInfo { 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lexer *TheLexer; 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *TheDirLookup; 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MacroExpander *TheMacroExpander; 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IncludeStackInfo(Lexer *L, const DirectoryLookup *D, MacroExpander *M) 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer : TheLexer(L), TheDirLookup(D), TheMacroExpander(M) { 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<IncludeStackInfo> IncludeMacroStack; 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Callbacks - These are actions invoked when some preprocessor activity is 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// encountered (e.g. a file is #included, etc). 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *Callbacks; 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 120cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 121cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// to the actual definition of the macro. 122cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 123cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various statistics we track for performance analysis. 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumIf, NumElse, NumEndif; 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumSkipped; 1319594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner 13253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// Predefines - This pointer, if non-null, are the predefined macros that 13353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// preprocessor should use from the command line etc. 13453b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner const char *Predefines; 13553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 1369594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner /// MacroExpanderCache - Cache macro expanders to reduce malloc traffic. 1379594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner enum { MacroExpanderCacheSize = 8 }; 1389594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner unsigned NumCachedMacroExpanders; 1399594acf32de2939b15eafa8fe818607bfc56bf66Chris Lattner MacroExpander *MacroExpanderCache[MacroExpanderCacheSize]; 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Preprocessor(Diagnostic &diags, const LangOptions &opts, TargetInfo &target, 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &SM, HeaderSearch &Headers); 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~Preprocessor(); 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diagnostic &getDiagnostics() const { return Diags; } 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const LangOptions &getLangOptions() const { return Features; } 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &getTargetInfo() const { return Target; } 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileManager &getFileManager() const { return FileMgr; } 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceManager &getSourceManager() const { return SourceMgr; } 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierTable &getIdentifierTable() { return Identifiers; } 15329238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable &getSelectorTable() { return Selectors; } 15468d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SetCommentRetentionState - Control whether or not the preprocessor retains 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// comments in output. 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepComments = KeepComments | KeepMacroComments; 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer this->KeepMacroComments = KeepMacroComments; 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getCommentRetentionState() const { return KeepComments; } 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCurrentLexer - Return true if we are lexing directly from the specified 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer. 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isCurrentLexer(const Lexer *L) const { 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return CurLexer == L; 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCurrentLexer - Return the current file lexer being lexed from. Note 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// that this ignores any potentially active macro expansions and _Pragma 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansions going on at the time. 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lexer *getCurrentFileLexer() const; 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getPPCallbacks/SetPPCallbacks - Accessors for preprocessor callbacks. 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer PPCallbacks *getPPCallbacks() const { return Callbacks; } 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setPPCallbacks(PPCallbacks *C) { 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Callbacks = C; 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 182cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 183cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// or null if it isn't #define'd. 184cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner MacroInfo *getMacroInfo(IdentifierInfo *II) const { 185cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner return II->hasMacroDefinition() ? Macros.find(II)->second : 0; 186cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner } 187cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 188cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// setMacroInfo - Specify a macro for this identifier. 189cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner /// 190cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 191cc1a875f94630e58d24a55577ffbf0e89b7da8c7Chris Lattner 19253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner void setPredefines(const char *P) { 19353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner Predefines = P; 19453b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner } 19553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIdentifierInfo - Return information about the specified preprocessor 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier token. The version of this method that takes two character 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pointers is preferred unless the identifier is already available as a 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// string (this avoids allocation and copying of memory to construct an 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// std::string). 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStart, 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *NameEnd) { 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return &Identifiers.get(NameStart, NameEnd); 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo(const char *NameStr) { 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return getIdentifierInfo(NameStr, NameStr+strlen(NameStr)); 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// If 'Namespace' is non-null, then it is a token required to exist on the 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void AddPragmaHandler(const char *Namespace, PragmaHandler *Handler); 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 21453b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// EnterMainSourceFile - Enter the specified FileID as the main source file, 21553b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// which implicitly adds the builting defines etc. 21653b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner void EnterMainSourceFile(unsigned CurFileID); 21753b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 21853b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFile - Add a source file to the top of the include stack and 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. If isMainFile 2215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// is true, this is the main file for the translation unit. 22253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner void EnterSourceFile(unsigned CurFileID, const DirectoryLookup *Dir); 2235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterMacro - Add a Macro to the top of the include stack and start lexing 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens from it instead of the current buffer. Args specifies the 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens input to a function-like macro. 227d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void EnterMacro(Token &Identifier, MacroArgs *Args); 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterTokenStream - Add a "macro" context to the top of the include stack, 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// which will cause the lexer to start returning the specified tokens. Note 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// that these tokens will be re-macro-expanded when/if expansion is enabled. 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// This method assumes that the specified stream of tokens has a permanent 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// owner somewhere, so they do not need to be copied. 234d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void EnterTokenStream(const Token *Toks, unsigned NumToks); 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer stack. This should only be used in situations where the current 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// state of the top-of-stack lexer is known. 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RemoveTopOfLexerStack(); 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Lex - To lex a token from the preprocessor, just pull a token from the 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current lexer or macro object. 243d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Lex(Token &Result) { 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (CurLexer) 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurLexer->Lex(Result); 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer CurMacroExpander->Lex(Result); 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// something not a comment. This is useful in -E -C mode where comments 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// would foul up preprocessor directive handling. 253d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexNonComment(Token &Result) { 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer do 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer while (Result.getKind() == tok::comment); 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LexUnexpandedToken - This is just like Lex, but this disables macro 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expansion of identifier tokens. 261d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void LexUnexpandedToken(Token &Result) { 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Disable macro expansion. 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool OldVal = DisableMacroExpansion; 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = true; 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Lex the token. 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Lex(Result); 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Reenable it. 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableMacroExpansion = OldVal; 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 273d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner /// the specified Token's location, translating the token's start 2745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// position in the current buffer into a SourcePosition object for rendering. 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void Diag(SourceLocation Loc, unsigned DiagID); 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void Diag(SourceLocation Loc, unsigned DiagID, const std::string &Msg); 277d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Diag(const Token &Tok, unsigned DiagID) { 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diag(Tok.getLocation(), DiagID); 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 280d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Diag(const Token &Tok, unsigned DiagID, const std::string &Msg) { 2815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Diag(Tok.getLocation(), DiagID, Msg); 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 2855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token is the characters used to represent the token in the source file 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// after trigraph expansion and escaped-newline folding. In particular, this 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// wants to get the true, uncanonicalized, spelling of things like digraphs 2885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// UCNs, etc. 289d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner std::string getSpelling(const Token &Tok) const; 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSpelling - This method is used to get the spelling of a token into a 2925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// preallocated buffer, instead of as an std::string. The caller is required 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to allocate enough space for the token, which is guaranteed to be at least 2945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Tok.getLength() bytes long. The length of the actual result is returned. 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 2965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Note that this method may do two possible things: it may either fill in 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the buffer specified with characters, or it may *change the input pointer* 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to point to a constant buffer with the data already in it (avoiding a 2995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// copy). The caller is not allowed to modify the returned buffer pointer 3005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// if an internal buffer is returned. 301d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner unsigned getSpelling(const Token &Tok, const char *&Buffer) const; 3025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CreateString - Plop the specified string into a scratch buffer and return 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a location for it. If specified, the source location provides a source 3065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// location for the token. 3075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation CreateString(const char *Buf, unsigned Len, 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation SourceLoc = SourceLocation()); 3095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DumpToken - Print the token to stderr, used for debugging. 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 312d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void DumpToken(const Token &Tok, bool DumpFlags = false) const; 313c3d8d57b010e2ed15a2a7685d5761db14f5d2252Chris Lattner void DumpLocation(SourceLocation Loc) const; 3145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DumpMacro(const MacroInfo &MI) const; 3155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 31697ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// AdvanceToTokenCharacter - Given a location that specifies the start of a 31797ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner /// token, return a new location that specifies a character within the token. 31897ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart,unsigned Char); 31997ba77cf09bf7b83b679165ce67ad7d49ffd568cChris Lattner 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncrementPasteCounter - Increment the counters for the number of token 3215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// paste operations performed. If fast was specified, this is a 'fast paste' 3225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// case we handled. 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 3245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void IncrementPasteCounter(bool isFast) { 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (isFast) 3265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumFastTokenPaste; 3275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 3285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ++NumTokenPaste; 3295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats(); 3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Preprocessor callback methods. These are invoked by a lexer as various 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // directives and events are found. 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookUpIdentifierInfo - Given a tok::identifier token, look up the 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier information for the token and install it into the token. 339d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner IdentifierInfo *LookUpIdentifierInfo(Token &Identifier, 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *BufPtr = 0); 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleIdentifier - This callback is invoked when the lexer reads an 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier and has filled in the tokens IdentifierInfo member. This 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// callback potentially macro expands it or turns it into a named token (like 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 'for'). 346d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentifier(Token &Identifier); 3475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current file. This either returns the EOF token and returns true, or 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// pops a level off the include stack and returns false, at which point the 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// client should call lex again. 353d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleEndOfMacro - This callback is invoked when the lexer hits the end of 3565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the current macro line. It returns true if Result is filled in with a 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// token, or false if Lex should be called again. 358d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleEndOfMacro(Token &Result); 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDirective - This callback is invoked when the lexer sees a # token 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// at the start of a line. This consumes the directive, modifies the 3625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexer/preprocessor state, and advances the lexer(s) so that the next token 3635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read is the correct one. 364d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDirective(Token &Result); 3655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// CheckEndOfDirective - Ensure that the next token is a tok::eom token. If 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// not, emit a diagnostic and consume up until the eom. 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void CheckEndOfDirective(const char *Directive); 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 37053b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// isInPrimaryFile - Return true if we're in the top-level file, not in a 37153b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner /// #include. 37253b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner bool isInPrimaryFile() const; 37353b0dabbe52219a8057659b90539837394ef0fa1Chris Lattner 3745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 3755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// current line until the tok::eom token is found. 3765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void DiscardUntilEndOfDirective(); 3775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroName - Lex and validate a macro name, which occurs after a 3795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #define or #undef. This emits a diagnostic, sets the token kind to eom, 3805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// and discards the rest of the macro line if the macro name is invalid. 381d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 3825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 3845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// definition has just been read. Lex the rest of the arguments and the 3855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// closing ), updating MI with what we learn. Return true if an error occurs 3865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// parsing the arg list. 3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadMacroDefinitionArgList(MacroInfo *MI); 3885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SkipExcludedConditionalBlock - We just read a #if or related directive and 3905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// decided that the subsequent tokens are in the #if'd out portion of the 3915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// file. Lex the rest of the file, until we see an #endif. If 3925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkipPortion is true, then we have already emitted code for part of 3935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this #if directive, so #else/#elif blocks should never be entered. If 3945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse is false, then #else directives are ok, if not, then we have 3955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// already seen one so a #else directive is a duplicate. When this returns, 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the caller can lex the first valid token. 3975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 3985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkipPortion, bool FoundElse); 3995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 4015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// may occur after a #if or #elif directive and return it as a bool. If the 4025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 4035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 4045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 4065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #pragma GCC poison/system_header/dependency and #pragma once. 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinPragmas(); 4085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 4105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier table. 4115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void RegisterBuiltinMacros(); 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *RegisterBuiltinMacro(const char *Name); 4135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 4155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded as a macro, handle it and return the next token as 'Tok'. If 4165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the macro should not be expanded return true, otherwise return false. 417d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// lexed is a '('. If so, consume the token and return true, if not, this 4215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// method should have no observable side-effect on the lexed tokens. 4225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isNextPPTokenLParen(); 4235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invoked to read all of the formal arguments specified for the macro 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// invocation. This returns null on error. 427d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI); 4285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 4305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as a builtin macro, handle it and return the next token as 'Tok'. 431d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void ExpandBuiltinMacro(Token &Tok); 4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 4345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return the first token after the directive. The _Pragma token has just 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been read into 'Tok'. 436d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void Handle_Pragma(Token &Tok); 4375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 4405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// start lexing tokens from it instead of the current buffer. 4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 4425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// checked and spelled filename, e.g. as an operand of #include. This returns 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// true if the input filename was in <>'s or false if it were in ""'s. The 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// caller is expected to provide a buffer that is large enough to hold the 4475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// spelling of the filename, but is also expected to handle the case when 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this method decides to use a different buffer. 449f1c99acc544a4e70f308db4e7200ca04cd5a06d2Chris Lattner bool GetIncludeFilenameSpelling(SourceLocation Loc, 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *&BufStart, const char *&BufEnd); 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// return null on failure. isAngled indicates whether the file reference is 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for system #include's or not (i.e. using <> instead of ""). 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const FileEntry *LookupFile(const char *FilenameStart,const char *FilenameEnd, 4565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isAngled, const DirectoryLookup *FromDir, 4575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *&CurDir); 4585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 4605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Handle*Directive - implement the various preprocessor directives. These 4615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// should side-effect the current preprocessor object so that the next call 4625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to Lex() will return the appropriate token next. 4635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 464d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 465d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIdentSCCSDirective(Token &Tok); 4665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // File inclusion. 468d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeDirective(Token &Tok, 4695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const DirectoryLookup *LookupFrom = 0, 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isImport = false); 471d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIncludeNextDirective(Token &Tok); 472d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleImportDirective(Token &Tok); 4735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Macro handling. 475d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDefineDirective(Token &Tok, bool isTargetSpecific); 476d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleUndefDirective(Token &Tok); 477d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleDefineOtherTargetDirective(Token &Tok); 478d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleAssertDirective(Token &Tok); 479d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner // HandleUnassertDirective(Token &Tok); 4805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Conditional Inclusion. 482d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfdefDirective(Token &Tok, bool isIfndef, 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ReadAnyTokensBeforeDirective); 484d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 485d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleEndifDirective(Token &Tok); 486d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElseDirective(Token &Tok); 487d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandleElifDirective(Token &Tok); 4885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Pragmas. 4905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void HandlePragmaDirective(); 4915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 492d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaOnce(Token &OnceTok); 493d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaPoison(Token &PoisonTok); 494d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaSystemHeader(Token &SysHeaderTok); 495d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner void HandlePragmaDependency(Token &DependencyTok); 4965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 4995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 501