PPDirectives.cpp revision 4b7cac5d04dba8a6cda46ba05d6a79218557aa94
1//===--- PPDirectives.cpp - Directive Handling for Preprocessor -----------===// 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 implements # directive processing for the Preprocessor. 11// 12//===----------------------------------------------------------------------===// 13 14#include "clang/Lex/Preprocessor.h" 15#include "clang/Lex/LiteralSupport.h" 16#include "clang/Lex/HeaderSearch.h" 17#include "clang/Lex/MacroInfo.h" 18#include "clang/Lex/LexDiagnostic.h" 19#include "clang/Lex/CodeCompletionHandler.h" 20#include "clang/Lex/ModuleLoader.h" 21#include "clang/Lex/Pragma.h" 22#include "clang/Basic/FileManager.h" 23#include "clang/Basic/SourceManager.h" 24#include "llvm/ADT/APInt.h" 25#include "llvm/Support/ErrorHandling.h" 26using namespace clang; 27 28//===----------------------------------------------------------------------===// 29// Utility Methods for Preprocessor Directive Handling. 30//===----------------------------------------------------------------------===// 31 32MacroInfo *Preprocessor::AllocateMacroInfo() { 33 MacroInfoChain *MIChain; 34 35 if (MICache) { 36 MIChain = MICache; 37 MICache = MICache->Next; 38 } 39 else { 40 MIChain = BP.Allocate<MacroInfoChain>(); 41 } 42 43 MIChain->Next = MIChainHead; 44 MIChain->Prev = 0; 45 if (MIChainHead) 46 MIChainHead->Prev = MIChain; 47 MIChainHead = MIChain; 48 49 return &(MIChain->MI); 50} 51 52MacroInfo *Preprocessor::AllocateMacroInfo(SourceLocation L) { 53 MacroInfo *MI = AllocateMacroInfo(); 54 new (MI) MacroInfo(L); 55 return MI; 56} 57 58MacroInfo *Preprocessor::CloneMacroInfo(const MacroInfo &MacroToClone) { 59 MacroInfo *MI = AllocateMacroInfo(); 60 new (MI) MacroInfo(MacroToClone, BP); 61 return MI; 62} 63 64/// ReleaseMacroInfo - Release the specified MacroInfo. This memory will 65/// be reused for allocating new MacroInfo objects. 66void Preprocessor::ReleaseMacroInfo(MacroInfo *MI) { 67 MacroInfoChain *MIChain = (MacroInfoChain*) MI; 68 if (MacroInfoChain *Prev = MIChain->Prev) { 69 MacroInfoChain *Next = MIChain->Next; 70 Prev->Next = Next; 71 if (Next) 72 Next->Prev = Prev; 73 } 74 else { 75 assert(MIChainHead == MIChain); 76 MIChainHead = MIChain->Next; 77 MIChainHead->Prev = 0; 78 } 79 MIChain->Next = MICache; 80 MICache = MIChain; 81 82 MI->Destroy(); 83} 84 85/// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the 86/// current line until the tok::eod token is found. 87void Preprocessor::DiscardUntilEndOfDirective() { 88 Token Tmp; 89 do { 90 LexUnexpandedToken(Tmp); 91 assert(Tmp.isNot(tok::eof) && "EOF seen while discarding directive tokens"); 92 } while (Tmp.isNot(tok::eod)); 93} 94 95/// ReadMacroName - Lex and validate a macro name, which occurs after a 96/// #define or #undef. This sets the token kind to eod and discards the rest 97/// of the macro line if the macro name is invalid. isDefineUndef is 1 if 98/// this is due to a a #define, 2 if #undef directive, 0 if it is something 99/// else (e.g. #ifdef). 100void Preprocessor::ReadMacroName(Token &MacroNameTok, char isDefineUndef) { 101 // Read the token, don't allow macro expansion on it. 102 LexUnexpandedToken(MacroNameTok); 103 104 if (MacroNameTok.is(tok::code_completion)) { 105 if (CodeComplete) 106 CodeComplete->CodeCompleteMacroName(isDefineUndef == 1); 107 setCodeCompletionReached(); 108 LexUnexpandedToken(MacroNameTok); 109 } 110 111 // Missing macro name? 112 if (MacroNameTok.is(tok::eod)) { 113 Diag(MacroNameTok, diag::err_pp_missing_macro_name); 114 return; 115 } 116 117 IdentifierInfo *II = MacroNameTok.getIdentifierInfo(); 118 if (II == 0) { 119 bool Invalid = false; 120 std::string Spelling = getSpelling(MacroNameTok, &Invalid); 121 if (Invalid) 122 return; 123 124 const IdentifierInfo &Info = Identifiers.get(Spelling); 125 if (Info.isCPlusPlusOperatorKeyword()) 126 // C++ 2.5p2: Alternative tokens behave the same as its primary token 127 // except for their spellings. 128 Diag(MacroNameTok, diag::err_pp_operator_used_as_macro_name) << Spelling; 129 else 130 Diag(MacroNameTok, diag::err_pp_macro_not_identifier); 131 // Fall through on error. 132 } else if (isDefineUndef && II->getPPKeywordID() == tok::pp_defined) { 133 // Error if defining "defined": C99 6.10.8.4. 134 Diag(MacroNameTok, diag::err_defined_macro_name); 135 } else if (isDefineUndef && II->hasMacroDefinition() && 136 getMacroInfo(II)->isBuiltinMacro()) { 137 // Error if defining "__LINE__" and other builtins: C99 6.10.8.4. 138 if (isDefineUndef == 1) 139 Diag(MacroNameTok, diag::pp_redef_builtin_macro); 140 else 141 Diag(MacroNameTok, diag::pp_undef_builtin_macro); 142 } else { 143 // Okay, we got a good identifier node. Return it. 144 return; 145 } 146 147 // Invalid macro name, read and discard the rest of the line. Then set the 148 // token kind to tok::eod. 149 MacroNameTok.setKind(tok::eod); 150 return DiscardUntilEndOfDirective(); 151} 152 153/// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If 154/// not, emit a diagnostic and consume up until the eod. If EnableMacros is 155/// true, then we consider macros that expand to zero tokens as being ok. 156void Preprocessor::CheckEndOfDirective(const char *DirType, bool EnableMacros) { 157 Token Tmp; 158 // Lex unexpanded tokens for most directives: macros might expand to zero 159 // tokens, causing us to miss diagnosing invalid lines. Some directives (like 160 // #line) allow empty macros. 161 if (EnableMacros) 162 Lex(Tmp); 163 else 164 LexUnexpandedToken(Tmp); 165 166 // There should be no tokens after the directive, but we allow them as an 167 // extension. 168 while (Tmp.is(tok::comment)) // Skip comments in -C mode. 169 LexUnexpandedToken(Tmp); 170 171 if (Tmp.isNot(tok::eod)) { 172 // Add a fixit in GNU/C99/C++ mode. Don't offer a fixit for strict-C89, 173 // or if this is a macro-style preprocessing directive, because it is more 174 // trouble than it is worth to insert /**/ and check that there is no /**/ 175 // in the range also. 176 FixItHint Hint; 177 if ((Features.GNUMode || Features.C99 || Features.CPlusPlus) && 178 !CurTokenLexer) 179 Hint = FixItHint::CreateInsertion(Tmp.getLocation(),"//"); 180 Diag(Tmp, diag::ext_pp_extra_tokens_at_eol) << DirType << Hint; 181 DiscardUntilEndOfDirective(); 182 } 183} 184 185 186 187/// SkipExcludedConditionalBlock - We just read a #if or related directive and 188/// decided that the subsequent tokens are in the #if'd out portion of the 189/// file. Lex the rest of the file, until we see an #endif. If 190/// FoundNonSkipPortion is true, then we have already emitted code for part of 191/// this #if directive, so #else/#elif blocks should never be entered. If ElseOk 192/// is true, then #else directives are ok, if not, then we have already seen one 193/// so a #else directive is a duplicate. When this returns, the caller can lex 194/// the first valid token. 195void Preprocessor::SkipExcludedConditionalBlock(SourceLocation IfTokenLoc, 196 bool FoundNonSkipPortion, 197 bool FoundElse, 198 SourceLocation ElseLoc) { 199 ++NumSkipped; 200 assert(CurTokenLexer == 0 && CurPPLexer && "Lexing a macro, not a file?"); 201 202 CurPPLexer->pushConditionalLevel(IfTokenLoc, /*isSkipping*/false, 203 FoundNonSkipPortion, FoundElse); 204 205 if (CurPTHLexer) { 206 PTHSkipExcludedConditionalBlock(); 207 return; 208 } 209 210 // Enter raw mode to disable identifier lookup (and thus macro expansion), 211 // disabling warnings, etc. 212 CurPPLexer->LexingRawMode = true; 213 Token Tok; 214 while (1) { 215 CurLexer->Lex(Tok); 216 217 if (Tok.is(tok::code_completion)) { 218 if (CodeComplete) 219 CodeComplete->CodeCompleteInConditionalExclusion(); 220 setCodeCompletionReached(); 221 continue; 222 } 223 224 // If this is the end of the buffer, we have an error. 225 if (Tok.is(tok::eof)) { 226 // Emit errors for each unterminated conditional on the stack, including 227 // the current one. 228 while (!CurPPLexer->ConditionalStack.empty()) { 229 if (CurLexer->getFileLoc() != CodeCompletionFileLoc) 230 Diag(CurPPLexer->ConditionalStack.back().IfLoc, 231 diag::err_pp_unterminated_conditional); 232 CurPPLexer->ConditionalStack.pop_back(); 233 } 234 235 // Just return and let the caller lex after this #include. 236 break; 237 } 238 239 // If this token is not a preprocessor directive, just skip it. 240 if (Tok.isNot(tok::hash) || !Tok.isAtStartOfLine()) 241 continue; 242 243 // We just parsed a # character at the start of a line, so we're in 244 // directive mode. Tell the lexer this so any newlines we see will be 245 // converted into an EOD token (this terminates the macro). 246 CurPPLexer->ParsingPreprocessorDirective = true; 247 if (CurLexer) CurLexer->SetCommentRetentionState(false); 248 249 250 // Read the next token, the directive flavor. 251 LexUnexpandedToken(Tok); 252 253 // If this isn't an identifier directive (e.g. is "# 1\n" or "#\n", or 254 // something bogus), skip it. 255 if (Tok.isNot(tok::raw_identifier)) { 256 CurPPLexer->ParsingPreprocessorDirective = false; 257 // Restore comment saving mode. 258 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments); 259 continue; 260 } 261 262 // If the first letter isn't i or e, it isn't intesting to us. We know that 263 // this is safe in the face of spelling differences, because there is no way 264 // to spell an i/e in a strange way that is another letter. Skipping this 265 // allows us to avoid looking up the identifier info for #define/#undef and 266 // other common directives. 267 const char *RawCharData = Tok.getRawIdentifierData(); 268 269 char FirstChar = RawCharData[0]; 270 if (FirstChar >= 'a' && FirstChar <= 'z' && 271 FirstChar != 'i' && FirstChar != 'e') { 272 CurPPLexer->ParsingPreprocessorDirective = false; 273 // Restore comment saving mode. 274 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments); 275 continue; 276 } 277 278 // Get the identifier name without trigraphs or embedded newlines. Note 279 // that we can't use Tok.getIdentifierInfo() because its lookup is disabled 280 // when skipping. 281 char DirectiveBuf[20]; 282 StringRef Directive; 283 if (!Tok.needsCleaning() && Tok.getLength() < 20) { 284 Directive = StringRef(RawCharData, Tok.getLength()); 285 } else { 286 std::string DirectiveStr = getSpelling(Tok); 287 unsigned IdLen = DirectiveStr.size(); 288 if (IdLen >= 20) { 289 CurPPLexer->ParsingPreprocessorDirective = false; 290 // Restore comment saving mode. 291 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments); 292 continue; 293 } 294 memcpy(DirectiveBuf, &DirectiveStr[0], IdLen); 295 Directive = StringRef(DirectiveBuf, IdLen); 296 } 297 298 if (Directive.startswith("if")) { 299 StringRef Sub = Directive.substr(2); 300 if (Sub.empty() || // "if" 301 Sub == "def" || // "ifdef" 302 Sub == "ndef") { // "ifndef" 303 // We know the entire #if/#ifdef/#ifndef block will be skipped, don't 304 // bother parsing the condition. 305 DiscardUntilEndOfDirective(); 306 CurPPLexer->pushConditionalLevel(Tok.getLocation(), /*wasskipping*/true, 307 /*foundnonskip*/false, 308 /*foundelse*/false); 309 310 if (Callbacks) 311 Callbacks->Endif(); 312 } 313 } else if (Directive[0] == 'e') { 314 StringRef Sub = Directive.substr(1); 315 if (Sub == "ndif") { // "endif" 316 CheckEndOfDirective("endif"); 317 PPConditionalInfo CondInfo; 318 CondInfo.WasSkipping = true; // Silence bogus warning. 319 bool InCond = CurPPLexer->popConditionalLevel(CondInfo); 320 (void)InCond; // Silence warning in no-asserts mode. 321 assert(!InCond && "Can't be skipping if not in a conditional!"); 322 323 // If we popped the outermost skipping block, we're done skipping! 324 if (!CondInfo.WasSkipping) 325 break; 326 } else if (Sub == "lse") { // "else". 327 // #else directive in a skipping conditional. If not in some other 328 // skipping conditional, and if #else hasn't already been seen, enter it 329 // as a non-skipping conditional. 330 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel(); 331 332 // If this is a #else with a #else before it, report the error. 333 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_else_after_else); 334 335 // Note that we've seen a #else in this conditional. 336 CondInfo.FoundElse = true; 337 338 if (Callbacks) 339 Callbacks->Else(); 340 341 // If the conditional is at the top level, and the #if block wasn't 342 // entered, enter the #else block now. 343 if (!CondInfo.WasSkipping && !CondInfo.FoundNonSkip) { 344 CondInfo.FoundNonSkip = true; 345 CheckEndOfDirective("else"); 346 break; 347 } else { 348 DiscardUntilEndOfDirective(); // C99 6.10p4. 349 } 350 } else if (Sub == "lif") { // "elif". 351 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel(); 352 353 bool ShouldEnter; 354 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation(); 355 // If this is in a skipping block or if we're already handled this #if 356 // block, don't bother parsing the condition. 357 if (CondInfo.WasSkipping || CondInfo.FoundNonSkip) { 358 DiscardUntilEndOfDirective(); 359 ShouldEnter = false; 360 } else { 361 // Restore the value of LexingRawMode so that identifiers are 362 // looked up, etc, inside the #elif expression. 363 assert(CurPPLexer->LexingRawMode && "We have to be skipping here!"); 364 CurPPLexer->LexingRawMode = false; 365 IdentifierInfo *IfNDefMacro = 0; 366 ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro); 367 CurPPLexer->LexingRawMode = true; 368 } 369 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation(); 370 371 // If this is a #elif with a #else before it, report the error. 372 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_elif_after_else); 373 374 if (Callbacks) 375 Callbacks->Elif(SourceRange(ConditionalBegin, ConditionalEnd)); 376 377 // If this condition is true, enter it! 378 if (ShouldEnter) { 379 CondInfo.FoundNonSkip = true; 380 break; 381 } 382 } 383 } 384 385 CurPPLexer->ParsingPreprocessorDirective = false; 386 // Restore comment saving mode. 387 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments); 388 } 389 390 // Finally, if we are out of the conditional (saw an #endif or ran off the end 391 // of the file, just stop skipping and return to lexing whatever came after 392 // the #if block. 393 CurPPLexer->LexingRawMode = false; 394 395 if (Callbacks) { 396 SourceLocation BeginLoc = ElseLoc.isValid() ? ElseLoc : IfTokenLoc; 397 Callbacks->SourceRangeSkipped(SourceRange(BeginLoc, Tok.getLocation())); 398 } 399} 400 401void Preprocessor::PTHSkipExcludedConditionalBlock() { 402 403 while (1) { 404 assert(CurPTHLexer); 405 assert(CurPTHLexer->LexingRawMode == false); 406 407 // Skip to the next '#else', '#elif', or #endif. 408 if (CurPTHLexer->SkipBlock()) { 409 // We have reached an #endif. Both the '#' and 'endif' tokens 410 // have been consumed by the PTHLexer. Just pop off the condition level. 411 PPConditionalInfo CondInfo; 412 bool InCond = CurPTHLexer->popConditionalLevel(CondInfo); 413 (void)InCond; // Silence warning in no-asserts mode. 414 assert(!InCond && "Can't be skipping if not in a conditional!"); 415 break; 416 } 417 418 // We have reached a '#else' or '#elif'. Lex the next token to get 419 // the directive flavor. 420 Token Tok; 421 LexUnexpandedToken(Tok); 422 423 // We can actually look up the IdentifierInfo here since we aren't in 424 // raw mode. 425 tok::PPKeywordKind K = Tok.getIdentifierInfo()->getPPKeywordID(); 426 427 if (K == tok::pp_else) { 428 // #else: Enter the else condition. We aren't in a nested condition 429 // since we skip those. We're always in the one matching the last 430 // blocked we skipped. 431 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel(); 432 // Note that we've seen a #else in this conditional. 433 CondInfo.FoundElse = true; 434 435 // If the #if block wasn't entered then enter the #else block now. 436 if (!CondInfo.FoundNonSkip) { 437 CondInfo.FoundNonSkip = true; 438 439 // Scan until the eod token. 440 CurPTHLexer->ParsingPreprocessorDirective = true; 441 DiscardUntilEndOfDirective(); 442 CurPTHLexer->ParsingPreprocessorDirective = false; 443 444 break; 445 } 446 447 // Otherwise skip this block. 448 continue; 449 } 450 451 assert(K == tok::pp_elif); 452 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel(); 453 454 // If this is a #elif with a #else before it, report the error. 455 if (CondInfo.FoundElse) 456 Diag(Tok, diag::pp_err_elif_after_else); 457 458 // If this is in a skipping block or if we're already handled this #if 459 // block, don't bother parsing the condition. We just skip this block. 460 if (CondInfo.FoundNonSkip) 461 continue; 462 463 // Evaluate the condition of the #elif. 464 IdentifierInfo *IfNDefMacro = 0; 465 CurPTHLexer->ParsingPreprocessorDirective = true; 466 bool ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro); 467 CurPTHLexer->ParsingPreprocessorDirective = false; 468 469 // If this condition is true, enter it! 470 if (ShouldEnter) { 471 CondInfo.FoundNonSkip = true; 472 break; 473 } 474 475 // Otherwise, skip this block and go to the next one. 476 continue; 477 } 478} 479 480/// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 481/// return null on failure. isAngled indicates whether the file reference is 482/// for system #include's or not (i.e. using <> instead of ""). 483const FileEntry *Preprocessor::LookupFile( 484 StringRef Filename, 485 bool isAngled, 486 const DirectoryLookup *FromDir, 487 const DirectoryLookup *&CurDir, 488 SmallVectorImpl<char> *SearchPath, 489 SmallVectorImpl<char> *RelativePath, 490 ModuleMap::Module **SuggestedModule, 491 bool SkipCache) { 492 // If the header lookup mechanism may be relative to the current file, pass in 493 // info about where the current file is. 494 const FileEntry *CurFileEnt = 0; 495 if (!FromDir) { 496 FileID FID = getCurrentFileLexer()->getFileID(); 497 CurFileEnt = SourceMgr.getFileEntryForID(FID); 498 499 // If there is no file entry associated with this file, it must be the 500 // predefines buffer. Any other file is not lexed with a normal lexer, so 501 // it won't be scanned for preprocessor directives. If we have the 502 // predefines buffer, resolve #include references (which come from the 503 // -include command line argument) as if they came from the main file, this 504 // affects file lookup etc. 505 if (CurFileEnt == 0) { 506 FID = SourceMgr.getMainFileID(); 507 CurFileEnt = SourceMgr.getFileEntryForID(FID); 508 } 509 } 510 511 // Do a standard file entry lookup. 512 CurDir = CurDirLookup; 513 const FileEntry *FE = HeaderInfo.LookupFile( 514 Filename, isAngled, FromDir, CurDir, CurFileEnt, 515 SearchPath, RelativePath, SuggestedModule, SkipCache); 516 if (FE) return FE; 517 518 // Otherwise, see if this is a subframework header. If so, this is relative 519 // to one of the headers on the #include stack. Walk the list of the current 520 // headers on the #include stack and pass them to HeaderInfo. 521 // FIXME: SuggestedModule! 522 if (IsFileLexer()) { 523 if ((CurFileEnt = SourceMgr.getFileEntryForID(CurPPLexer->getFileID()))) 524 if ((FE = HeaderInfo.LookupSubframeworkHeader(Filename, CurFileEnt, 525 SearchPath, RelativePath))) 526 return FE; 527 } 528 529 for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) { 530 IncludeStackInfo &ISEntry = IncludeMacroStack[e-i-1]; 531 if (IsFileLexer(ISEntry)) { 532 if ((CurFileEnt = 533 SourceMgr.getFileEntryForID(ISEntry.ThePPLexer->getFileID()))) 534 if ((FE = HeaderInfo.LookupSubframeworkHeader( 535 Filename, CurFileEnt, SearchPath, RelativePath))) 536 return FE; 537 } 538 } 539 540 // Otherwise, we really couldn't find the file. 541 return 0; 542} 543 544 545//===----------------------------------------------------------------------===// 546// Preprocessor Directive Handling. 547//===----------------------------------------------------------------------===// 548 549/// HandleDirective - This callback is invoked when the lexer sees a # token 550/// at the start of a line. This consumes the directive, modifies the 551/// lexer/preprocessor state, and advances the lexer(s) so that the next token 552/// read is the correct one. 553void Preprocessor::HandleDirective(Token &Result) { 554 // FIXME: Traditional: # with whitespace before it not recognized by K&R? 555 556 // We just parsed a # character at the start of a line, so we're in directive 557 // mode. Tell the lexer this so any newlines we see will be converted into an 558 // EOD token (which terminates the directive). 559 CurPPLexer->ParsingPreprocessorDirective = true; 560 561 ++NumDirectives; 562 563 // We are about to read a token. For the multiple-include optimization FA to 564 // work, we have to remember if we had read any tokens *before* this 565 // pp-directive. 566 bool ReadAnyTokensBeforeDirective =CurPPLexer->MIOpt.getHasReadAnyTokensVal(); 567 568 // Save the '#' token in case we need to return it later. 569 Token SavedHash = Result; 570 571 // Read the next token, the directive flavor. This isn't expanded due to 572 // C99 6.10.3p8. 573 LexUnexpandedToken(Result); 574 575 // C99 6.10.3p11: Is this preprocessor directive in macro invocation? e.g.: 576 // #define A(x) #x 577 // A(abc 578 // #warning blah 579 // def) 580 // If so, the user is relying on non-portable behavior, emit a diagnostic. 581 if (InMacroArgs) 582 Diag(Result, diag::ext_embedded_directive); 583 584TryAgain: 585 switch (Result.getKind()) { 586 case tok::eod: 587 return; // null directive. 588 case tok::comment: 589 // Handle stuff like "# /*foo*/ define X" in -E -C mode. 590 LexUnexpandedToken(Result); 591 goto TryAgain; 592 case tok::code_completion: 593 if (CodeComplete) 594 CodeComplete->CodeCompleteDirective( 595 CurPPLexer->getConditionalStackDepth() > 0); 596 setCodeCompletionReached(); 597 return; 598 case tok::numeric_constant: // # 7 GNU line marker directive. 599 if (getLangOptions().AsmPreprocessor) 600 break; // # 4 is not a preprocessor directive in .S files. 601 return HandleDigitDirective(Result); 602 default: 603 IdentifierInfo *II = Result.getIdentifierInfo(); 604 if (II == 0) break; // Not an identifier. 605 606 // Ask what the preprocessor keyword ID is. 607 switch (II->getPPKeywordID()) { 608 default: break; 609 // C99 6.10.1 - Conditional Inclusion. 610 case tok::pp_if: 611 return HandleIfDirective(Result, ReadAnyTokensBeforeDirective); 612 case tok::pp_ifdef: 613 return HandleIfdefDirective(Result, false, true/*not valid for miopt*/); 614 case tok::pp_ifndef: 615 return HandleIfdefDirective(Result, true, ReadAnyTokensBeforeDirective); 616 case tok::pp_elif: 617 return HandleElifDirective(Result); 618 case tok::pp_else: 619 return HandleElseDirective(Result); 620 case tok::pp_endif: 621 return HandleEndifDirective(Result); 622 623 // C99 6.10.2 - Source File Inclusion. 624 case tok::pp_include: 625 // Handle #include. 626 return HandleIncludeDirective(SavedHash.getLocation(), Result); 627 case tok::pp___include_macros: 628 // Handle -imacros. 629 return HandleIncludeMacrosDirective(SavedHash.getLocation(), Result); 630 631 // C99 6.10.3 - Macro Replacement. 632 case tok::pp_define: 633 return HandleDefineDirective(Result); 634 case tok::pp_undef: 635 return HandleUndefDirective(Result); 636 637 // C99 6.10.4 - Line Control. 638 case tok::pp_line: 639 return HandleLineDirective(Result); 640 641 // C99 6.10.5 - Error Directive. 642 case tok::pp_error: 643 return HandleUserDiagnosticDirective(Result, false); 644 645 // C99 6.10.6 - Pragma Directive. 646 case tok::pp_pragma: 647 return HandlePragmaDirective(PIK_HashPragma); 648 649 // GNU Extensions. 650 case tok::pp_import: 651 return HandleImportDirective(SavedHash.getLocation(), Result); 652 case tok::pp_include_next: 653 return HandleIncludeNextDirective(SavedHash.getLocation(), Result); 654 655 case tok::pp_warning: 656 Diag(Result, diag::ext_pp_warning_directive); 657 return HandleUserDiagnosticDirective(Result, true); 658 case tok::pp_ident: 659 return HandleIdentSCCSDirective(Result); 660 case tok::pp_sccs: 661 return HandleIdentSCCSDirective(Result); 662 case tok::pp_assert: 663 //isExtension = true; // FIXME: implement #assert 664 break; 665 case tok::pp_unassert: 666 //isExtension = true; // FIXME: implement #unassert 667 break; 668 669 case tok::pp___export_macro__: 670 return HandleMacroExportDirective(Result); 671 case tok::pp___private_macro__: 672 return HandleMacroPrivateDirective(Result); 673 } 674 break; 675 } 676 677 // If this is a .S file, treat unknown # directives as non-preprocessor 678 // directives. This is important because # may be a comment or introduce 679 // various pseudo-ops. Just return the # token and push back the following 680 // token to be lexed next time. 681 if (getLangOptions().AsmPreprocessor) { 682 Token *Toks = new Token[2]; 683 // Return the # and the token after it. 684 Toks[0] = SavedHash; 685 Toks[1] = Result; 686 687 // If the second token is a hashhash token, then we need to translate it to 688 // unknown so the token lexer doesn't try to perform token pasting. 689 if (Result.is(tok::hashhash)) 690 Toks[1].setKind(tok::unknown); 691 692 // Enter this token stream so that we re-lex the tokens. Make sure to 693 // enable macro expansion, in case the token after the # is an identifier 694 // that is expanded. 695 EnterTokenStream(Toks, 2, false, true); 696 return; 697 } 698 699 // If we reached here, the preprocessing token is not valid! 700 Diag(Result, diag::err_pp_invalid_directive); 701 702 // Read the rest of the PP line. 703 DiscardUntilEndOfDirective(); 704 705 // Okay, we're done parsing the directive. 706} 707 708/// GetLineValue - Convert a numeric token into an unsigned value, emitting 709/// Diagnostic DiagID if it is invalid, and returning the value in Val. 710static bool GetLineValue(Token &DigitTok, unsigned &Val, 711 unsigned DiagID, Preprocessor &PP) { 712 if (DigitTok.isNot(tok::numeric_constant)) { 713 PP.Diag(DigitTok, DiagID); 714 715 if (DigitTok.isNot(tok::eod)) 716 PP.DiscardUntilEndOfDirective(); 717 return true; 718 } 719 720 llvm::SmallString<64> IntegerBuffer; 721 IntegerBuffer.resize(DigitTok.getLength()); 722 const char *DigitTokBegin = &IntegerBuffer[0]; 723 bool Invalid = false; 724 unsigned ActualLength = PP.getSpelling(DigitTok, DigitTokBegin, &Invalid); 725 if (Invalid) 726 return true; 727 728 // Verify that we have a simple digit-sequence, and compute the value. This 729 // is always a simple digit string computed in decimal, so we do this manually 730 // here. 731 Val = 0; 732 for (unsigned i = 0; i != ActualLength; ++i) { 733 if (!isdigit(DigitTokBegin[i])) { 734 PP.Diag(PP.AdvanceToTokenCharacter(DigitTok.getLocation(), i), 735 diag::err_pp_line_digit_sequence); 736 PP.DiscardUntilEndOfDirective(); 737 return true; 738 } 739 740 unsigned NextVal = Val*10+(DigitTokBegin[i]-'0'); 741 if (NextVal < Val) { // overflow. 742 PP.Diag(DigitTok, DiagID); 743 PP.DiscardUntilEndOfDirective(); 744 return true; 745 } 746 Val = NextVal; 747 } 748 749 // Reject 0, this is needed both by #line numbers and flags. 750 if (Val == 0) { 751 PP.Diag(DigitTok, DiagID); 752 PP.DiscardUntilEndOfDirective(); 753 return true; 754 } 755 756 if (DigitTokBegin[0] == '0') 757 PP.Diag(DigitTok.getLocation(), diag::warn_pp_line_decimal); 758 759 return false; 760} 761 762/// HandleLineDirective - Handle #line directive: C99 6.10.4. The two 763/// acceptable forms are: 764/// # line digit-sequence 765/// # line digit-sequence "s-char-sequence" 766void Preprocessor::HandleLineDirective(Token &Tok) { 767 // Read the line # and string argument. Per C99 6.10.4p5, these tokens are 768 // expanded. 769 Token DigitTok; 770 Lex(DigitTok); 771 772 // Validate the number and convert it to an unsigned. 773 unsigned LineNo; 774 if (GetLineValue(DigitTok, LineNo, diag::err_pp_line_requires_integer,*this)) 775 return; 776 777 // Enforce C99 6.10.4p3: "The digit sequence shall not specify ... a 778 // number greater than 2147483647". C90 requires that the line # be <= 32767. 779 unsigned LineLimit = 32768U; 780 if (Features.C99 || Features.CPlusPlus0x) 781 LineLimit = 2147483648U; 782 if (LineNo >= LineLimit) 783 Diag(DigitTok, diag::ext_pp_line_too_big) << LineLimit; 784 else if (Features.CPlusPlus0x && LineNo >= 32768U) 785 Diag(DigitTok, diag::warn_cxx98_compat_pp_line_too_big); 786 787 int FilenameID = -1; 788 Token StrTok; 789 Lex(StrTok); 790 791 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a 792 // string followed by eod. 793 if (StrTok.is(tok::eod)) 794 ; // ok 795 else if (StrTok.isNot(tok::string_literal)) { 796 Diag(StrTok, diag::err_pp_line_invalid_filename); 797 DiscardUntilEndOfDirective(); 798 return; 799 } else { 800 // Parse and validate the string, converting it into a unique ID. 801 StringLiteralParser Literal(&StrTok, 1, *this); 802 assert(Literal.isAscii() && "Didn't allow wide strings in"); 803 if (Literal.hadError) 804 return DiscardUntilEndOfDirective(); 805 if (Literal.Pascal) { 806 Diag(StrTok, diag::err_pp_linemarker_invalid_filename); 807 return DiscardUntilEndOfDirective(); 808 } 809 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString()); 810 811 // Verify that there is nothing after the string, other than EOD. Because 812 // of C99 6.10.4p5, macros that expand to empty tokens are ok. 813 CheckEndOfDirective("line", true); 814 } 815 816 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID); 817 818 if (Callbacks) 819 Callbacks->FileChanged(CurPPLexer->getSourceLocation(), 820 PPCallbacks::RenameFile, 821 SrcMgr::C_User); 822} 823 824/// ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line 825/// marker directive. 826static bool ReadLineMarkerFlags(bool &IsFileEntry, bool &IsFileExit, 827 bool &IsSystemHeader, bool &IsExternCHeader, 828 Preprocessor &PP) { 829 unsigned FlagVal; 830 Token FlagTok; 831 PP.Lex(FlagTok); 832 if (FlagTok.is(tok::eod)) return false; 833 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP)) 834 return true; 835 836 if (FlagVal == 1) { 837 IsFileEntry = true; 838 839 PP.Lex(FlagTok); 840 if (FlagTok.is(tok::eod)) return false; 841 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP)) 842 return true; 843 } else if (FlagVal == 2) { 844 IsFileExit = true; 845 846 SourceManager &SM = PP.getSourceManager(); 847 // If we are leaving the current presumed file, check to make sure the 848 // presumed include stack isn't empty! 849 FileID CurFileID = 850 SM.getDecomposedExpansionLoc(FlagTok.getLocation()).first; 851 PresumedLoc PLoc = SM.getPresumedLoc(FlagTok.getLocation()); 852 if (PLoc.isInvalid()) 853 return true; 854 855 // If there is no include loc (main file) or if the include loc is in a 856 // different physical file, then we aren't in a "1" line marker flag region. 857 SourceLocation IncLoc = PLoc.getIncludeLoc(); 858 if (IncLoc.isInvalid() || 859 SM.getDecomposedExpansionLoc(IncLoc).first != CurFileID) { 860 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_pop); 861 PP.DiscardUntilEndOfDirective(); 862 return true; 863 } 864 865 PP.Lex(FlagTok); 866 if (FlagTok.is(tok::eod)) return false; 867 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP)) 868 return true; 869 } 870 871 // We must have 3 if there are still flags. 872 if (FlagVal != 3) { 873 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag); 874 PP.DiscardUntilEndOfDirective(); 875 return true; 876 } 877 878 IsSystemHeader = true; 879 880 PP.Lex(FlagTok); 881 if (FlagTok.is(tok::eod)) return false; 882 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP)) 883 return true; 884 885 // We must have 4 if there is yet another flag. 886 if (FlagVal != 4) { 887 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag); 888 PP.DiscardUntilEndOfDirective(); 889 return true; 890 } 891 892 IsExternCHeader = true; 893 894 PP.Lex(FlagTok); 895 if (FlagTok.is(tok::eod)) return false; 896 897 // There are no more valid flags here. 898 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag); 899 PP.DiscardUntilEndOfDirective(); 900 return true; 901} 902 903/// HandleDigitDirective - Handle a GNU line marker directive, whose syntax is 904/// one of the following forms: 905/// 906/// # 42 907/// # 42 "file" ('1' | '2')? 908/// # 42 "file" ('1' | '2')? '3' '4'? 909/// 910void Preprocessor::HandleDigitDirective(Token &DigitTok) { 911 // Validate the number and convert it to an unsigned. GNU does not have a 912 // line # limit other than it fit in 32-bits. 913 unsigned LineNo; 914 if (GetLineValue(DigitTok, LineNo, diag::err_pp_linemarker_requires_integer, 915 *this)) 916 return; 917 918 Token StrTok; 919 Lex(StrTok); 920 921 bool IsFileEntry = false, IsFileExit = false; 922 bool IsSystemHeader = false, IsExternCHeader = false; 923 int FilenameID = -1; 924 925 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a 926 // string followed by eod. 927 if (StrTok.is(tok::eod)) 928 ; // ok 929 else if (StrTok.isNot(tok::string_literal)) { 930 Diag(StrTok, diag::err_pp_linemarker_invalid_filename); 931 return DiscardUntilEndOfDirective(); 932 } else { 933 // Parse and validate the string, converting it into a unique ID. 934 StringLiteralParser Literal(&StrTok, 1, *this); 935 assert(Literal.isAscii() && "Didn't allow wide strings in"); 936 if (Literal.hadError) 937 return DiscardUntilEndOfDirective(); 938 if (Literal.Pascal) { 939 Diag(StrTok, diag::err_pp_linemarker_invalid_filename); 940 return DiscardUntilEndOfDirective(); 941 } 942 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString()); 943 944 // If a filename was present, read any flags that are present. 945 if (ReadLineMarkerFlags(IsFileEntry, IsFileExit, 946 IsSystemHeader, IsExternCHeader, *this)) 947 return; 948 } 949 950 // Create a line note with this information. 951 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID, 952 IsFileEntry, IsFileExit, 953 IsSystemHeader, IsExternCHeader); 954 955 // If the preprocessor has callbacks installed, notify them of the #line 956 // change. This is used so that the line marker comes out in -E mode for 957 // example. 958 if (Callbacks) { 959 PPCallbacks::FileChangeReason Reason = PPCallbacks::RenameFile; 960 if (IsFileEntry) 961 Reason = PPCallbacks::EnterFile; 962 else if (IsFileExit) 963 Reason = PPCallbacks::ExitFile; 964 SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User; 965 if (IsExternCHeader) 966 FileKind = SrcMgr::C_ExternCSystem; 967 else if (IsSystemHeader) 968 FileKind = SrcMgr::C_System; 969 970 Callbacks->FileChanged(CurPPLexer->getSourceLocation(), Reason, FileKind); 971 } 972} 973 974 975/// HandleUserDiagnosticDirective - Handle a #warning or #error directive. 976/// 977void Preprocessor::HandleUserDiagnosticDirective(Token &Tok, 978 bool isWarning) { 979 // PTH doesn't emit #warning or #error directives. 980 if (CurPTHLexer) 981 return CurPTHLexer->DiscardToEndOfLine(); 982 983 // Read the rest of the line raw. We do this because we don't want macros 984 // to be expanded and we don't require that the tokens be valid preprocessing 985 // tokens. For example, this is allowed: "#warning ` 'foo". GCC does 986 // collapse multiple consequtive white space between tokens, but this isn't 987 // specified by the standard. 988 std::string Message = CurLexer->ReadToEndOfLine(); 989 if (isWarning) 990 Diag(Tok, diag::pp_hash_warning) << Message; 991 else 992 Diag(Tok, diag::err_pp_hash_error) << Message; 993} 994 995/// HandleIdentSCCSDirective - Handle a #ident/#sccs directive. 996/// 997void Preprocessor::HandleIdentSCCSDirective(Token &Tok) { 998 // Yes, this directive is an extension. 999 Diag(Tok, diag::ext_pp_ident_directive); 1000 1001 // Read the string argument. 1002 Token StrTok; 1003 Lex(StrTok); 1004 1005 // If the token kind isn't a string, it's a malformed directive. 1006 if (StrTok.isNot(tok::string_literal) && 1007 StrTok.isNot(tok::wide_string_literal)) { 1008 Diag(StrTok, diag::err_pp_malformed_ident); 1009 if (StrTok.isNot(tok::eod)) 1010 DiscardUntilEndOfDirective(); 1011 return; 1012 } 1013 1014 // Verify that there is nothing after the string, other than EOD. 1015 CheckEndOfDirective("ident"); 1016 1017 if (Callbacks) { 1018 bool Invalid = false; 1019 std::string Str = getSpelling(StrTok, &Invalid); 1020 if (!Invalid) 1021 Callbacks->Ident(Tok.getLocation(), Str); 1022 } 1023} 1024 1025/// \brief Handle a #__export_macro__ directive. 1026void Preprocessor::HandleMacroExportDirective(Token &Tok) { 1027 Token MacroNameTok; 1028 ReadMacroName(MacroNameTok, 2); 1029 1030 // Error reading macro name? If so, diagnostic already issued. 1031 if (MacroNameTok.is(tok::eod)) 1032 return; 1033 1034 // Check to see if this is the last token on the #__export_macro__ line. 1035 CheckEndOfDirective("__export_macro__"); 1036 1037 // Okay, we finally have a valid identifier to undef. 1038 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo()); 1039 1040 // If the macro is not defined, this is an error. 1041 if (MI == 0) { 1042 Diag(MacroNameTok, diag::err_pp_visibility_non_macro) 1043 << MacroNameTok.getIdentifierInfo(); 1044 return; 1045 } 1046 1047 // Note that this macro has now been exported. 1048 MI->setVisibility(/*IsPublic=*/true, MacroNameTok.getLocation()); 1049 1050 // If this macro definition came from a PCH file, mark it 1051 // as having changed since serialization. 1052 if (MI->isFromAST()) 1053 MI->setChangedAfterLoad(); 1054} 1055 1056/// \brief Handle a #__private_macro__ directive. 1057void Preprocessor::HandleMacroPrivateDirective(Token &Tok) { 1058 Token MacroNameTok; 1059 ReadMacroName(MacroNameTok, 2); 1060 1061 // Error reading macro name? If so, diagnostic already issued. 1062 if (MacroNameTok.is(tok::eod)) 1063 return; 1064 1065 // Check to see if this is the last token on the #__private_macro__ line. 1066 CheckEndOfDirective("__private_macro__"); 1067 1068 // Okay, we finally have a valid identifier to undef. 1069 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo()); 1070 1071 // If the macro is not defined, this is an error. 1072 if (MI == 0) { 1073 Diag(MacroNameTok, diag::err_pp_visibility_non_macro) 1074 << MacroNameTok.getIdentifierInfo(); 1075 return; 1076 } 1077 1078 // Note that this macro has now been marked private. 1079 MI->setVisibility(/*IsPublic=*/false, MacroNameTok.getLocation()); 1080 1081 // If this macro definition came from a PCH file, mark it 1082 // as having changed since serialization. 1083 if (MI->isFromAST()) 1084 MI->setChangedAfterLoad(); 1085} 1086 1087//===----------------------------------------------------------------------===// 1088// Preprocessor Include Directive Handling. 1089//===----------------------------------------------------------------------===// 1090 1091/// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully 1092/// checked and spelled filename, e.g. as an operand of #include. This returns 1093/// true if the input filename was in <>'s or false if it were in ""'s. The 1094/// caller is expected to provide a buffer that is large enough to hold the 1095/// spelling of the filename, but is also expected to handle the case when 1096/// this method decides to use a different buffer. 1097bool Preprocessor::GetIncludeFilenameSpelling(SourceLocation Loc, 1098 StringRef &Buffer) { 1099 // Get the text form of the filename. 1100 assert(!Buffer.empty() && "Can't have tokens with empty spellings!"); 1101 1102 // Make sure the filename is <x> or "x". 1103 bool isAngled; 1104 if (Buffer[0] == '<') { 1105 if (Buffer.back() != '>') { 1106 Diag(Loc, diag::err_pp_expects_filename); 1107 Buffer = StringRef(); 1108 return true; 1109 } 1110 isAngled = true; 1111 } else if (Buffer[0] == '"') { 1112 if (Buffer.back() != '"') { 1113 Diag(Loc, diag::err_pp_expects_filename); 1114 Buffer = StringRef(); 1115 return true; 1116 } 1117 isAngled = false; 1118 } else { 1119 Diag(Loc, diag::err_pp_expects_filename); 1120 Buffer = StringRef(); 1121 return true; 1122 } 1123 1124 // Diagnose #include "" as invalid. 1125 if (Buffer.size() <= 2) { 1126 Diag(Loc, diag::err_pp_empty_filename); 1127 Buffer = StringRef(); 1128 return true; 1129 } 1130 1131 // Skip the brackets. 1132 Buffer = Buffer.substr(1, Buffer.size()-2); 1133 return isAngled; 1134} 1135 1136/// ConcatenateIncludeName - Handle cases where the #include name is expanded 1137/// from a macro as multiple tokens, which need to be glued together. This 1138/// occurs for code like: 1139/// #define FOO <a/b.h> 1140/// #include FOO 1141/// because in this case, "<a/b.h>" is returned as 7 tokens, not one. 1142/// 1143/// This code concatenates and consumes tokens up to the '>' token. It returns 1144/// false if the > was found, otherwise it returns true if it finds and consumes 1145/// the EOD marker. 1146bool Preprocessor::ConcatenateIncludeName( 1147 llvm::SmallString<128> &FilenameBuffer, 1148 SourceLocation &End) { 1149 Token CurTok; 1150 1151 Lex(CurTok); 1152 while (CurTok.isNot(tok::eod)) { 1153 End = CurTok.getLocation(); 1154 1155 // FIXME: Provide code completion for #includes. 1156 if (CurTok.is(tok::code_completion)) { 1157 setCodeCompletionReached(); 1158 Lex(CurTok); 1159 continue; 1160 } 1161 1162 // Append the spelling of this token to the buffer. If there was a space 1163 // before it, add it now. 1164 if (CurTok.hasLeadingSpace()) 1165 FilenameBuffer.push_back(' '); 1166 1167 // Get the spelling of the token, directly into FilenameBuffer if possible. 1168 unsigned PreAppendSize = FilenameBuffer.size(); 1169 FilenameBuffer.resize(PreAppendSize+CurTok.getLength()); 1170 1171 const char *BufPtr = &FilenameBuffer[PreAppendSize]; 1172 unsigned ActualLen = getSpelling(CurTok, BufPtr); 1173 1174 // If the token was spelled somewhere else, copy it into FilenameBuffer. 1175 if (BufPtr != &FilenameBuffer[PreAppendSize]) 1176 memcpy(&FilenameBuffer[PreAppendSize], BufPtr, ActualLen); 1177 1178 // Resize FilenameBuffer to the correct size. 1179 if (CurTok.getLength() != ActualLen) 1180 FilenameBuffer.resize(PreAppendSize+ActualLen); 1181 1182 // If we found the '>' marker, return success. 1183 if (CurTok.is(tok::greater)) 1184 return false; 1185 1186 Lex(CurTok); 1187 } 1188 1189 // If we hit the eod marker, emit an error and return true so that the caller 1190 // knows the EOD has been read. 1191 Diag(CurTok.getLocation(), diag::err_pp_expects_filename); 1192 return true; 1193} 1194 1195/// HandleIncludeDirective - The "#include" tokens have just been read, read the 1196/// file to be included from the lexer, then include it! This is a common 1197/// routine with functionality shared between #include, #include_next and 1198/// #import. LookupFrom is set when this is a #include_next directive, it 1199/// specifies the file to start searching from. 1200void Preprocessor::HandleIncludeDirective(SourceLocation HashLoc, 1201 Token &IncludeTok, 1202 const DirectoryLookup *LookupFrom, 1203 bool isImport) { 1204 1205 Token FilenameTok; 1206 CurPPLexer->LexIncludeFilename(FilenameTok); 1207 1208 // Reserve a buffer to get the spelling. 1209 llvm::SmallString<128> FilenameBuffer; 1210 StringRef Filename; 1211 SourceLocation End; 1212 SourceLocation CharEnd; // the end of this directive, in characters 1213 1214 switch (FilenameTok.getKind()) { 1215 case tok::eod: 1216 // If the token kind is EOD, the error has already been diagnosed. 1217 return; 1218 1219 case tok::angle_string_literal: 1220 case tok::string_literal: 1221 Filename = getSpelling(FilenameTok, FilenameBuffer); 1222 End = FilenameTok.getLocation(); 1223 CharEnd = End.getLocWithOffset(Filename.size()); 1224 break; 1225 1226 case tok::less: 1227 // This could be a <foo/bar.h> file coming from a macro expansion. In this 1228 // case, glue the tokens together into FilenameBuffer and interpret those. 1229 FilenameBuffer.push_back('<'); 1230 if (ConcatenateIncludeName(FilenameBuffer, End)) 1231 return; // Found <eod> but no ">"? Diagnostic already emitted. 1232 Filename = FilenameBuffer.str(); 1233 CharEnd = getLocForEndOfToken(End); 1234 break; 1235 default: 1236 Diag(FilenameTok.getLocation(), diag::err_pp_expects_filename); 1237 DiscardUntilEndOfDirective(); 1238 return; 1239 } 1240 1241 bool isAngled = 1242 GetIncludeFilenameSpelling(FilenameTok.getLocation(), Filename); 1243 // If GetIncludeFilenameSpelling set the start ptr to null, there was an 1244 // error. 1245 if (Filename.empty()) { 1246 DiscardUntilEndOfDirective(); 1247 return; 1248 } 1249 1250 // Verify that there is nothing after the filename, other than EOD. Note that 1251 // we allow macros that expand to nothing after the filename, because this 1252 // falls into the category of "#include pp-tokens new-line" specified in 1253 // C99 6.10.2p4. 1254 CheckEndOfDirective(IncludeTok.getIdentifierInfo()->getNameStart(), true); 1255 1256 // Check that we don't have infinite #include recursion. 1257 if (IncludeMacroStack.size() == MaxAllowedIncludeStackDepth-1) { 1258 Diag(FilenameTok, diag::err_pp_include_too_deep); 1259 return; 1260 } 1261 1262 // Complain about attempts to #include files in an audit pragma. 1263 if (PragmaARCCFCodeAuditedLoc.isValid()) { 1264 Diag(HashLoc, diag::err_pp_include_in_arc_cf_code_audited); 1265 Diag(PragmaARCCFCodeAuditedLoc, diag::note_pragma_entered_here); 1266 1267 // Immediately leave the pragma. 1268 PragmaARCCFCodeAuditedLoc = SourceLocation(); 1269 } 1270 1271 // Search include directories. 1272 const DirectoryLookup *CurDir; 1273 llvm::SmallString<1024> SearchPath; 1274 llvm::SmallString<1024> RelativePath; 1275 // We get the raw path only if we have 'Callbacks' to which we later pass 1276 // the path. 1277 ModuleMap::Module *SuggestedModule = 0; 1278 const FileEntry *File = LookupFile( 1279 Filename, isAngled, LookupFrom, CurDir, 1280 Callbacks ? &SearchPath : NULL, Callbacks ? &RelativePath : NULL, 1281 AutoModuleImport? &SuggestedModule : 0); 1282 1283 if (Callbacks) { 1284 if (!File) { 1285 // Give the clients a chance to recover. 1286 llvm::SmallString<128> RecoveryPath; 1287 if (Callbacks->FileNotFound(Filename, RecoveryPath)) { 1288 if (const DirectoryEntry *DE = FileMgr.getDirectory(RecoveryPath)) { 1289 // Add the recovery path to the list of search paths. 1290 DirectoryLookup DL(DE, SrcMgr::C_User, true, false); 1291 HeaderInfo.AddSearchPath(DL, isAngled); 1292 1293 // Try the lookup again, skipping the cache. 1294 File = LookupFile(Filename, isAngled, LookupFrom, CurDir, 0, 0, 1295 AutoModuleImport ? &SuggestedModule : 0, 1296 /*SkipCache*/true); 1297 } 1298 } 1299 } 1300 1301 // Notify the callback object that we've seen an inclusion directive. 1302 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled, File, 1303 End, SearchPath, RelativePath); 1304 } 1305 1306 if (File == 0) { 1307 if (!SuppressIncludeNotFoundError) 1308 Diag(FilenameTok, diag::err_pp_file_not_found) << Filename; 1309 return; 1310 } 1311 1312 // If we are supposed to import a module rather than including the header, 1313 // do so now. 1314 if (SuggestedModule) { 1315 // Compute the module access path corresponding to this module. 1316 // FIXME: Should we have a second loadModule() overload to avoid this 1317 // extra lookup step? 1318 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path; 1319 for (ModuleMap::Module *Mod = SuggestedModule; Mod; Mod = Mod->Parent) 1320 Path.push_back(std::make_pair(getIdentifierInfo(Mod->Name), 1321 FilenameTok.getLocation())); 1322 std::reverse(Path.begin(), Path.end()); 1323 1324 // Warn that we're replacing the include/import with a module import. 1325 llvm::SmallString<128> PathString; 1326 for (unsigned I = 0, N = Path.size(); I != N; ++I) { 1327 if (I) 1328 PathString += '.'; 1329 PathString += Path[I].first->getName(); 1330 } 1331 int IncludeKind = 0; 1332 1333 switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) { 1334 case tok::pp_include: 1335 IncludeKind = 0; 1336 break; 1337 1338 case tok::pp_import: 1339 IncludeKind = 1; 1340 break; 1341 1342 case tok::pp_include_next: 1343 IncludeKind = 2; 1344 break; 1345 1346 case tok::pp___include_macros: 1347 IncludeKind = 3; 1348 break; 1349 1350 default: 1351 llvm_unreachable("unknown include directive kind"); 1352 break; 1353 } 1354 1355 CharSourceRange ReplaceRange(SourceRange(HashLoc, CharEnd), 1356 /*IsTokenRange=*/false); 1357 Diag(HashLoc, diag::warn_auto_module_import) 1358 << IncludeKind << PathString 1359 << FixItHint::CreateReplacement(ReplaceRange, 1360 "__import_module__ " + PathString.str().str() + ";"); 1361 1362 // Load the module. 1363 // FIXME: Deal with __include_macros here. 1364 TheModuleLoader.loadModule(IncludeTok.getLocation(), Path); 1365 return; 1366 } 1367 1368 // The #included file will be considered to be a system header if either it is 1369 // in a system include directory, or if the #includer is a system include 1370 // header. 1371 SrcMgr::CharacteristicKind FileCharacter = 1372 std::max(HeaderInfo.getFileDirFlavor(File), 1373 SourceMgr.getFileCharacteristic(FilenameTok.getLocation())); 1374 1375 // Ask HeaderInfo if we should enter this #include file. If not, #including 1376 // this file will have no effect. 1377 if (!HeaderInfo.ShouldEnterIncludeFile(File, isImport)) { 1378 if (Callbacks) 1379 Callbacks->FileSkipped(*File, FilenameTok, FileCharacter); 1380 return; 1381 } 1382 1383 // Look up the file, create a File ID for it. 1384 FileID FID = SourceMgr.createFileID(File, FilenameTok.getLocation(), 1385 FileCharacter); 1386 assert(!FID.isInvalid() && "Expected valid file ID"); 1387 1388 // Finally, if all is good, enter the new file! 1389 EnterSourceFile(FID, CurDir, FilenameTok.getLocation()); 1390} 1391 1392/// HandleIncludeNextDirective - Implements #include_next. 1393/// 1394void Preprocessor::HandleIncludeNextDirective(SourceLocation HashLoc, 1395 Token &IncludeNextTok) { 1396 Diag(IncludeNextTok, diag::ext_pp_include_next_directive); 1397 1398 // #include_next is like #include, except that we start searching after 1399 // the current found directory. If we can't do this, issue a 1400 // diagnostic. 1401 const DirectoryLookup *Lookup = CurDirLookup; 1402 if (isInPrimaryFile()) { 1403 Lookup = 0; 1404 Diag(IncludeNextTok, diag::pp_include_next_in_primary); 1405 } else if (Lookup == 0) { 1406 Diag(IncludeNextTok, diag::pp_include_next_absolute_path); 1407 } else { 1408 // Start looking up in the next directory. 1409 ++Lookup; 1410 } 1411 1412 return HandleIncludeDirective(HashLoc, IncludeNextTok, Lookup); 1413} 1414 1415/// HandleImportDirective - Implements #import. 1416/// 1417void Preprocessor::HandleImportDirective(SourceLocation HashLoc, 1418 Token &ImportTok) { 1419 if (!Features.ObjC1) // #import is standard for ObjC. 1420 Diag(ImportTok, diag::ext_pp_import_directive); 1421 1422 return HandleIncludeDirective(HashLoc, ImportTok, 0, true); 1423} 1424 1425/// HandleIncludeMacrosDirective - The -imacros command line option turns into a 1426/// pseudo directive in the predefines buffer. This handles it by sucking all 1427/// tokens through the preprocessor and discarding them (only keeping the side 1428/// effects on the preprocessor). 1429void Preprocessor::HandleIncludeMacrosDirective(SourceLocation HashLoc, 1430 Token &IncludeMacrosTok) { 1431 // This directive should only occur in the predefines buffer. If not, emit an 1432 // error and reject it. 1433 SourceLocation Loc = IncludeMacrosTok.getLocation(); 1434 if (strcmp(SourceMgr.getBufferName(Loc), "<built-in>") != 0) { 1435 Diag(IncludeMacrosTok.getLocation(), 1436 diag::pp_include_macros_out_of_predefines); 1437 DiscardUntilEndOfDirective(); 1438 return; 1439 } 1440 1441 // Treat this as a normal #include for checking purposes. If this is 1442 // successful, it will push a new lexer onto the include stack. 1443 HandleIncludeDirective(HashLoc, IncludeMacrosTok, 0, false); 1444 1445 Token TmpTok; 1446 do { 1447 Lex(TmpTok); 1448 assert(TmpTok.isNot(tok::eof) && "Didn't find end of -imacros!"); 1449 } while (TmpTok.isNot(tok::hashhash)); 1450} 1451 1452//===----------------------------------------------------------------------===// 1453// Preprocessor Macro Directive Handling. 1454//===----------------------------------------------------------------------===// 1455 1456/// ReadMacroDefinitionArgList - The ( starting an argument list of a macro 1457/// definition has just been read. Lex the rest of the arguments and the 1458/// closing ), updating MI with what we learn. Return true if an error occurs 1459/// parsing the arg list. 1460bool Preprocessor::ReadMacroDefinitionArgList(MacroInfo *MI) { 1461 SmallVector<IdentifierInfo*, 32> Arguments; 1462 1463 Token Tok; 1464 while (1) { 1465 LexUnexpandedToken(Tok); 1466 switch (Tok.getKind()) { 1467 case tok::r_paren: 1468 // Found the end of the argument list. 1469 if (Arguments.empty()) // #define FOO() 1470 return false; 1471 // Otherwise we have #define FOO(A,) 1472 Diag(Tok, diag::err_pp_expected_ident_in_arg_list); 1473 return true; 1474 case tok::ellipsis: // #define X(... -> C99 varargs 1475 if (!Features.C99) 1476 Diag(Tok, Features.CPlusPlus0x ? 1477 diag::warn_cxx98_compat_variadic_macro : 1478 diag::ext_variadic_macro); 1479 1480 // Lex the token after the identifier. 1481 LexUnexpandedToken(Tok); 1482 if (Tok.isNot(tok::r_paren)) { 1483 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def); 1484 return true; 1485 } 1486 // Add the __VA_ARGS__ identifier as an argument. 1487 Arguments.push_back(Ident__VA_ARGS__); 1488 MI->setIsC99Varargs(); 1489 MI->setArgumentList(&Arguments[0], Arguments.size(), BP); 1490 return false; 1491 case tok::eod: // #define X( 1492 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def); 1493 return true; 1494 default: 1495 // Handle keywords and identifiers here to accept things like 1496 // #define Foo(for) for. 1497 IdentifierInfo *II = Tok.getIdentifierInfo(); 1498 if (II == 0) { 1499 // #define X(1 1500 Diag(Tok, diag::err_pp_invalid_tok_in_arg_list); 1501 return true; 1502 } 1503 1504 // If this is already used as an argument, it is used multiple times (e.g. 1505 // #define X(A,A. 1506 if (std::find(Arguments.begin(), Arguments.end(), II) != 1507 Arguments.end()) { // C99 6.10.3p6 1508 Diag(Tok, diag::err_pp_duplicate_name_in_arg_list) << II; 1509 return true; 1510 } 1511 1512 // Add the argument to the macro info. 1513 Arguments.push_back(II); 1514 1515 // Lex the token after the identifier. 1516 LexUnexpandedToken(Tok); 1517 1518 switch (Tok.getKind()) { 1519 default: // #define X(A B 1520 Diag(Tok, diag::err_pp_expected_comma_in_arg_list); 1521 return true; 1522 case tok::r_paren: // #define X(A) 1523 MI->setArgumentList(&Arguments[0], Arguments.size(), BP); 1524 return false; 1525 case tok::comma: // #define X(A, 1526 break; 1527 case tok::ellipsis: // #define X(A... -> GCC extension 1528 // Diagnose extension. 1529 Diag(Tok, diag::ext_named_variadic_macro); 1530 1531 // Lex the token after the identifier. 1532 LexUnexpandedToken(Tok); 1533 if (Tok.isNot(tok::r_paren)) { 1534 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def); 1535 return true; 1536 } 1537 1538 MI->setIsGNUVarargs(); 1539 MI->setArgumentList(&Arguments[0], Arguments.size(), BP); 1540 return false; 1541 } 1542 } 1543 } 1544} 1545 1546/// HandleDefineDirective - Implements #define. This consumes the entire macro 1547/// line then lets the caller lex the next real token. 1548void Preprocessor::HandleDefineDirective(Token &DefineTok) { 1549 ++NumDefined; 1550 1551 Token MacroNameTok; 1552 ReadMacroName(MacroNameTok, 1); 1553 1554 // Error reading macro name? If so, diagnostic already issued. 1555 if (MacroNameTok.is(tok::eod)) 1556 return; 1557 1558 Token LastTok = MacroNameTok; 1559 1560 // If we are supposed to keep comments in #defines, reenable comment saving 1561 // mode. 1562 if (CurLexer) CurLexer->SetCommentRetentionState(KeepMacroComments); 1563 1564 // Create the new macro. 1565 MacroInfo *MI = AllocateMacroInfo(MacroNameTok.getLocation()); 1566 1567 Token Tok; 1568 LexUnexpandedToken(Tok); 1569 1570 // If this is a function-like macro definition, parse the argument list, 1571 // marking each of the identifiers as being used as macro arguments. Also, 1572 // check other constraints on the first token of the macro body. 1573 if (Tok.is(tok::eod)) { 1574 // If there is no body to this macro, we have no special handling here. 1575 } else if (Tok.hasLeadingSpace()) { 1576 // This is a normal token with leading space. Clear the leading space 1577 // marker on the first token to get proper expansion. 1578 Tok.clearFlag(Token::LeadingSpace); 1579 } else if (Tok.is(tok::l_paren)) { 1580 // This is a function-like macro definition. Read the argument list. 1581 MI->setIsFunctionLike(); 1582 if (ReadMacroDefinitionArgList(MI)) { 1583 // Forget about MI. 1584 ReleaseMacroInfo(MI); 1585 // Throw away the rest of the line. 1586 if (CurPPLexer->ParsingPreprocessorDirective) 1587 DiscardUntilEndOfDirective(); 1588 return; 1589 } 1590 1591 // If this is a definition of a variadic C99 function-like macro, not using 1592 // the GNU named varargs extension, enabled __VA_ARGS__. 1593 1594 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro. 1595 // This gets unpoisoned where it is allowed. 1596 assert(Ident__VA_ARGS__->isPoisoned() && "__VA_ARGS__ should be poisoned!"); 1597 if (MI->isC99Varargs()) 1598 Ident__VA_ARGS__->setIsPoisoned(false); 1599 1600 // Read the first token after the arg list for down below. 1601 LexUnexpandedToken(Tok); 1602 } else if (Features.C99 || Features.CPlusPlus0x) { 1603 // C99 requires whitespace between the macro definition and the body. Emit 1604 // a diagnostic for something like "#define X+". 1605 Diag(Tok, diag::ext_c99_whitespace_required_after_macro_name); 1606 } else { 1607 // C90 6.8 TC1 says: "In the definition of an object-like macro, if the 1608 // first character of a replacement list is not a character required by 1609 // subclause 5.2.1, then there shall be white-space separation between the 1610 // identifier and the replacement list.". 5.2.1 lists this set: 1611 // "A-Za-z0-9!"#%&'()*+,_./:;<=>?[\]^_{|}~" as well as whitespace, which 1612 // is irrelevant here. 1613 bool isInvalid = false; 1614 if (Tok.is(tok::at)) // @ is not in the list above. 1615 isInvalid = true; 1616 else if (Tok.is(tok::unknown)) { 1617 // If we have an unknown token, it is something strange like "`". Since 1618 // all of valid characters would have lexed into a single character 1619 // token of some sort, we know this is not a valid case. 1620 isInvalid = true; 1621 } 1622 if (isInvalid) 1623 Diag(Tok, diag::ext_missing_whitespace_after_macro_name); 1624 else 1625 Diag(Tok, diag::warn_missing_whitespace_after_macro_name); 1626 } 1627 1628 if (!Tok.is(tok::eod)) 1629 LastTok = Tok; 1630 1631 // Read the rest of the macro body. 1632 if (MI->isObjectLike()) { 1633 // Object-like macros are very simple, just read their body. 1634 while (Tok.isNot(tok::eod)) { 1635 LastTok = Tok; 1636 MI->AddTokenToBody(Tok); 1637 // Get the next token of the macro. 1638 LexUnexpandedToken(Tok); 1639 } 1640 1641 } else { 1642 // Otherwise, read the body of a function-like macro. While we are at it, 1643 // check C99 6.10.3.2p1: ensure that # operators are followed by macro 1644 // parameters in function-like macro expansions. 1645 while (Tok.isNot(tok::eod)) { 1646 LastTok = Tok; 1647 1648 if (Tok.isNot(tok::hash)) { 1649 MI->AddTokenToBody(Tok); 1650 1651 // Get the next token of the macro. 1652 LexUnexpandedToken(Tok); 1653 continue; 1654 } 1655 1656 // Get the next token of the macro. 1657 LexUnexpandedToken(Tok); 1658 1659 // Check for a valid macro arg identifier. 1660 if (Tok.getIdentifierInfo() == 0 || 1661 MI->getArgumentNum(Tok.getIdentifierInfo()) == -1) { 1662 1663 // If this is assembler-with-cpp mode, we accept random gibberish after 1664 // the '#' because '#' is often a comment character. However, change 1665 // the kind of the token to tok::unknown so that the preprocessor isn't 1666 // confused. 1667 if (getLangOptions().AsmPreprocessor && Tok.isNot(tok::eod)) { 1668 LastTok.setKind(tok::unknown); 1669 } else { 1670 Diag(Tok, diag::err_pp_stringize_not_parameter); 1671 ReleaseMacroInfo(MI); 1672 1673 // Disable __VA_ARGS__ again. 1674 Ident__VA_ARGS__->setIsPoisoned(true); 1675 return; 1676 } 1677 } 1678 1679 // Things look ok, add the '#' and param name tokens to the macro. 1680 MI->AddTokenToBody(LastTok); 1681 MI->AddTokenToBody(Tok); 1682 LastTok = Tok; 1683 1684 // Get the next token of the macro. 1685 LexUnexpandedToken(Tok); 1686 } 1687 } 1688 1689 1690 // Disable __VA_ARGS__ again. 1691 Ident__VA_ARGS__->setIsPoisoned(true); 1692 1693 // Check that there is no paste (##) operator at the beginning or end of the 1694 // replacement list. 1695 unsigned NumTokens = MI->getNumTokens(); 1696 if (NumTokens != 0) { 1697 if (MI->getReplacementToken(0).is(tok::hashhash)) { 1698 Diag(MI->getReplacementToken(0), diag::err_paste_at_start); 1699 ReleaseMacroInfo(MI); 1700 return; 1701 } 1702 if (MI->getReplacementToken(NumTokens-1).is(tok::hashhash)) { 1703 Diag(MI->getReplacementToken(NumTokens-1), diag::err_paste_at_end); 1704 ReleaseMacroInfo(MI); 1705 return; 1706 } 1707 } 1708 1709 MI->setDefinitionEndLoc(LastTok.getLocation()); 1710 1711 // Finally, if this identifier already had a macro defined for it, verify that 1712 // the macro bodies are identical and free the old definition. 1713 if (MacroInfo *OtherMI = getMacroInfo(MacroNameTok.getIdentifierInfo())) { 1714 // It is very common for system headers to have tons of macro redefinitions 1715 // and for warnings to be disabled in system headers. If this is the case, 1716 // then don't bother calling MacroInfo::isIdenticalTo. 1717 if (!getDiagnostics().getSuppressSystemWarnings() || 1718 !SourceMgr.isInSystemHeader(DefineTok.getLocation())) { 1719 if (!OtherMI->isUsed() && OtherMI->isWarnIfUnused()) 1720 Diag(OtherMI->getDefinitionLoc(), diag::pp_macro_not_used); 1721 1722 // Macros must be identical. This means all tokens and whitespace 1723 // separation must be the same. C99 6.10.3.2. 1724 if (!OtherMI->isAllowRedefinitionsWithoutWarning() && 1725 !MI->isIdenticalTo(*OtherMI, *this)) { 1726 Diag(MI->getDefinitionLoc(), diag::ext_pp_macro_redef) 1727 << MacroNameTok.getIdentifierInfo(); 1728 Diag(OtherMI->getDefinitionLoc(), diag::note_previous_definition); 1729 } 1730 } 1731 if (OtherMI->isWarnIfUnused()) 1732 WarnUnusedMacroLocs.erase(OtherMI->getDefinitionLoc()); 1733 ReleaseMacroInfo(OtherMI); 1734 } 1735 1736 setMacroInfo(MacroNameTok.getIdentifierInfo(), MI); 1737 1738 assert(!MI->isUsed()); 1739 // If we need warning for not using the macro, add its location in the 1740 // warn-because-unused-macro set. If it gets used it will be removed from set. 1741 if (isInPrimaryFile() && // don't warn for include'd macros. 1742 Diags->getDiagnosticLevel(diag::pp_macro_not_used, 1743 MI->getDefinitionLoc()) != DiagnosticsEngine::Ignored) { 1744 MI->setIsWarnIfUnused(true); 1745 WarnUnusedMacroLocs.insert(MI->getDefinitionLoc()); 1746 } 1747 1748 // If the callbacks want to know, tell them about the macro definition. 1749 if (Callbacks) 1750 Callbacks->MacroDefined(MacroNameTok, MI); 1751} 1752 1753/// HandleUndefDirective - Implements #undef. 1754/// 1755void Preprocessor::HandleUndefDirective(Token &UndefTok) { 1756 ++NumUndefined; 1757 1758 Token MacroNameTok; 1759 ReadMacroName(MacroNameTok, 2); 1760 1761 // Error reading macro name? If so, diagnostic already issued. 1762 if (MacroNameTok.is(tok::eod)) 1763 return; 1764 1765 // Check to see if this is the last token on the #undef line. 1766 CheckEndOfDirective("undef"); 1767 1768 // Okay, we finally have a valid identifier to undef. 1769 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo()); 1770 1771 // If the macro is not defined, this is a noop undef, just return. 1772 if (MI == 0) return; 1773 1774 if (!MI->isUsed() && MI->isWarnIfUnused()) 1775 Diag(MI->getDefinitionLoc(), diag::pp_macro_not_used); 1776 1777 // If the callbacks want to know, tell them about the macro #undef. 1778 if (Callbacks) 1779 Callbacks->MacroUndefined(MacroNameTok, MI); 1780 1781 if (MI->isWarnIfUnused()) 1782 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc()); 1783 1784 // Free macro definition. 1785 ReleaseMacroInfo(MI); 1786 setMacroInfo(MacroNameTok.getIdentifierInfo(), 0); 1787} 1788 1789 1790//===----------------------------------------------------------------------===// 1791// Preprocessor Conditional Directive Handling. 1792//===----------------------------------------------------------------------===// 1793 1794/// HandleIfdefDirective - Implements the #ifdef/#ifndef directive. isIfndef is 1795/// true when this is a #ifndef directive. ReadAnyTokensBeforeDirective is true 1796/// if any tokens have been returned or pp-directives activated before this 1797/// #ifndef has been lexed. 1798/// 1799void Preprocessor::HandleIfdefDirective(Token &Result, bool isIfndef, 1800 bool ReadAnyTokensBeforeDirective) { 1801 ++NumIf; 1802 Token DirectiveTok = Result; 1803 1804 Token MacroNameTok; 1805 ReadMacroName(MacroNameTok); 1806 1807 // Error reading macro name? If so, diagnostic already issued. 1808 if (MacroNameTok.is(tok::eod)) { 1809 // Skip code until we get to #endif. This helps with recovery by not 1810 // emitting an error when the #endif is reached. 1811 SkipExcludedConditionalBlock(DirectiveTok.getLocation(), 1812 /*Foundnonskip*/false, /*FoundElse*/false); 1813 return; 1814 } 1815 1816 // Check to see if this is the last token on the #if[n]def line. 1817 CheckEndOfDirective(isIfndef ? "ifndef" : "ifdef"); 1818 1819 IdentifierInfo *MII = MacroNameTok.getIdentifierInfo(); 1820 MacroInfo *MI = getMacroInfo(MII); 1821 1822 if (CurPPLexer->getConditionalStackDepth() == 0) { 1823 // If the start of a top-level #ifdef and if the macro is not defined, 1824 // inform MIOpt that this might be the start of a proper include guard. 1825 // Otherwise it is some other form of unknown conditional which we can't 1826 // handle. 1827 if (!ReadAnyTokensBeforeDirective && MI == 0) { 1828 assert(isIfndef && "#ifdef shouldn't reach here"); 1829 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(MII); 1830 } else 1831 CurPPLexer->MIOpt.EnterTopLevelConditional(); 1832 } 1833 1834 // If there is a macro, process it. 1835 if (MI) // Mark it used. 1836 markMacroAsUsed(MI); 1837 1838 // Should we include the stuff contained by this directive? 1839 if (!MI == isIfndef) { 1840 // Yes, remember that we are inside a conditional, then lex the next token. 1841 CurPPLexer->pushConditionalLevel(DirectiveTok.getLocation(), 1842 /*wasskip*/false, /*foundnonskip*/true, 1843 /*foundelse*/false); 1844 } else { 1845 // No, skip the contents of this block. 1846 SkipExcludedConditionalBlock(DirectiveTok.getLocation(), 1847 /*Foundnonskip*/false, 1848 /*FoundElse*/false); 1849 } 1850 1851 if (Callbacks) { 1852 if (isIfndef) 1853 Callbacks->Ifndef(MacroNameTok); 1854 else 1855 Callbacks->Ifdef(MacroNameTok); 1856 } 1857} 1858 1859/// HandleIfDirective - Implements the #if directive. 1860/// 1861void Preprocessor::HandleIfDirective(Token &IfToken, 1862 bool ReadAnyTokensBeforeDirective) { 1863 ++NumIf; 1864 1865 // Parse and evaluate the conditional expression. 1866 IdentifierInfo *IfNDefMacro = 0; 1867 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation(); 1868 const bool ConditionalTrue = EvaluateDirectiveExpression(IfNDefMacro); 1869 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation(); 1870 1871 // If this condition is equivalent to #ifndef X, and if this is the first 1872 // directive seen, handle it for the multiple-include optimization. 1873 if (CurPPLexer->getConditionalStackDepth() == 0) { 1874 if (!ReadAnyTokensBeforeDirective && IfNDefMacro && ConditionalTrue) 1875 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(IfNDefMacro); 1876 else 1877 CurPPLexer->MIOpt.EnterTopLevelConditional(); 1878 } 1879 1880 // Should we include the stuff contained by this directive? 1881 if (ConditionalTrue) { 1882 // Yes, remember that we are inside a conditional, then lex the next token. 1883 CurPPLexer->pushConditionalLevel(IfToken.getLocation(), /*wasskip*/false, 1884 /*foundnonskip*/true, /*foundelse*/false); 1885 } else { 1886 // No, skip the contents of this block. 1887 SkipExcludedConditionalBlock(IfToken.getLocation(), /*Foundnonskip*/false, 1888 /*FoundElse*/false); 1889 } 1890 1891 if (Callbacks) 1892 Callbacks->If(SourceRange(ConditionalBegin, ConditionalEnd)); 1893} 1894 1895/// HandleEndifDirective - Implements the #endif directive. 1896/// 1897void Preprocessor::HandleEndifDirective(Token &EndifToken) { 1898 ++NumEndif; 1899 1900 // Check that this is the whole directive. 1901 CheckEndOfDirective("endif"); 1902 1903 PPConditionalInfo CondInfo; 1904 if (CurPPLexer->popConditionalLevel(CondInfo)) { 1905 // No conditionals on the stack: this is an #endif without an #if. 1906 Diag(EndifToken, diag::err_pp_endif_without_if); 1907 return; 1908 } 1909 1910 // If this the end of a top-level #endif, inform MIOpt. 1911 if (CurPPLexer->getConditionalStackDepth() == 0) 1912 CurPPLexer->MIOpt.ExitTopLevelConditional(); 1913 1914 assert(!CondInfo.WasSkipping && !CurPPLexer->LexingRawMode && 1915 "This code should only be reachable in the non-skipping case!"); 1916 1917 if (Callbacks) 1918 Callbacks->Endif(); 1919} 1920 1921/// HandleElseDirective - Implements the #else directive. 1922/// 1923void Preprocessor::HandleElseDirective(Token &Result) { 1924 ++NumElse; 1925 1926 // #else directive in a non-skipping conditional... start skipping. 1927 CheckEndOfDirective("else"); 1928 1929 PPConditionalInfo CI; 1930 if (CurPPLexer->popConditionalLevel(CI)) { 1931 Diag(Result, diag::pp_err_else_without_if); 1932 return; 1933 } 1934 1935 // If this is a top-level #else, inform the MIOpt. 1936 if (CurPPLexer->getConditionalStackDepth() == 0) 1937 CurPPLexer->MIOpt.EnterTopLevelConditional(); 1938 1939 // If this is a #else with a #else before it, report the error. 1940 if (CI.FoundElse) Diag(Result, diag::pp_err_else_after_else); 1941 1942 // Finally, skip the rest of the contents of this block. 1943 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true, 1944 /*FoundElse*/true, Result.getLocation()); 1945 1946 if (Callbacks) 1947 Callbacks->Else(); 1948} 1949 1950/// HandleElifDirective - Implements the #elif directive. 1951/// 1952void Preprocessor::HandleElifDirective(Token &ElifToken) { 1953 ++NumElse; 1954 1955 // #elif directive in a non-skipping conditional... start skipping. 1956 // We don't care what the condition is, because we will always skip it (since 1957 // the block immediately before it was included). 1958 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation(); 1959 DiscardUntilEndOfDirective(); 1960 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation(); 1961 1962 PPConditionalInfo CI; 1963 if (CurPPLexer->popConditionalLevel(CI)) { 1964 Diag(ElifToken, diag::pp_err_elif_without_if); 1965 return; 1966 } 1967 1968 // If this is a top-level #elif, inform the MIOpt. 1969 if (CurPPLexer->getConditionalStackDepth() == 0) 1970 CurPPLexer->MIOpt.EnterTopLevelConditional(); 1971 1972 // If this is a #elif with a #else before it, report the error. 1973 if (CI.FoundElse) Diag(ElifToken, diag::pp_err_elif_after_else); 1974 1975 // Finally, skip the rest of the contents of this block. 1976 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true, 1977 /*FoundElse*/CI.FoundElse, 1978 ElifToken.getLocation()); 1979 1980 if (Callbacks) 1981 Callbacks->Elif(SourceRange(ConditionalBegin, ConditionalEnd)); 1982} 1983