Preprocessor.h revision 14f79002e58556798e86168c63e48d533287eda5
1//===--- Preprocessor.h - C Language Family Preprocessor --------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines the Preprocessor interface. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_LEX_PREPROCESSOR_H 15#define LLVM_CLANG_LEX_PREPROCESSOR_H 16 17#include "clang/Lex/Lexer.h" 18#include "clang/Lex/PTHLexer.h" 19#include "clang/Lex/PPCallbacks.h" 20#include "clang/Lex/TokenLexer.h" 21#include "clang/Lex/PTHManager.h" 22#include "clang/Basic/Diagnostic.h" 23#include "clang/Basic/IdentifierTable.h" 24#include "clang/Basic/SourceLocation.h" 25#include "llvm/ADT/DenseMap.h" 26#include "llvm/ADT/OwningPtr.h" 27#include "llvm/Support/Allocator.h" 28 29namespace clang { 30 31class SourceManager; 32class FileManager; 33class FileEntry; 34class HeaderSearch; 35class PragmaNamespace; 36class PragmaHandler; 37class ScratchBuffer; 38class TargetInfo; 39class PPCallbacks; 40class DirectoryLookup; 41 42/// Preprocessor - This object engages in a tight little dance with the lexer to 43/// efficiently preprocess tokens. Lexers know only about tokens within a 44/// single source file, and don't know anything about preprocessor-level issues 45/// like the #include stack, token expansion, etc. 46/// 47class Preprocessor { 48 Diagnostic *Diags; 49 const LangOptions &Features; 50 TargetInfo &Target; 51 FileManager &FileMgr; 52 SourceManager &SourceMgr; 53 ScratchBuffer *ScratchBuf; 54 HeaderSearch &HeaderInfo; 55 56 /// PTH - An optional PTHManager object used for getting tokens from 57 /// a token cache rather than lexing the original source file. 58 llvm::OwningPtr<PTHManager> PTH; 59 60 /// BP - A BumpPtrAllocator object used to quickly allocate and release 61 /// objects internal to the Preprocessor. 62 llvm::BumpPtrAllocator BP; 63 64 /// Identifiers for builtin macros and other builtins. 65 IdentifierInfo *Ident__LINE__, *Ident__FILE__; // __LINE__, __FILE__ 66 IdentifierInfo *Ident__DATE__, *Ident__TIME__; // __DATE__, __TIME__ 67 IdentifierInfo *Ident__INCLUDE_LEVEL__; // __INCLUDE_LEVEL__ 68 IdentifierInfo *Ident__BASE_FILE__; // __BASE_FILE__ 69 IdentifierInfo *Ident__TIMESTAMP__; // __TIMESTAMP__ 70 IdentifierInfo *Ident_Pragma, *Ident__VA_ARGS__; // _Pragma, __VA_ARGS__ 71 72 SourceLocation DATELoc, TIMELoc; 73 74 enum { 75 /// MaxIncludeStackDepth - Maximum depth of #includes. 76 MaxAllowedIncludeStackDepth = 200 77 }; 78 79 // State that is set before the preprocessor begins. 80 bool KeepComments : 1; 81 bool KeepMacroComments : 1; 82 83 // State that changes while the preprocessor runs: 84 bool DisableMacroExpansion : 1; // True if macro expansion is disabled. 85 bool InMacroArgs : 1; // True if parsing fn macro invocation args. 86 87 /// Identifiers - This is mapping/lookup information for all identifiers in 88 /// the program, including program keywords. 89 IdentifierTable Identifiers; 90 91 /// Selectors - This table contains all the selectors in the program. Unlike 92 /// IdentifierTable above, this table *isn't* populated by the preprocessor. 93 /// It is declared/instantiated here because it's role/lifetime is 94 /// conceptually similar the IdentifierTable. In addition, the current control 95 /// flow (in clang::ParseAST()), make it convenient to put here. 96 /// FIXME: Make sure the lifetime of Identifiers/Selectors *isn't* tied to 97 /// the lifetime fo the preprocessor. 98 SelectorTable Selectors; 99 100 /// PragmaHandlers - This tracks all of the pragmas that the client registered 101 /// with this preprocessor. 102 PragmaNamespace *PragmaHandlers; 103 104 /// CurLexer - This is the current top of the stack that we're lexing from if 105 /// not expanding a macro and we are lexing directly from source code. 106 /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 107 llvm::OwningPtr<Lexer> CurLexer; 108 109 /// CurPTHLexer - This is the current top of stack that we're lexing from if 110 /// not expanding from a macro and we are lexing from a PTH cache. 111 /// Only one of CurLexer, CurPTHLexer, or CurTokenLexer will be non-null. 112 llvm::OwningPtr<PTHLexer> CurPTHLexer; 113 114 /// CurPPLexer - This is the current top of the stack what we're lexing from 115 /// if not expanding a macro. This is an alias for either CurLexer or 116 /// CurPTHLexer. 117 PreprocessorLexer* CurPPLexer; 118 119 /// CurLookup - The DirectoryLookup structure used to find the current 120 /// FileEntry, if CurLexer is non-null and if applicable. This allows us to 121 /// implement #include_next and find directory-specific properties. 122 const DirectoryLookup *CurDirLookup; 123 124 /// CurTokenLexer - This is the current macro we are expanding, if we are 125 /// expanding a macro. One of CurLexer and CurTokenLexer must be null. 126 llvm::OwningPtr<TokenLexer> CurTokenLexer; 127 128 /// IncludeMacroStack - This keeps track of the stack of files currently 129 /// #included, and macros currently being expanded from, not counting 130 /// CurLexer/CurTokenLexer. 131 struct IncludeStackInfo { 132 Lexer *TheLexer; 133 PTHLexer *ThePTHLexer; 134 PreprocessorLexer *ThePPLexer; 135 TokenLexer *TheTokenLexer; 136 const DirectoryLookup *TheDirLookup; 137 138 IncludeStackInfo(Lexer *L, PTHLexer* P, PreprocessorLexer* PPL, 139 TokenLexer* TL, const DirectoryLookup *D) 140 : TheLexer(L), ThePTHLexer(P), ThePPLexer(PPL), TheTokenLexer(TL), 141 TheDirLookup(D) {} 142 }; 143 std::vector<IncludeStackInfo> IncludeMacroStack; 144 145 /// Callbacks - These are actions invoked when some preprocessor activity is 146 /// encountered (e.g. a file is #included, etc). 147 PPCallbacks *Callbacks; 148 149 /// Macros - For each IdentifierInfo with 'HasMacro' set, we keep a mapping 150 /// to the actual definition of the macro. 151 llvm::DenseMap<IdentifierInfo*, MacroInfo*> Macros; 152 153 /// MICache - A "freelist" of MacroInfo objects that can be reused for quick 154 /// allocation. 155 std::vector<MacroInfo*> MICache; 156 157 // Various statistics we track for performance analysis. 158 unsigned NumDirectives, NumIncluded, NumDefined, NumUndefined, NumPragma; 159 unsigned NumIf, NumElse, NumEndif; 160 unsigned NumEnteredSourceFiles, MaxIncludeStackDepth; 161 unsigned NumMacroExpanded, NumFnMacroExpanded, NumBuiltinMacroExpanded; 162 unsigned NumFastMacroExpanded, NumTokenPaste, NumFastTokenPaste; 163 unsigned NumSkipped; 164 165 /// Predefines - This string is the predefined macros that preprocessor 166 /// should use from the command line etc. 167 std::string Predefines; 168 169 /// TokenLexerCache - Cache macro expanders to reduce malloc traffic. 170 enum { TokenLexerCacheSize = 8 }; 171 unsigned NumCachedTokenLexers; 172 TokenLexer *TokenLexerCache[TokenLexerCacheSize]; 173 174private: // Cached tokens state. 175 typedef std::vector<Token> CachedTokensTy; 176 177 /// CachedTokens - Cached tokens are stored here when we do backtracking or 178 /// lookahead. They are "lexed" by the CachingLex() method. 179 CachedTokensTy CachedTokens; 180 181 /// CachedLexPos - The position of the cached token that CachingLex() should 182 /// "lex" next. If it points beyond the CachedTokens vector, it means that 183 /// a normal Lex() should be invoked. 184 CachedTokensTy::size_type CachedLexPos; 185 186 /// BacktrackPositions - Stack of backtrack positions, allowing nested 187 /// backtracks. The EnableBacktrackAtThisPos() method pushes a position to 188 /// indicate where CachedLexPos should be set when the BackTrack() method is 189 /// invoked (at which point the last position is popped). 190 std::vector<CachedTokensTy::size_type> BacktrackPositions; 191 192public: 193 Preprocessor(Diagnostic &diags, const LangOptions &opts, TargetInfo &target, 194 SourceManager &SM, HeaderSearch &Headers, 195 IdentifierInfoLookup* IILookup = 0); 196 197 ~Preprocessor(); 198 199 Diagnostic &getDiagnostics() const { return *Diags; } 200 void setDiagnostics(Diagnostic &D) { Diags = &D; } 201 202 203 const LangOptions &getLangOptions() const { return Features; } 204 TargetInfo &getTargetInfo() const { return Target; } 205 FileManager &getFileManager() const { return FileMgr; } 206 SourceManager &getSourceManager() const { return SourceMgr; } 207 HeaderSearch &getHeaderSearchInfo() const { return HeaderInfo; } 208 209 IdentifierTable &getIdentifierTable() { return Identifiers; } 210 SelectorTable &getSelectorTable() { return Selectors; } 211 llvm::BumpPtrAllocator &getPreprocessorAllocator() { return BP; } 212 213 void setPTHManager(PTHManager* pm); 214 215 PTHManager *getPTHManager() { return PTH.get(); } 216 217 /// SetCommentRetentionState - Control whether or not the preprocessor retains 218 /// comments in output. 219 void SetCommentRetentionState(bool KeepComments, bool KeepMacroComments) { 220 this->KeepComments = KeepComments | KeepMacroComments; 221 this->KeepMacroComments = KeepMacroComments; 222 } 223 224 bool getCommentRetentionState() const { return KeepComments; } 225 226 /// isCurrentLexer - Return true if we are lexing directly from the specified 227 /// lexer. 228 bool isCurrentLexer(const PreprocessorLexer *L) const { 229 return CurPPLexer == L; 230 } 231 232 /// getCurrentLexer - Return the current file lexer being lexed from. Note 233 /// that this ignores any potentially active macro expansions and _Pragma 234 /// expansions going on at the time. 235 PreprocessorLexer *getCurrentFileLexer() const; 236 237 /// getPPCallbacks/setPPCallbacks - Accessors for preprocessor callbacks. 238 /// Note that this class takes ownership of any PPCallbacks object given to 239 /// it. 240 PPCallbacks *getPPCallbacks() const { return Callbacks; } 241 void setPPCallbacks(PPCallbacks *C) { 242 delete Callbacks; 243 Callbacks = C; 244 } 245 246 /// getMacroInfo - Given an identifier, return the MacroInfo it is #defined to 247 /// or null if it isn't #define'd. 248 MacroInfo *getMacroInfo(IdentifierInfo *II) const { 249 return II->hasMacroDefinition() ? Macros.find(II)->second : 0; 250 } 251 252 /// setMacroInfo - Specify a macro for this identifier. 253 /// 254 void setMacroInfo(IdentifierInfo *II, MacroInfo *MI); 255 256 /// macro_iterator/macro_begin/macro_end - This allows you to walk the current 257 /// state of the macro table. This visits every currently-defined macro. 258 typedef llvm::DenseMap<IdentifierInfo*, 259 MacroInfo*>::const_iterator macro_iterator; 260 macro_iterator macro_begin() const { return Macros.begin(); } 261 macro_iterator macro_end() const { return Macros.end(); } 262 263 264 265 const std::string &getPredefines() const { return Predefines; } 266 /// setPredefines - Set the predefines for this Preprocessor. These 267 /// predefines are automatically injected when parsing the main file. 268 void setPredefines(const char *P) { Predefines = P; } 269 void setPredefines(const std::string &P) { Predefines = P; } 270 271 /// getIdentifierInfo - Return information about the specified preprocessor 272 /// identifier token. The version of this method that takes two character 273 /// pointers is preferred unless the identifier is already available as a 274 /// string (this avoids allocation and copying of memory to construct an 275 /// std::string). 276 IdentifierInfo *getIdentifierInfo(const char *NameStart, 277 const char *NameEnd) { 278 return &Identifiers.get(NameStart, NameEnd); 279 } 280 IdentifierInfo *getIdentifierInfo(const char *NameStr) { 281 return getIdentifierInfo(NameStr, NameStr+strlen(NameStr)); 282 } 283 284 /// AddPragmaHandler - Add the specified pragma handler to the preprocessor. 285 /// If 'Namespace' is non-null, then it is a token required to exist on the 286 /// pragma line before the pragma string starts, e.g. "STDC" or "GCC". 287 void AddPragmaHandler(const char *Namespace, PragmaHandler *Handler); 288 289 /// RemovePragmaHandler - Remove the specific pragma handler from 290 /// the preprocessor. If \arg Namespace is non-null, then it should 291 /// be the namespace that \arg Handler was added to. It is an error 292 /// to remove a handler that has not been registered. 293 void RemovePragmaHandler(const char *Namespace, PragmaHandler *Handler); 294 295 /// EnterMainSourceFile - Enter the specified FileID as the main source file, 296 /// which implicitly adds the builtin defines etc. 297 void EnterMainSourceFile(); 298 299 /// EnterSourceFile - Add a source file to the top of the include stack and 300 /// start lexing tokens from it instead of the current buffer. If isMainFile 301 /// is true, this is the main file for the translation unit. 302 void EnterSourceFile(FileID CurFileID, const DirectoryLookup *Dir); 303 304 /// EnterMacro - Add a Macro to the top of the include stack and start lexing 305 /// tokens from it instead of the current buffer. Args specifies the 306 /// tokens input to a function-like macro. 307 /// 308 /// ILEnd specifies the location of the ')' for a function-like macro or the 309 /// identifier for an object-like macro. 310 void EnterMacro(Token &Identifier, SourceLocation ILEnd, MacroArgs *Args); 311 312 /// EnterTokenStream - Add a "macro" context to the top of the include stack, 313 /// which will cause the lexer to start returning the specified tokens. 314 /// 315 /// If DisableMacroExpansion is true, tokens lexed from the token stream will 316 /// not be subject to further macro expansion. Otherwise, these tokens will 317 /// be re-macro-expanded when/if expansion is enabled. 318 /// 319 /// If OwnsTokens is false, this method assumes that the specified stream of 320 /// tokens has a permanent owner somewhere, so they do not need to be copied. 321 /// If it is true, it assumes the array of tokens is allocated with new[] and 322 /// must be freed. 323 /// 324 void EnterTokenStream(const Token *Toks, unsigned NumToks, 325 bool DisableMacroExpansion, bool OwnsTokens); 326 327 /// RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the 328 /// lexer stack. This should only be used in situations where the current 329 /// state of the top-of-stack lexer is known. 330 void RemoveTopOfLexerStack(); 331 332 /// EnableBacktrackAtThisPos - From the point that this method is called, and 333 /// until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor 334 /// keeps track of the lexed tokens so that a subsequent Backtrack() call will 335 /// make the Preprocessor re-lex the same tokens. 336 /// 337 /// Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can 338 /// be called multiple times and CommitBacktrackedTokens/Backtrack calls will 339 /// be combined with the EnableBacktrackAtThisPos calls in reverse order. 340 /// 341 /// NOTE: *DO NOT* forget to call either CommitBacktrackedTokens or Backtrack 342 /// at some point after EnableBacktrackAtThisPos. If you don't, caching of 343 /// tokens will continue indefinitely. 344 /// 345 void EnableBacktrackAtThisPos(); 346 347 /// CommitBacktrackedTokens - Disable the last EnableBacktrackAtThisPos call. 348 void CommitBacktrackedTokens(); 349 350 /// Backtrack - Make Preprocessor re-lex the tokens that were lexed since 351 /// EnableBacktrackAtThisPos() was previously called. 352 void Backtrack(); 353 354 /// isBacktrackEnabled - True if EnableBacktrackAtThisPos() was called and 355 /// caching of tokens is on. 356 bool isBacktrackEnabled() const { return !BacktrackPositions.empty(); } 357 358 /// Lex - To lex a token from the preprocessor, just pull a token from the 359 /// current lexer or macro object. 360 void Lex(Token &Result) { 361 if (CurLexer) 362 CurLexer->Lex(Result); 363 else if (CurPTHLexer) 364 CurPTHLexer->Lex(Result); 365 else if (CurTokenLexer) 366 CurTokenLexer->Lex(Result); 367 else 368 CachingLex(Result); 369 } 370 371 /// LexNonComment - Lex a token. If it's a comment, keep lexing until we get 372 /// something not a comment. This is useful in -E -C mode where comments 373 /// would foul up preprocessor directive handling. 374 void LexNonComment(Token &Result) { 375 do 376 Lex(Result); 377 while (Result.getKind() == tok::comment); 378 } 379 380 /// LexUnexpandedToken - This is just like Lex, but this disables macro 381 /// expansion of identifier tokens. 382 void LexUnexpandedToken(Token &Result) { 383 // Disable macro expansion. 384 bool OldVal = DisableMacroExpansion; 385 DisableMacroExpansion = true; 386 // Lex the token. 387 Lex(Result); 388 389 // Reenable it. 390 DisableMacroExpansion = OldVal; 391 } 392 393 /// LookAhead - This peeks ahead N tokens and returns that token without 394 /// consuming any tokens. LookAhead(0) returns the next token that would be 395 /// returned by Lex(), LookAhead(1) returns the token after it, etc. This 396 /// returns normal tokens after phase 5. As such, it is equivalent to using 397 /// 'Lex', not 'LexUnexpandedToken'. 398 const Token &LookAhead(unsigned N) { 399 if (CachedLexPos + N < CachedTokens.size()) 400 return CachedTokens[CachedLexPos+N]; 401 else 402 return PeekAhead(N+1); 403 } 404 405 /// RevertCachedTokens - When backtracking is enabled and tokens are cached, 406 /// this allows to revert a specific number of tokens. 407 /// Note that the number of tokens being reverted should be up to the last 408 /// backtrack position, not more. 409 void RevertCachedTokens(unsigned N) { 410 assert(isBacktrackEnabled() && 411 "Should only be called when tokens are cached for backtracking"); 412 assert(signed(CachedLexPos) - signed(N) >= signed(BacktrackPositions.back()) 413 && "Should revert tokens up to the last backtrack position, not more"); 414 assert(signed(CachedLexPos) - signed(N) >= 0 && 415 "Corrupted backtrack positions ?"); 416 CachedLexPos -= N; 417 } 418 419 /// EnterToken - Enters a token in the token stream to be lexed next. If 420 /// BackTrack() is called afterwards, the token will remain at the insertion 421 /// point. 422 void EnterToken(const Token &Tok) { 423 EnterCachingLexMode(); 424 CachedTokens.insert(CachedTokens.begin()+CachedLexPos, Tok); 425 } 426 427 /// AnnotateCachedTokens - We notify the Preprocessor that if it is caching 428 /// tokens (because backtrack is enabled) it should replace the most recent 429 /// cached tokens with the given annotation token. This function has no effect 430 /// if backtracking is not enabled. 431 /// 432 /// Note that the use of this function is just for optimization; so that the 433 /// cached tokens doesn't get re-parsed and re-resolved after a backtrack is 434 /// invoked. 435 void AnnotateCachedTokens(const Token &Tok) { 436 assert(Tok.isAnnotation() && "Expected annotation token"); 437 if (CachedLexPos != 0 && isBacktrackEnabled()) 438 AnnotatePreviousCachedTokens(Tok); 439 } 440 441 /// \brief Replace the last token with an annotation token. 442 /// 443 /// Like AnnotateCachedTokens(), this routine replaces an 444 /// already-parsed (and resolved) token with an annotation 445 /// token. However, this routine only replaces the last token with 446 /// the annotation token; it does not affect any other cached 447 /// tokens. This function has no effect if backtracking is not 448 /// enabled. 449 void ReplaceLastTokenWithAnnotation(const Token &Tok) { 450 assert(Tok.isAnnotation() && "Expected annotation token"); 451 if (CachedLexPos != 0 && isBacktrackEnabled()) 452 CachedTokens[CachedLexPos-1] = Tok; 453 } 454 455 /// Diag - Forwarding function for diagnostics. This emits a diagnostic at 456 /// the specified Token's location, translating the token's start 457 /// position in the current buffer into a SourcePosition object for rendering. 458 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { 459 return Diags->Report(FullSourceLoc(Loc, getSourceManager()), DiagID); 460 } 461 462 DiagnosticBuilder Diag(const Token &Tok, unsigned DiagID) { 463 return Diags->Report(FullSourceLoc(Tok.getLocation(), getSourceManager()), 464 DiagID); 465 } 466 467 /// getSpelling() - Return the 'spelling' of the Tok token. The spelling of a 468 /// token is the characters used to represent the token in the source file 469 /// after trigraph expansion and escaped-newline folding. In particular, this 470 /// wants to get the true, uncanonicalized, spelling of things like digraphs 471 /// UCNs, etc. 472 std::string getSpelling(const Token &Tok) const; 473 474 /// getSpelling - This method is used to get the spelling of a token into a 475 /// preallocated buffer, instead of as an std::string. The caller is required 476 /// to allocate enough space for the token, which is guaranteed to be at least 477 /// Tok.getLength() bytes long. The length of the actual result is returned. 478 /// 479 /// Note that this method may do two possible things: it may either fill in 480 /// the buffer specified with characters, or it may *change the input pointer* 481 /// to point to a constant buffer with the data already in it (avoiding a 482 /// copy). The caller is not allowed to modify the returned buffer pointer 483 /// if an internal buffer is returned. 484 unsigned getSpelling(const Token &Tok, const char *&Buffer) const; 485 486 /// getSpellingOfSingleCharacterNumericConstant - Tok is a numeric constant 487 /// with length 1, return the character. 488 char getSpellingOfSingleCharacterNumericConstant(const Token &Tok) const { 489 assert(Tok.is(tok::numeric_constant) && 490 Tok.getLength() == 1 && "Called on unsupported token"); 491 assert(!Tok.needsCleaning() && "Token can't need cleaning with length 1"); 492 493 // If the token is carrying a literal data pointer, just use it. 494 if (const char *D = Tok.getLiteralData()) 495 return *D; 496 497 // Otherwise, fall back on getCharacterData, which is slower, but always 498 // works. 499 return *SourceMgr.getCharacterData(Tok.getLocation()); 500 } 501 502 /// CreateString - Plop the specified string into a scratch buffer and set the 503 /// specified token's location and length to it. If specified, the source 504 /// location provides a location of the instantiation point of the token. 505 void CreateString(const char *Buf, unsigned Len, 506 Token &Tok, SourceLocation SourceLoc = SourceLocation()); 507 508 /// \brief Computes the source location just past the end of the 509 /// token at this source location. 510 /// 511 /// This routine can be used to produce a source location that 512 /// points just past the end of the token referenced by \p Loc, and 513 /// is generally used when a diagnostic needs to point just after a 514 /// token where it expected something different that it received. If 515 /// the returned source location would not be meaningful (e.g., if 516 /// it points into a macro), this routine returns an invalid 517 /// source location. 518 SourceLocation getLocForEndOfToken(SourceLocation Loc); 519 520 /// DumpToken - Print the token to stderr, used for debugging. 521 /// 522 void DumpToken(const Token &Tok, bool DumpFlags = false) const; 523 void DumpLocation(SourceLocation Loc) const; 524 void DumpMacro(const MacroInfo &MI) const; 525 526 /// AdvanceToTokenCharacter - Given a location that specifies the start of a 527 /// token, return a new location that specifies a character within the token. 528 SourceLocation AdvanceToTokenCharacter(SourceLocation TokStart,unsigned Char); 529 530 /// IncrementPasteCounter - Increment the counters for the number of token 531 /// paste operations performed. If fast was specified, this is a 'fast paste' 532 /// case we handled. 533 /// 534 void IncrementPasteCounter(bool isFast) { 535 if (isFast) 536 ++NumFastTokenPaste; 537 else 538 ++NumTokenPaste; 539 } 540 541 void PrintStats(); 542 543 /// HandleMicrosoftCommentPaste - When the macro expander pastes together a 544 /// comment (/##/) in microsoft mode, this method handles updating the current 545 /// state, returning the token on the next source line. 546 void HandleMicrosoftCommentPaste(Token &Tok); 547 548 //===--------------------------------------------------------------------===// 549 // Preprocessor callback methods. These are invoked by a lexer as various 550 // directives and events are found. 551 552 /// LookUpIdentifierInfo - Given a tok::identifier token, look up the 553 /// identifier information for the token and install it into the token. 554 IdentifierInfo *LookUpIdentifierInfo(Token &Identifier, 555 const char *BufPtr = 0); 556 557 /// HandleIdentifier - This callback is invoked when the lexer reads an 558 /// identifier and has filled in the tokens IdentifierInfo member. This 559 /// callback potentially macro expands it or turns it into a named token (like 560 /// 'for'). 561 void HandleIdentifier(Token &Identifier); 562 563 564 /// HandleEndOfFile - This callback is invoked when the lexer hits the end of 565 /// the current file. This either returns the EOF token and returns true, or 566 /// pops a level off the include stack and returns false, at which point the 567 /// client should call lex again. 568 bool HandleEndOfFile(Token &Result, bool isEndOfMacro = false); 569 570 /// HandleEndOfTokenLexer - This callback is invoked when the current 571 /// TokenLexer hits the end of its token stream. 572 bool HandleEndOfTokenLexer(Token &Result); 573 574 /// HandleDirective - This callback is invoked when the lexer sees a # token 575 /// at the start of a line. This consumes the directive, modifies the 576 /// lexer/preprocessor state, and advances the lexer(s) so that the next token 577 /// read is the correct one. 578 void HandleDirective(Token &Result); 579 580 /// CheckEndOfDirective - Ensure that the next token is a tok::eom token. If 581 /// not, emit a diagnostic and consume up until the eom. 582 void CheckEndOfDirective(const char *Directive); 583 584 /// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 585 /// current line until the tok::eom token is found. 586 void DiscardUntilEndOfDirective(); 587 588private: 589 590 void PushIncludeMacroStack() { 591 IncludeMacroStack.push_back(IncludeStackInfo(CurLexer.take(), 592 CurPTHLexer.take(), 593 CurPPLexer, 594 CurTokenLexer.take(), 595 CurDirLookup)); 596 CurPPLexer = 0; 597 } 598 599 void PopIncludeMacroStack() { 600 CurLexer.reset(IncludeMacroStack.back().TheLexer); 601 CurPTHLexer.reset(IncludeMacroStack.back().ThePTHLexer); 602 CurPPLexer = IncludeMacroStack.back().ThePPLexer; 603 CurTokenLexer.reset(IncludeMacroStack.back().TheTokenLexer); 604 CurDirLookup = IncludeMacroStack.back().TheDirLookup; 605 IncludeMacroStack.pop_back(); 606 } 607 608 /// AllocateMacroInfo - Allocate a new MacroInfo object with the provide 609 /// SourceLocation. 610 MacroInfo* AllocateMacroInfo(SourceLocation L); 611 612 /// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 613 /// be reused for allocating new MacroInfo objects. 614 void ReleaseMacroInfo(MacroInfo* MI); 615 616 /// isInPrimaryFile - Return true if we're in the top-level file, not in a 617 /// #include. 618 bool isInPrimaryFile() const; 619 620 /// ReadMacroName - Lex and validate a macro name, which occurs after a 621 /// #define or #undef. This emits a diagnostic, sets the token kind to eom, 622 /// and discards the rest of the macro line if the macro name is invalid. 623 void ReadMacroName(Token &MacroNameTok, char isDefineUndef = 0); 624 625 /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 626 /// definition has just been read. Lex the rest of the arguments and the 627 /// closing ), updating MI with what we learn. Return true if an error occurs 628 /// parsing the arg list. 629 bool ReadMacroDefinitionArgList(MacroInfo *MI); 630 631 /// SkipExcludedConditionalBlock - We just read a #if or related directive and 632 /// decided that the subsequent tokens are in the #if'd out portion of the 633 /// file. Lex the rest of the file, until we see an #endif. If 634 /// FoundNonSkipPortion is true, then we have already emitted code for part of 635 /// this #if directive, so #else/#elif blocks should never be entered. If 636 /// FoundElse is false, then #else directives are ok, if not, then we have 637 /// already seen one so a #else directive is a duplicate. When this returns, 638 /// the caller can lex the first valid token. 639 void SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 640 bool FoundNonSkipPortion, bool FoundElse); 641 642 /// PTHSkipExcludedConditionalBlock - A fast PTH version of 643 /// SkipExcludedConditionalBlock. 644 void PTHSkipExcludedConditionalBlock(); 645 646 /// EvaluateDirectiveExpression - Evaluate an integer constant expression that 647 /// may occur after a #if or #elif directive and return it as a bool. If the 648 /// expression is equivalent to "!defined(X)" return X in IfNDefMacro. 649 bool EvaluateDirectiveExpression(IdentifierInfo *&IfNDefMacro); 650 651 /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas: 652 /// #pragma GCC poison/system_header/dependency and #pragma once. 653 void RegisterBuiltinPragmas(); 654 655 /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 656 /// identifier table. 657 void RegisterBuiltinMacros(); 658 IdentifierInfo *RegisterBuiltinMacro(const char *Name); 659 660 /// HandleMacroExpandedIdentifier - If an identifier token is read that is to 661 /// be expanded as a macro, handle it and return the next token as 'Tok'. If 662 /// the macro should not be expanded return true, otherwise return false. 663 bool HandleMacroExpandedIdentifier(Token &Tok, MacroInfo *MI); 664 665 /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 666 /// lexed is a '('. If so, consume the token and return true, if not, this 667 /// method should have no observable side-effect on the lexed tokens. 668 bool isNextPPTokenLParen(); 669 670 /// ReadFunctionLikeMacroArgs - After reading "MACRO(", this method is 671 /// invoked to read all of the formal arguments specified for the macro 672 /// invocation. This returns null on error. 673 MacroArgs *ReadFunctionLikeMacroArgs(Token &MacroName, MacroInfo *MI, 674 SourceLocation &InstantiationEnd); 675 676 /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 677 /// as a builtin macro, handle it and return the next token as 'Tok'. 678 void ExpandBuiltinMacro(Token &Tok); 679 680 /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then 681 /// return the first token after the directive. The _Pragma token has just 682 /// been read into 'Tok'. 683 void Handle_Pragma(Token &Tok); 684 685 /// EnterSourceFileWithLexer - Add a lexer to the top of the include stack and 686 /// start lexing tokens from it instead of the current buffer. 687 void EnterSourceFileWithLexer(Lexer *TheLexer, const DirectoryLookup *Dir); 688 689 /// EnterSourceFileWithPTH - Add a lexer to the top of the include stack and 690 /// start getting tokens from it using the PTH cache. 691 void EnterSourceFileWithPTH(PTHLexer *PL, const DirectoryLookup *Dir); 692 693 /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 694 /// checked and spelled filename, e.g. as an operand of #include. This returns 695 /// true if the input filename was in <>'s or false if it were in ""'s. The 696 /// caller is expected to provide a buffer that is large enough to hold the 697 /// spelling of the filename, but is also expected to handle the case when 698 /// this method decides to use a different buffer. 699 bool GetIncludeFilenameSpelling(SourceLocation Loc, 700 const char *&BufStart, const char *&BufEnd); 701 702 /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 703 /// return null on failure. isAngled indicates whether the file reference is 704 /// for system #include's or not (i.e. using <> instead of ""). 705 const FileEntry *LookupFile(const char *FilenameStart,const char *FilenameEnd, 706 bool isAngled, const DirectoryLookup *FromDir, 707 const DirectoryLookup *&CurDir); 708 709 710 711 /// IsFileLexer - Returns true if we are lexing from a file and not a 712 /// pragma or a macro. 713 static bool IsFileLexer(const Lexer* L, const PreprocessorLexer* P) { 714 return L ? !L->isPragmaLexer() : P != 0; 715 } 716 717 static bool IsFileLexer(const IncludeStackInfo& I) { 718 return IsFileLexer(I.TheLexer, I.ThePPLexer); 719 } 720 721 bool IsFileLexer() const { 722 return IsFileLexer(CurLexer.get(), CurPPLexer); 723 } 724 725 //===--------------------------------------------------------------------===// 726 // Caching stuff. 727 void CachingLex(Token &Result); 728 bool InCachingLexMode() const { return CurPPLexer == 0 && CurTokenLexer == 0;} 729 void EnterCachingLexMode(); 730 void ExitCachingLexMode() { 731 if (InCachingLexMode()) 732 RemoveTopOfLexerStack(); 733 } 734 const Token &PeekAhead(unsigned N); 735 void AnnotatePreviousCachedTokens(const Token &Tok); 736 737 //===--------------------------------------------------------------------===// 738 /// Handle*Directive - implement the various preprocessor directives. These 739 /// should side-effect the current preprocessor object so that the next call 740 /// to Lex() will return the appropriate token next. 741 void HandleLineDirective(Token &Tok); 742 void HandleDigitDirective(Token &Tok); 743 void HandleUserDiagnosticDirective(Token &Tok, bool isWarning); 744 void HandleIdentSCCSDirective(Token &Tok); 745 746 // File inclusion. 747 void HandleIncludeDirective(Token &Tok, 748 const DirectoryLookup *LookupFrom = 0, 749 bool isImport = false); 750 void HandleIncludeNextDirective(Token &Tok); 751 void HandleIncludeMacrosDirective(Token &Tok); 752 void HandleImportDirective(Token &Tok); 753 754 // Macro handling. 755 void HandleDefineDirective(Token &Tok); 756 void HandleUndefDirective(Token &Tok); 757 // HandleAssertDirective(Token &Tok); 758 // HandleUnassertDirective(Token &Tok); 759 760 // Conditional Inclusion. 761 void HandleIfdefDirective(Token &Tok, bool isIfndef, 762 bool ReadAnyTokensBeforeDirective); 763 void HandleIfDirective(Token &Tok, bool ReadAnyTokensBeforeDirective); 764 void HandleEndifDirective(Token &Tok); 765 void HandleElseDirective(Token &Tok); 766 void HandleElifDirective(Token &Tok); 767 768 // Pragmas. 769 void HandlePragmaDirective(); 770public: 771 void HandlePragmaOnce(Token &OnceTok); 772 void HandlePragmaMark(); 773 void HandlePragmaPoison(Token &PoisonTok); 774 void HandlePragmaSystemHeader(Token &SysHeaderTok); 775 void HandlePragmaDependency(Token &DependencyTok); 776 void HandlePragmaComment(Token &CommentTok); 777}; 778 779/// PreprocessorFactory - A generic factory interface for lazily creating 780/// Preprocessor objects on-demand when they are needed. 781class PreprocessorFactory { 782public: 783 virtual ~PreprocessorFactory(); 784 virtual Preprocessor* CreatePreprocessor() = 0; 785 virtual bool FinishInitialization(Preprocessor *PP); 786}; 787 788} // end namespace clang 789 790#endif 791