1 //===--- MacroExpansion.cpp - Top level Macro Expansion -------------------===// 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 the top level handling of macro expansion for the 11 // preprocessor. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "clang/Basic/Attributes.h" 16 #include "clang/Basic/FileManager.h" 17 #include "clang/Basic/IdentifierTable.h" 18 #include "clang/Basic/LLVM.h" 19 #include "clang/Basic/LangOptions.h" 20 #include "clang/Basic/ObjCRuntime.h" 21 #include "clang/Basic/SourceLocation.h" 22 #include "clang/Basic/TargetInfo.h" 23 #include "clang/Lex/CodeCompletionHandler.h" 24 #include "clang/Lex/DirectoryLookup.h" 25 #include "clang/Lex/ExternalPreprocessorSource.h" 26 #include "clang/Lex/LexDiagnostic.h" 27 #include "clang/Lex/MacroArgs.h" 28 #include "clang/Lex/MacroInfo.h" 29 #include "clang/Lex/Preprocessor.h" 30 #include "clang/Lex/PreprocessorLexer.h" 31 #include "clang/Lex/PTHLexer.h" 32 #include "clang/Lex/Token.h" 33 #include "llvm/ADT/ArrayRef.h" 34 #include "llvm/ADT/DenseMap.h" 35 #include "llvm/ADT/DenseSet.h" 36 #include "llvm/ADT/FoldingSet.h" 37 #include "llvm/ADT/None.h" 38 #include "llvm/ADT/Optional.h" 39 #include "llvm/ADT/SmallString.h" 40 #include "llvm/ADT/SmallVector.h" 41 #include "llvm/ADT/STLExtras.h" 42 #include "llvm/ADT/StringRef.h" 43 #include "llvm/ADT/StringSwitch.h" 44 #include "llvm/Config/llvm-config.h" 45 #include "llvm/Support/Casting.h" 46 #include "llvm/Support/ErrorHandling.h" 47 #include "llvm/Support/Format.h" 48 #include "llvm/Support/raw_ostream.h" 49 #include <algorithm> 50 #include <cassert> 51 #include <cstddef> 52 #include <cstring> 53 #include <ctime> 54 #include <string> 55 #include <tuple> 56 #include <utility> 57 58 using namespace clang; 59 60 MacroDirective * 61 Preprocessor::getLocalMacroDirectiveHistory(const IdentifierInfo *II) const { 62 if (!II->hadMacroDefinition()) 63 return nullptr; 64 auto Pos = CurSubmoduleState->Macros.find(II); 65 return Pos == CurSubmoduleState->Macros.end() ? nullptr 66 : Pos->second.getLatest(); 67 } 68 69 void Preprocessor::appendMacroDirective(IdentifierInfo *II, MacroDirective *MD){ 70 assert(MD && "MacroDirective should be non-zero!"); 71 assert(!MD->getPrevious() && "Already attached to a MacroDirective history."); 72 73 MacroState &StoredMD = CurSubmoduleState->Macros[II]; 74 auto *OldMD = StoredMD.getLatest(); 75 MD->setPrevious(OldMD); 76 StoredMD.setLatest(MD); 77 StoredMD.overrideActiveModuleMacros(*this, II); 78 79 if (needModuleMacros()) { 80 // Track that we created a new macro directive, so we know we should 81 // consider building a ModuleMacro for it when we get to the end of 82 // the module. 83 PendingModuleMacroNames.push_back(II); 84 } 85 86 // Set up the identifier as having associated macro history. 87 II->setHasMacroDefinition(true); 88 if (!MD->isDefined() && LeafModuleMacros.find(II) == LeafModuleMacros.end()) 89 II->setHasMacroDefinition(false); 90 if (II->isFromAST()) 91 II->setChangedSinceDeserialization(); 92 } 93 94 void Preprocessor::setLoadedMacroDirective(IdentifierInfo *II, 95 MacroDirective *ED, 96 MacroDirective *MD) { 97 // Normally, when a macro is defined, it goes through appendMacroDirective() 98 // above, which chains a macro to previous defines, undefs, etc. 99 // However, in a pch, the whole macro history up to the end of the pch is 100 // stored, so ASTReader goes through this function instead. 101 // However, built-in macros are already registered in the Preprocessor 102 // ctor, and ASTWriter stops writing the macro chain at built-in macros, 103 // so in that case the chain from the pch needs to be spliced to the existing 104 // built-in. 105 106 assert(II && MD); 107 MacroState &StoredMD = CurSubmoduleState->Macros[II]; 108 109 if (auto *OldMD = StoredMD.getLatest()) { 110 // shouldIgnoreMacro() in ASTWriter also stops at macros from the 111 // predefines buffer in module builds. However, in module builds, modules 112 // are loaded completely before predefines are processed, so StoredMD 113 // will be nullptr for them when they're loaded. StoredMD should only be 114 // non-nullptr for builtins read from a pch file. 115 assert(OldMD->getMacroInfo()->isBuiltinMacro() && 116 "only built-ins should have an entry here"); 117 assert(!OldMD->getPrevious() && "builtin should only have a single entry"); 118 ED->setPrevious(OldMD); 119 StoredMD.setLatest(MD); 120 } else { 121 StoredMD = MD; 122 } 123 124 // Setup the identifier as having associated macro history. 125 II->setHasMacroDefinition(true); 126 if (!MD->isDefined() && LeafModuleMacros.find(II) == LeafModuleMacros.end()) 127 II->setHasMacroDefinition(false); 128 } 129 130 ModuleMacro *Preprocessor::addModuleMacro(Module *Mod, IdentifierInfo *II, 131 MacroInfo *Macro, 132 ArrayRef<ModuleMacro *> Overrides, 133 bool &New) { 134 llvm::FoldingSetNodeID ID; 135 ModuleMacro::Profile(ID, Mod, II); 136 137 void *InsertPos; 138 if (auto *MM = ModuleMacros.FindNodeOrInsertPos(ID, InsertPos)) { 139 New = false; 140 return MM; 141 } 142 143 auto *MM = ModuleMacro::create(*this, Mod, II, Macro, Overrides); 144 ModuleMacros.InsertNode(MM, InsertPos); 145 146 // Each overridden macro is now overridden by one more macro. 147 bool HidAny = false; 148 for (auto *O : Overrides) { 149 HidAny |= (O->NumOverriddenBy == 0); 150 ++O->NumOverriddenBy; 151 } 152 153 // If we were the first overrider for any macro, it's no longer a leaf. 154 auto &LeafMacros = LeafModuleMacros[II]; 155 if (HidAny) { 156 LeafMacros.erase(std::remove_if(LeafMacros.begin(), LeafMacros.end(), 157 [](ModuleMacro *MM) { 158 return MM->NumOverriddenBy != 0; 159 }), 160 LeafMacros.end()); 161 } 162 163 // The new macro is always a leaf macro. 164 LeafMacros.push_back(MM); 165 // The identifier now has defined macros (that may or may not be visible). 166 II->setHasMacroDefinition(true); 167 168 New = true; 169 return MM; 170 } 171 172 ModuleMacro *Preprocessor::getModuleMacro(Module *Mod, IdentifierInfo *II) { 173 llvm::FoldingSetNodeID ID; 174 ModuleMacro::Profile(ID, Mod, II); 175 176 void *InsertPos; 177 return ModuleMacros.FindNodeOrInsertPos(ID, InsertPos); 178 } 179 180 void Preprocessor::updateModuleMacroInfo(const IdentifierInfo *II, 181 ModuleMacroInfo &Info) { 182 assert(Info.ActiveModuleMacrosGeneration != 183 CurSubmoduleState->VisibleModules.getGeneration() && 184 "don't need to update this macro name info"); 185 Info.ActiveModuleMacrosGeneration = 186 CurSubmoduleState->VisibleModules.getGeneration(); 187 188 auto Leaf = LeafModuleMacros.find(II); 189 if (Leaf == LeafModuleMacros.end()) { 190 // No imported macros at all: nothing to do. 191 return; 192 } 193 194 Info.ActiveModuleMacros.clear(); 195 196 // Every macro that's locally overridden is overridden by a visible macro. 197 llvm::DenseMap<ModuleMacro *, int> NumHiddenOverrides; 198 for (auto *O : Info.OverriddenMacros) 199 NumHiddenOverrides[O] = -1; 200 201 // Collect all macros that are not overridden by a visible macro. 202 llvm::SmallVector<ModuleMacro *, 16> Worklist; 203 for (auto *LeafMM : Leaf->second) { 204 assert(LeafMM->getNumOverridingMacros() == 0 && "leaf macro overridden"); 205 if (NumHiddenOverrides.lookup(LeafMM) == 0) 206 Worklist.push_back(LeafMM); 207 } 208 while (!Worklist.empty()) { 209 auto *MM = Worklist.pop_back_val(); 210 if (CurSubmoduleState->VisibleModules.isVisible(MM->getOwningModule())) { 211 // We only care about collecting definitions; undefinitions only act 212 // to override other definitions. 213 if (MM->getMacroInfo()) 214 Info.ActiveModuleMacros.push_back(MM); 215 } else { 216 for (auto *O : MM->overrides()) 217 if ((unsigned)++NumHiddenOverrides[O] == O->getNumOverridingMacros()) 218 Worklist.push_back(O); 219 } 220 } 221 // Our reverse postorder walk found the macros in reverse order. 222 std::reverse(Info.ActiveModuleMacros.begin(), Info.ActiveModuleMacros.end()); 223 224 // Determine whether the macro name is ambiguous. 225 MacroInfo *MI = nullptr; 226 bool IsSystemMacro = true; 227 bool IsAmbiguous = false; 228 if (auto *MD = Info.MD) { 229 while (MD && isa<VisibilityMacroDirective>(MD)) 230 MD = MD->getPrevious(); 231 if (auto *DMD = dyn_cast_or_null<DefMacroDirective>(MD)) { 232 MI = DMD->getInfo(); 233 IsSystemMacro &= SourceMgr.isInSystemHeader(DMD->getLocation()); 234 } 235 } 236 for (auto *Active : Info.ActiveModuleMacros) { 237 auto *NewMI = Active->getMacroInfo(); 238 239 // Before marking the macro as ambiguous, check if this is a case where 240 // both macros are in system headers. If so, we trust that the system 241 // did not get it wrong. This also handles cases where Clang's own 242 // headers have a different spelling of certain system macros: 243 // #define LONG_MAX __LONG_MAX__ (clang's limits.h) 244 // #define LONG_MAX 0x7fffffffffffffffL (system's limits.h) 245 // 246 // FIXME: Remove the defined-in-system-headers check. clang's limits.h 247 // overrides the system limits.h's macros, so there's no conflict here. 248 if (MI && NewMI != MI && 249 !MI->isIdenticalTo(*NewMI, *this, /*Syntactically=*/true)) 250 IsAmbiguous = true; 251 IsSystemMacro &= Active->getOwningModule()->IsSystem || 252 SourceMgr.isInSystemHeader(NewMI->getDefinitionLoc()); 253 MI = NewMI; 254 } 255 Info.IsAmbiguous = IsAmbiguous && !IsSystemMacro; 256 } 257 258 void Preprocessor::dumpMacroInfo(const IdentifierInfo *II) { 259 ArrayRef<ModuleMacro*> Leaf; 260 auto LeafIt = LeafModuleMacros.find(II); 261 if (LeafIt != LeafModuleMacros.end()) 262 Leaf = LeafIt->second; 263 const MacroState *State = nullptr; 264 auto Pos = CurSubmoduleState->Macros.find(II); 265 if (Pos != CurSubmoduleState->Macros.end()) 266 State = &Pos->second; 267 268 llvm::errs() << "MacroState " << State << " " << II->getNameStart(); 269 if (State && State->isAmbiguous(*this, II)) 270 llvm::errs() << " ambiguous"; 271 if (State && !State->getOverriddenMacros().empty()) { 272 llvm::errs() << " overrides"; 273 for (auto *O : State->getOverriddenMacros()) 274 llvm::errs() << " " << O->getOwningModule()->getFullModuleName(); 275 } 276 llvm::errs() << "\n"; 277 278 // Dump local macro directives. 279 for (auto *MD = State ? State->getLatest() : nullptr; MD; 280 MD = MD->getPrevious()) { 281 llvm::errs() << " "; 282 MD->dump(); 283 } 284 285 // Dump module macros. 286 llvm::DenseSet<ModuleMacro*> Active; 287 for (auto *MM : State ? State->getActiveModuleMacros(*this, II) : None) 288 Active.insert(MM); 289 llvm::DenseSet<ModuleMacro*> Visited; 290 llvm::SmallVector<ModuleMacro *, 16> Worklist(Leaf.begin(), Leaf.end()); 291 while (!Worklist.empty()) { 292 auto *MM = Worklist.pop_back_val(); 293 llvm::errs() << " ModuleMacro " << MM << " " 294 << MM->getOwningModule()->getFullModuleName(); 295 if (!MM->getMacroInfo()) 296 llvm::errs() << " undef"; 297 298 if (Active.count(MM)) 299 llvm::errs() << " active"; 300 else if (!CurSubmoduleState->VisibleModules.isVisible( 301 MM->getOwningModule())) 302 llvm::errs() << " hidden"; 303 else if (MM->getMacroInfo()) 304 llvm::errs() << " overridden"; 305 306 if (!MM->overrides().empty()) { 307 llvm::errs() << " overrides"; 308 for (auto *O : MM->overrides()) { 309 llvm::errs() << " " << O->getOwningModule()->getFullModuleName(); 310 if (Visited.insert(O).second) 311 Worklist.push_back(O); 312 } 313 } 314 llvm::errs() << "\n"; 315 if (auto *MI = MM->getMacroInfo()) { 316 llvm::errs() << " "; 317 MI->dump(); 318 llvm::errs() << "\n"; 319 } 320 } 321 } 322 323 /// RegisterBuiltinMacro - Register the specified identifier in the identifier 324 /// table and mark it as a builtin macro to be expanded. 325 static IdentifierInfo *RegisterBuiltinMacro(Preprocessor &PP, const char *Name){ 326 // Get the identifier. 327 IdentifierInfo *Id = PP.getIdentifierInfo(Name); 328 329 // Mark it as being a macro that is builtin. 330 MacroInfo *MI = PP.AllocateMacroInfo(SourceLocation()); 331 MI->setIsBuiltinMacro(); 332 PP.appendDefMacroDirective(Id, MI); 333 return Id; 334 } 335 336 /// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the 337 /// identifier table. 338 void Preprocessor::RegisterBuiltinMacros() { 339 Ident__LINE__ = RegisterBuiltinMacro(*this, "__LINE__"); 340 Ident__FILE__ = RegisterBuiltinMacro(*this, "__FILE__"); 341 Ident__DATE__ = RegisterBuiltinMacro(*this, "__DATE__"); 342 Ident__TIME__ = RegisterBuiltinMacro(*this, "__TIME__"); 343 Ident__COUNTER__ = RegisterBuiltinMacro(*this, "__COUNTER__"); 344 Ident_Pragma = RegisterBuiltinMacro(*this, "_Pragma"); 345 346 // C++ Standing Document Extensions. 347 if (LangOpts.CPlusPlus) 348 Ident__has_cpp_attribute = 349 RegisterBuiltinMacro(*this, "__has_cpp_attribute"); 350 else 351 Ident__has_cpp_attribute = nullptr; 352 353 // GCC Extensions. 354 Ident__BASE_FILE__ = RegisterBuiltinMacro(*this, "__BASE_FILE__"); 355 Ident__INCLUDE_LEVEL__ = RegisterBuiltinMacro(*this, "__INCLUDE_LEVEL__"); 356 Ident__TIMESTAMP__ = RegisterBuiltinMacro(*this, "__TIMESTAMP__"); 357 358 // Microsoft Extensions. 359 if (LangOpts.MicrosoftExt) { 360 Ident__identifier = RegisterBuiltinMacro(*this, "__identifier"); 361 Ident__pragma = RegisterBuiltinMacro(*this, "__pragma"); 362 } else { 363 Ident__identifier = nullptr; 364 Ident__pragma = nullptr; 365 } 366 367 // Clang Extensions. 368 Ident__has_feature = RegisterBuiltinMacro(*this, "__has_feature"); 369 Ident__has_extension = RegisterBuiltinMacro(*this, "__has_extension"); 370 Ident__has_builtin = RegisterBuiltinMacro(*this, "__has_builtin"); 371 Ident__has_attribute = RegisterBuiltinMacro(*this, "__has_attribute"); 372 Ident__has_declspec = RegisterBuiltinMacro(*this, "__has_declspec_attribute"); 373 Ident__has_include = RegisterBuiltinMacro(*this, "__has_include"); 374 Ident__has_include_next = RegisterBuiltinMacro(*this, "__has_include_next"); 375 Ident__has_warning = RegisterBuiltinMacro(*this, "__has_warning"); 376 Ident__is_identifier = RegisterBuiltinMacro(*this, "__is_identifier"); 377 378 // Modules. 379 Ident__building_module = RegisterBuiltinMacro(*this, "__building_module"); 380 if (!LangOpts.CurrentModule.empty()) 381 Ident__MODULE__ = RegisterBuiltinMacro(*this, "__MODULE__"); 382 else 383 Ident__MODULE__ = nullptr; 384 } 385 386 /// isTrivialSingleTokenExpansion - Return true if MI, which has a single token 387 /// in its expansion, currently expands to that token literally. 388 static bool isTrivialSingleTokenExpansion(const MacroInfo *MI, 389 const IdentifierInfo *MacroIdent, 390 Preprocessor &PP) { 391 IdentifierInfo *II = MI->getReplacementToken(0).getIdentifierInfo(); 392 393 // If the token isn't an identifier, it's always literally expanded. 394 if (!II) return true; 395 396 // If the information about this identifier is out of date, update it from 397 // the external source. 398 if (II->isOutOfDate()) 399 PP.getExternalSource()->updateOutOfDateIdentifier(*II); 400 401 // If the identifier is a macro, and if that macro is enabled, it may be 402 // expanded so it's not a trivial expansion. 403 if (auto *ExpansionMI = PP.getMacroInfo(II)) 404 if (ExpansionMI->isEnabled() && 405 // Fast expanding "#define X X" is ok, because X would be disabled. 406 II != MacroIdent) 407 return false; 408 409 // If this is an object-like macro invocation, it is safe to trivially expand 410 // it. 411 if (MI->isObjectLike()) return true; 412 413 // If this is a function-like macro invocation, it's safe to trivially expand 414 // as long as the identifier is not a macro argument. 415 return std::find(MI->arg_begin(), MI->arg_end(), II) == MI->arg_end(); 416 } 417 418 /// isNextPPTokenLParen - Determine whether the next preprocessor token to be 419 /// lexed is a '('. If so, consume the token and return true, if not, this 420 /// method should have no observable side-effect on the lexed tokens. 421 bool Preprocessor::isNextPPTokenLParen() { 422 // Do some quick tests for rejection cases. 423 unsigned Val; 424 if (CurLexer) 425 Val = CurLexer->isNextPPTokenLParen(); 426 else if (CurPTHLexer) 427 Val = CurPTHLexer->isNextPPTokenLParen(); 428 else 429 Val = CurTokenLexer->isNextTokenLParen(); 430 431 if (Val == 2) { 432 // We have run off the end. If it's a source file we don't 433 // examine enclosing ones (C99 5.1.1.2p4). Otherwise walk up the 434 // macro stack. 435 if (CurPPLexer) 436 return false; 437 for (const IncludeStackInfo &Entry : llvm::reverse(IncludeMacroStack)) { 438 if (Entry.TheLexer) 439 Val = Entry.TheLexer->isNextPPTokenLParen(); 440 else if (Entry.ThePTHLexer) 441 Val = Entry.ThePTHLexer->isNextPPTokenLParen(); 442 else 443 Val = Entry.TheTokenLexer->isNextTokenLParen(); 444 445 if (Val != 2) 446 break; 447 448 // Ran off the end of a source file? 449 if (Entry.ThePPLexer) 450 return false; 451 } 452 } 453 454 // Okay, if we know that the token is a '(', lex it and return. Otherwise we 455 // have found something that isn't a '(' or we found the end of the 456 // translation unit. In either case, return false. 457 return Val == 1; 458 } 459 460 /// HandleMacroExpandedIdentifier - If an identifier token is read that is to be 461 /// expanded as a macro, handle it and return the next token as 'Identifier'. 462 bool Preprocessor::HandleMacroExpandedIdentifier(Token &Identifier, 463 const MacroDefinition &M) { 464 MacroInfo *MI = M.getMacroInfo(); 465 466 // If this is a macro expansion in the "#if !defined(x)" line for the file, 467 // then the macro could expand to different things in other contexts, we need 468 // to disable the optimization in this case. 469 if (CurPPLexer) CurPPLexer->MIOpt.ExpandedMacro(); 470 471 // If this is a builtin macro, like __LINE__ or _Pragma, handle it specially. 472 if (MI->isBuiltinMacro()) { 473 if (Callbacks) 474 Callbacks->MacroExpands(Identifier, M, Identifier.getLocation(), 475 /*Args=*/nullptr); 476 ExpandBuiltinMacro(Identifier); 477 return true; 478 } 479 480 /// Args - If this is a function-like macro expansion, this contains, 481 /// for each macro argument, the list of tokens that were provided to the 482 /// invocation. 483 MacroArgs *Args = nullptr; 484 485 // Remember where the end of the expansion occurred. For an object-like 486 // macro, this is the identifier. For a function-like macro, this is the ')'. 487 SourceLocation ExpansionEnd = Identifier.getLocation(); 488 489 // If this is a function-like macro, read the arguments. 490 if (MI->isFunctionLike()) { 491 // Remember that we are now parsing the arguments to a macro invocation. 492 // Preprocessor directives used inside macro arguments are not portable, and 493 // this enables the warning. 494 InMacroArgs = true; 495 Args = ReadFunctionLikeMacroArgs(Identifier, MI, ExpansionEnd); 496 497 // Finished parsing args. 498 InMacroArgs = false; 499 500 // If there was an error parsing the arguments, bail out. 501 if (!Args) return true; 502 503 ++NumFnMacroExpanded; 504 } else { 505 ++NumMacroExpanded; 506 } 507 508 // Notice that this macro has been used. 509 markMacroAsUsed(MI); 510 511 // Remember where the token is expanded. 512 SourceLocation ExpandLoc = Identifier.getLocation(); 513 SourceRange ExpansionRange(ExpandLoc, ExpansionEnd); 514 515 if (Callbacks) { 516 if (InMacroArgs) { 517 // We can have macro expansion inside a conditional directive while 518 // reading the function macro arguments. To ensure, in that case, that 519 // MacroExpands callbacks still happen in source order, queue this 520 // callback to have it happen after the function macro callback. 521 DelayedMacroExpandsCallbacks.push_back( 522 MacroExpandsInfo(Identifier, M, ExpansionRange)); 523 } else { 524 Callbacks->MacroExpands(Identifier, M, ExpansionRange, Args); 525 if (!DelayedMacroExpandsCallbacks.empty()) { 526 for (const MacroExpandsInfo &Info : DelayedMacroExpandsCallbacks) { 527 // FIXME: We lose macro args info with delayed callback. 528 Callbacks->MacroExpands(Info.Tok, Info.MD, Info.Range, 529 /*Args=*/nullptr); 530 } 531 DelayedMacroExpandsCallbacks.clear(); 532 } 533 } 534 } 535 536 // If the macro definition is ambiguous, complain. 537 if (M.isAmbiguous()) { 538 Diag(Identifier, diag::warn_pp_ambiguous_macro) 539 << Identifier.getIdentifierInfo(); 540 Diag(MI->getDefinitionLoc(), diag::note_pp_ambiguous_macro_chosen) 541 << Identifier.getIdentifierInfo(); 542 M.forAllDefinitions([&](const MacroInfo *OtherMI) { 543 if (OtherMI != MI) 544 Diag(OtherMI->getDefinitionLoc(), diag::note_pp_ambiguous_macro_other) 545 << Identifier.getIdentifierInfo(); 546 }); 547 } 548 549 // If we started lexing a macro, enter the macro expansion body. 550 551 // If this macro expands to no tokens, don't bother to push it onto the 552 // expansion stack, only to take it right back off. 553 if (MI->getNumTokens() == 0) { 554 // No need for arg info. 555 if (Args) Args->destroy(*this); 556 557 // Propagate whitespace info as if we had pushed, then popped, 558 // a macro context. 559 Identifier.setFlag(Token::LeadingEmptyMacro); 560 PropagateLineStartLeadingSpaceInfo(Identifier); 561 ++NumFastMacroExpanded; 562 return false; 563 } else if (MI->getNumTokens() == 1 && 564 isTrivialSingleTokenExpansion(MI, Identifier.getIdentifierInfo(), 565 *this)) { 566 // Otherwise, if this macro expands into a single trivially-expanded 567 // token: expand it now. This handles common cases like 568 // "#define VAL 42". 569 570 // No need for arg info. 571 if (Args) Args->destroy(*this); 572 573 // Propagate the isAtStartOfLine/hasLeadingSpace markers of the macro 574 // identifier to the expanded token. 575 bool isAtStartOfLine = Identifier.isAtStartOfLine(); 576 bool hasLeadingSpace = Identifier.hasLeadingSpace(); 577 578 // Replace the result token. 579 Identifier = MI->getReplacementToken(0); 580 581 // Restore the StartOfLine/LeadingSpace markers. 582 Identifier.setFlagValue(Token::StartOfLine , isAtStartOfLine); 583 Identifier.setFlagValue(Token::LeadingSpace, hasLeadingSpace); 584 585 // Update the tokens location to include both its expansion and physical 586 // locations. 587 SourceLocation Loc = 588 SourceMgr.createExpansionLoc(Identifier.getLocation(), ExpandLoc, 589 ExpansionEnd,Identifier.getLength()); 590 Identifier.setLocation(Loc); 591 592 // If this is a disabled macro or #define X X, we must mark the result as 593 // unexpandable. 594 if (IdentifierInfo *NewII = Identifier.getIdentifierInfo()) { 595 if (MacroInfo *NewMI = getMacroInfo(NewII)) 596 if (!NewMI->isEnabled() || NewMI == MI) { 597 Identifier.setFlag(Token::DisableExpand); 598 // Don't warn for "#define X X" like "#define bool bool" from 599 // stdbool.h. 600 if (NewMI != MI || MI->isFunctionLike()) 601 Diag(Identifier, diag::pp_disabled_macro_expansion); 602 } 603 } 604 605 // Since this is not an identifier token, it can't be macro expanded, so 606 // we're done. 607 ++NumFastMacroExpanded; 608 return true; 609 } 610 611 // Start expanding the macro. 612 EnterMacro(Identifier, ExpansionEnd, MI, Args); 613 return false; 614 } 615 616 enum Bracket { 617 Brace, 618 Paren 619 }; 620 621 /// CheckMatchedBrackets - Returns true if the braces and parentheses in the 622 /// token vector are properly nested. 623 static bool CheckMatchedBrackets(const SmallVectorImpl<Token> &Tokens) { 624 SmallVector<Bracket, 8> Brackets; 625 for (SmallVectorImpl<Token>::const_iterator I = Tokens.begin(), 626 E = Tokens.end(); 627 I != E; ++I) { 628 if (I->is(tok::l_paren)) { 629 Brackets.push_back(Paren); 630 } else if (I->is(tok::r_paren)) { 631 if (Brackets.empty() || Brackets.back() == Brace) 632 return false; 633 Brackets.pop_back(); 634 } else if (I->is(tok::l_brace)) { 635 Brackets.push_back(Brace); 636 } else if (I->is(tok::r_brace)) { 637 if (Brackets.empty() || Brackets.back() == Paren) 638 return false; 639 Brackets.pop_back(); 640 } 641 } 642 return Brackets.empty(); 643 } 644 645 /// GenerateNewArgTokens - Returns true if OldTokens can be converted to a new 646 /// vector of tokens in NewTokens. The new number of arguments will be placed 647 /// in NumArgs and the ranges which need to surrounded in parentheses will be 648 /// in ParenHints. 649 /// Returns false if the token stream cannot be changed. If this is because 650 /// of an initializer list starting a macro argument, the range of those 651 /// initializer lists will be place in InitLists. 652 static bool GenerateNewArgTokens(Preprocessor &PP, 653 SmallVectorImpl<Token> &OldTokens, 654 SmallVectorImpl<Token> &NewTokens, 655 unsigned &NumArgs, 656 SmallVectorImpl<SourceRange> &ParenHints, 657 SmallVectorImpl<SourceRange> &InitLists) { 658 if (!CheckMatchedBrackets(OldTokens)) 659 return false; 660 661 // Once it is known that the brackets are matched, only a simple count of the 662 // braces is needed. 663 unsigned Braces = 0; 664 665 // First token of a new macro argument. 666 SmallVectorImpl<Token>::iterator ArgStartIterator = OldTokens.begin(); 667 668 // First closing brace in a new macro argument. Used to generate 669 // SourceRanges for InitLists. 670 SmallVectorImpl<Token>::iterator ClosingBrace = OldTokens.end(); 671 NumArgs = 0; 672 Token TempToken; 673 // Set to true when a macro separator token is found inside a braced list. 674 // If true, the fixed argument spans multiple old arguments and ParenHints 675 // will be updated. 676 bool FoundSeparatorToken = false; 677 for (SmallVectorImpl<Token>::iterator I = OldTokens.begin(), 678 E = OldTokens.end(); 679 I != E; ++I) { 680 if (I->is(tok::l_brace)) { 681 ++Braces; 682 } else if (I->is(tok::r_brace)) { 683 --Braces; 684 if (Braces == 0 && ClosingBrace == E && FoundSeparatorToken) 685 ClosingBrace = I; 686 } else if (I->is(tok::eof)) { 687 // EOF token is used to separate macro arguments 688 if (Braces != 0) { 689 // Assume comma separator is actually braced list separator and change 690 // it back to a comma. 691 FoundSeparatorToken = true; 692 I->setKind(tok::comma); 693 I->setLength(1); 694 } else { // Braces == 0 695 // Separator token still separates arguments. 696 ++NumArgs; 697 698 // If the argument starts with a brace, it can't be fixed with 699 // parentheses. A different diagnostic will be given. 700 if (FoundSeparatorToken && ArgStartIterator->is(tok::l_brace)) { 701 InitLists.push_back( 702 SourceRange(ArgStartIterator->getLocation(), 703 PP.getLocForEndOfToken(ClosingBrace->getLocation()))); 704 ClosingBrace = E; 705 } 706 707 // Add left paren 708 if (FoundSeparatorToken) { 709 TempToken.startToken(); 710 TempToken.setKind(tok::l_paren); 711 TempToken.setLocation(ArgStartIterator->getLocation()); 712 TempToken.setLength(0); 713 NewTokens.push_back(TempToken); 714 } 715 716 // Copy over argument tokens 717 NewTokens.insert(NewTokens.end(), ArgStartIterator, I); 718 719 // Add right paren and store the paren locations in ParenHints 720 if (FoundSeparatorToken) { 721 SourceLocation Loc = PP.getLocForEndOfToken((I - 1)->getLocation()); 722 TempToken.startToken(); 723 TempToken.setKind(tok::r_paren); 724 TempToken.setLocation(Loc); 725 TempToken.setLength(0); 726 NewTokens.push_back(TempToken); 727 ParenHints.push_back(SourceRange(ArgStartIterator->getLocation(), 728 Loc)); 729 } 730 731 // Copy separator token 732 NewTokens.push_back(*I); 733 734 // Reset values 735 ArgStartIterator = I + 1; 736 FoundSeparatorToken = false; 737 } 738 } 739 } 740 741 return !ParenHints.empty() && InitLists.empty(); 742 } 743 744 /// ReadFunctionLikeMacroArgs - After reading "MACRO" and knowing that the next 745 /// token is the '(' of the macro, this method is invoked to read all of the 746 /// actual arguments specified for the macro invocation. This returns null on 747 /// error. 748 MacroArgs *Preprocessor::ReadFunctionLikeMacroArgs(Token &MacroName, 749 MacroInfo *MI, 750 SourceLocation &MacroEnd) { 751 // The number of fixed arguments to parse. 752 unsigned NumFixedArgsLeft = MI->getNumArgs(); 753 bool isVariadic = MI->isVariadic(); 754 755 // Outer loop, while there are more arguments, keep reading them. 756 Token Tok; 757 758 // Read arguments as unexpanded tokens. This avoids issues, e.g., where 759 // an argument value in a macro could expand to ',' or '(' or ')'. 760 LexUnexpandedToken(Tok); 761 assert(Tok.is(tok::l_paren) && "Error computing l-paren-ness?"); 762 763 // ArgTokens - Build up a list of tokens that make up each argument. Each 764 // argument is separated by an EOF token. Use a SmallVector so we can avoid 765 // heap allocations in the common case. 766 SmallVector<Token, 64> ArgTokens; 767 bool ContainsCodeCompletionTok = false; 768 bool FoundElidedComma = false; 769 770 SourceLocation TooManyArgsLoc; 771 772 unsigned NumActuals = 0; 773 while (Tok.isNot(tok::r_paren)) { 774 if (ContainsCodeCompletionTok && Tok.isOneOf(tok::eof, tok::eod)) 775 break; 776 777 assert(Tok.isOneOf(tok::l_paren, tok::comma) && 778 "only expect argument separators here"); 779 780 size_t ArgTokenStart = ArgTokens.size(); 781 SourceLocation ArgStartLoc = Tok.getLocation(); 782 783 // C99 6.10.3p11: Keep track of the number of l_parens we have seen. Note 784 // that we already consumed the first one. 785 unsigned NumParens = 0; 786 787 while (true) { 788 // Read arguments as unexpanded tokens. This avoids issues, e.g., where 789 // an argument value in a macro could expand to ',' or '(' or ')'. 790 LexUnexpandedToken(Tok); 791 792 if (Tok.isOneOf(tok::eof, tok::eod)) { // "#if f(<eof>" & "#if f(\n" 793 if (!ContainsCodeCompletionTok) { 794 Diag(MacroName, diag::err_unterm_macro_invoc); 795 Diag(MI->getDefinitionLoc(), diag::note_macro_here) 796 << MacroName.getIdentifierInfo(); 797 // Do not lose the EOF/EOD. Return it to the client. 798 MacroName = Tok; 799 return nullptr; 800 } 801 // Do not lose the EOF/EOD. 802 auto Toks = llvm::make_unique<Token[]>(1); 803 Toks[0] = Tok; 804 EnterTokenStream(std::move(Toks), 1, true); 805 break; 806 } else if (Tok.is(tok::r_paren)) { 807 // If we found the ) token, the macro arg list is done. 808 if (NumParens-- == 0) { 809 MacroEnd = Tok.getLocation(); 810 if (!ArgTokens.empty() && 811 ArgTokens.back().commaAfterElided()) { 812 FoundElidedComma = true; 813 } 814 break; 815 } 816 } else if (Tok.is(tok::l_paren)) { 817 ++NumParens; 818 } else if (Tok.is(tok::comma) && NumParens == 0 && 819 !(Tok.getFlags() & Token::IgnoredComma)) { 820 // In Microsoft-compatibility mode, single commas from nested macro 821 // expansions should not be considered as argument separators. We test 822 // for this with the IgnoredComma token flag above. 823 824 // Comma ends this argument if there are more fixed arguments expected. 825 // However, if this is a variadic macro, and this is part of the 826 // variadic part, then the comma is just an argument token. 827 if (!isVariadic) break; 828 if (NumFixedArgsLeft > 1) 829 break; 830 } else if (Tok.is(tok::comment) && !KeepMacroComments) { 831 // If this is a comment token in the argument list and we're just in 832 // -C mode (not -CC mode), discard the comment. 833 continue; 834 } else if (!Tok.isAnnotation() && Tok.getIdentifierInfo() != nullptr) { 835 // Reading macro arguments can cause macros that we are currently 836 // expanding from to be popped off the expansion stack. Doing so causes 837 // them to be reenabled for expansion. Here we record whether any 838 // identifiers we lex as macro arguments correspond to disabled macros. 839 // If so, we mark the token as noexpand. This is a subtle aspect of 840 // C99 6.10.3.4p2. 841 if (MacroInfo *MI = getMacroInfo(Tok.getIdentifierInfo())) 842 if (!MI->isEnabled()) 843 Tok.setFlag(Token::DisableExpand); 844 } else if (Tok.is(tok::code_completion)) { 845 ContainsCodeCompletionTok = true; 846 if (CodeComplete) 847 CodeComplete->CodeCompleteMacroArgument(MacroName.getIdentifierInfo(), 848 MI, NumActuals); 849 // Don't mark that we reached the code-completion point because the 850 // parser is going to handle the token and there will be another 851 // code-completion callback. 852 } 853 854 ArgTokens.push_back(Tok); 855 } 856 857 // If this was an empty argument list foo(), don't add this as an empty 858 // argument. 859 if (ArgTokens.empty() && Tok.getKind() == tok::r_paren) 860 break; 861 862 // If this is not a variadic macro, and too many args were specified, emit 863 // an error. 864 if (!isVariadic && NumFixedArgsLeft == 0 && TooManyArgsLoc.isInvalid()) { 865 if (ArgTokens.size() != ArgTokenStart) 866 TooManyArgsLoc = ArgTokens[ArgTokenStart].getLocation(); 867 else 868 TooManyArgsLoc = ArgStartLoc; 869 } 870 871 // Empty arguments are standard in C99 and C++0x, and are supported as an 872 // extension in other modes. 873 if (ArgTokens.size() == ArgTokenStart && !LangOpts.C99) 874 Diag(Tok, LangOpts.CPlusPlus11 ? 875 diag::warn_cxx98_compat_empty_fnmacro_arg : 876 diag::ext_empty_fnmacro_arg); 877 878 // Add a marker EOF token to the end of the token list for this argument. 879 Token EOFTok; 880 EOFTok.startToken(); 881 EOFTok.setKind(tok::eof); 882 EOFTok.setLocation(Tok.getLocation()); 883 EOFTok.setLength(0); 884 ArgTokens.push_back(EOFTok); 885 ++NumActuals; 886 if (!ContainsCodeCompletionTok && NumFixedArgsLeft != 0) 887 --NumFixedArgsLeft; 888 } 889 890 // Okay, we either found the r_paren. Check to see if we parsed too few 891 // arguments. 892 unsigned MinArgsExpected = MI->getNumArgs(); 893 894 // If this is not a variadic macro, and too many args were specified, emit 895 // an error. 896 if (!isVariadic && NumActuals > MinArgsExpected && 897 !ContainsCodeCompletionTok) { 898 // Emit the diagnostic at the macro name in case there is a missing ). 899 // Emitting it at the , could be far away from the macro name. 900 Diag(TooManyArgsLoc, diag::err_too_many_args_in_macro_invoc); 901 Diag(MI->getDefinitionLoc(), diag::note_macro_here) 902 << MacroName.getIdentifierInfo(); 903 904 // Commas from braced initializer lists will be treated as argument 905 // separators inside macros. Attempt to correct for this with parentheses. 906 // TODO: See if this can be generalized to angle brackets for templates 907 // inside macro arguments. 908 909 SmallVector<Token, 4> FixedArgTokens; 910 unsigned FixedNumArgs = 0; 911 SmallVector<SourceRange, 4> ParenHints, InitLists; 912 if (!GenerateNewArgTokens(*this, ArgTokens, FixedArgTokens, FixedNumArgs, 913 ParenHints, InitLists)) { 914 if (!InitLists.empty()) { 915 DiagnosticBuilder DB = 916 Diag(MacroName, 917 diag::note_init_list_at_beginning_of_macro_argument); 918 for (SourceRange Range : InitLists) 919 DB << Range; 920 } 921 return nullptr; 922 } 923 if (FixedNumArgs != MinArgsExpected) 924 return nullptr; 925 926 DiagnosticBuilder DB = Diag(MacroName, diag::note_suggest_parens_for_macro); 927 for (SourceRange ParenLocation : ParenHints) { 928 DB << FixItHint::CreateInsertion(ParenLocation.getBegin(), "("); 929 DB << FixItHint::CreateInsertion(ParenLocation.getEnd(), ")"); 930 } 931 ArgTokens.swap(FixedArgTokens); 932 NumActuals = FixedNumArgs; 933 } 934 935 // See MacroArgs instance var for description of this. 936 bool isVarargsElided = false; 937 938 if (ContainsCodeCompletionTok) { 939 // Recover from not-fully-formed macro invocation during code-completion. 940 Token EOFTok; 941 EOFTok.startToken(); 942 EOFTok.setKind(tok::eof); 943 EOFTok.setLocation(Tok.getLocation()); 944 EOFTok.setLength(0); 945 for (; NumActuals < MinArgsExpected; ++NumActuals) 946 ArgTokens.push_back(EOFTok); 947 } 948 949 if (NumActuals < MinArgsExpected) { 950 // There are several cases where too few arguments is ok, handle them now. 951 if (NumActuals == 0 && MinArgsExpected == 1) { 952 // #define A(X) or #define A(...) ---> A() 953 954 // If there is exactly one argument, and that argument is missing, 955 // then we have an empty "()" argument empty list. This is fine, even if 956 // the macro expects one argument (the argument is just empty). 957 isVarargsElided = MI->isVariadic(); 958 } else if ((FoundElidedComma || MI->isVariadic()) && 959 (NumActuals+1 == MinArgsExpected || // A(x, ...) -> A(X) 960 (NumActuals == 0 && MinArgsExpected == 2))) {// A(x,...) -> A() 961 // Varargs where the named vararg parameter is missing: OK as extension. 962 // #define A(x, ...) 963 // A("blah") 964 // 965 // If the macro contains the comma pasting extension, the diagnostic 966 // is suppressed; we know we'll get another diagnostic later. 967 if (!MI->hasCommaPasting()) { 968 Diag(Tok, diag::ext_missing_varargs_arg); 969 Diag(MI->getDefinitionLoc(), diag::note_macro_here) 970 << MacroName.getIdentifierInfo(); 971 } 972 973 // Remember this occurred, allowing us to elide the comma when used for 974 // cases like: 975 // #define A(x, foo...) blah(a, ## foo) 976 // #define B(x, ...) blah(a, ## __VA_ARGS__) 977 // #define C(...) blah(a, ## __VA_ARGS__) 978 // A(x) B(x) C() 979 isVarargsElided = true; 980 } else if (!ContainsCodeCompletionTok) { 981 // Otherwise, emit the error. 982 Diag(Tok, diag::err_too_few_args_in_macro_invoc); 983 Diag(MI->getDefinitionLoc(), diag::note_macro_here) 984 << MacroName.getIdentifierInfo(); 985 return nullptr; 986 } 987 988 // Add a marker EOF token to the end of the token list for this argument. 989 SourceLocation EndLoc = Tok.getLocation(); 990 Tok.startToken(); 991 Tok.setKind(tok::eof); 992 Tok.setLocation(EndLoc); 993 Tok.setLength(0); 994 ArgTokens.push_back(Tok); 995 996 // If we expect two arguments, add both as empty. 997 if (NumActuals == 0 && MinArgsExpected == 2) 998 ArgTokens.push_back(Tok); 999 1000 } else if (NumActuals > MinArgsExpected && !MI->isVariadic() && 1001 !ContainsCodeCompletionTok) { 1002 // Emit the diagnostic at the macro name in case there is a missing ). 1003 // Emitting it at the , could be far away from the macro name. 1004 Diag(MacroName, diag::err_too_many_args_in_macro_invoc); 1005 Diag(MI->getDefinitionLoc(), diag::note_macro_here) 1006 << MacroName.getIdentifierInfo(); 1007 return nullptr; 1008 } 1009 1010 return MacroArgs::create(MI, ArgTokens, isVarargsElided, *this); 1011 } 1012 1013 /// \brief Keeps macro expanded tokens for TokenLexers. 1014 // 1015 /// Works like a stack; a TokenLexer adds the macro expanded tokens that is 1016 /// going to lex in the cache and when it finishes the tokens are removed 1017 /// from the end of the cache. 1018 Token *Preprocessor::cacheMacroExpandedTokens(TokenLexer *tokLexer, 1019 ArrayRef<Token> tokens) { 1020 assert(tokLexer); 1021 if (tokens.empty()) 1022 return nullptr; 1023 1024 size_t newIndex = MacroExpandedTokens.size(); 1025 bool cacheNeedsToGrow = tokens.size() > 1026 MacroExpandedTokens.capacity()-MacroExpandedTokens.size(); 1027 MacroExpandedTokens.append(tokens.begin(), tokens.end()); 1028 1029 if (cacheNeedsToGrow) { 1030 // Go through all the TokenLexers whose 'Tokens' pointer points in the 1031 // buffer and update the pointers to the (potential) new buffer array. 1032 for (const auto &Lexer : MacroExpandingLexersStack) { 1033 TokenLexer *prevLexer; 1034 size_t tokIndex; 1035 std::tie(prevLexer, tokIndex) = Lexer; 1036 prevLexer->Tokens = MacroExpandedTokens.data() + tokIndex; 1037 } 1038 } 1039 1040 MacroExpandingLexersStack.push_back(std::make_pair(tokLexer, newIndex)); 1041 return MacroExpandedTokens.data() + newIndex; 1042 } 1043 1044 void Preprocessor::removeCachedMacroExpandedTokensOfLastLexer() { 1045 assert(!MacroExpandingLexersStack.empty()); 1046 size_t tokIndex = MacroExpandingLexersStack.back().second; 1047 assert(tokIndex < MacroExpandedTokens.size()); 1048 // Pop the cached macro expanded tokens from the end. 1049 MacroExpandedTokens.resize(tokIndex); 1050 MacroExpandingLexersStack.pop_back(); 1051 } 1052 1053 /// ComputeDATE_TIME - Compute the current time, enter it into the specified 1054 /// scratch buffer, then return DATELoc/TIMELoc locations with the position of 1055 /// the identifier tokens inserted. 1056 static void ComputeDATE_TIME(SourceLocation &DATELoc, SourceLocation &TIMELoc, 1057 Preprocessor &PP) { 1058 time_t TT = time(nullptr); 1059 struct tm *TM = localtime(&TT); 1060 1061 static const char * const Months[] = { 1062 "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" 1063 }; 1064 1065 { 1066 SmallString<32> TmpBuffer; 1067 llvm::raw_svector_ostream TmpStream(TmpBuffer); 1068 TmpStream << llvm::format("\"%s %2d %4d\"", Months[TM->tm_mon], 1069 TM->tm_mday, TM->tm_year + 1900); 1070 Token TmpTok; 1071 TmpTok.startToken(); 1072 PP.CreateString(TmpStream.str(), TmpTok); 1073 DATELoc = TmpTok.getLocation(); 1074 } 1075 1076 { 1077 SmallString<32> TmpBuffer; 1078 llvm::raw_svector_ostream TmpStream(TmpBuffer); 1079 TmpStream << llvm::format("\"%02d:%02d:%02d\"", 1080 TM->tm_hour, TM->tm_min, TM->tm_sec); 1081 Token TmpTok; 1082 TmpTok.startToken(); 1083 PP.CreateString(TmpStream.str(), TmpTok); 1084 TIMELoc = TmpTok.getLocation(); 1085 } 1086 } 1087 1088 /// HasFeature - Return true if we recognize and implement the feature 1089 /// specified by the identifier as a standard language feature. 1090 static bool HasFeature(const Preprocessor &PP, StringRef Feature) { 1091 const LangOptions &LangOpts = PP.getLangOpts(); 1092 1093 // Normalize the feature name, __foo__ becomes foo. 1094 if (Feature.startswith("__") && Feature.endswith("__") && Feature.size() >= 4) 1095 Feature = Feature.substr(2, Feature.size() - 4); 1096 1097 return llvm::StringSwitch<bool>(Feature) 1098 .Case("address_sanitizer", 1099 LangOpts.Sanitize.hasOneOf(SanitizerKind::Address | 1100 SanitizerKind::KernelAddress)) 1101 .Case("assume_nonnull", true) 1102 .Case("attribute_analyzer_noreturn", true) 1103 .Case("attribute_availability", true) 1104 .Case("attribute_availability_with_message", true) 1105 .Case("attribute_availability_app_extension", true) 1106 .Case("attribute_availability_with_version_underscores", true) 1107 .Case("attribute_availability_tvos", true) 1108 .Case("attribute_availability_watchos", true) 1109 .Case("attribute_availability_with_strict", true) 1110 .Case("attribute_availability_with_replacement", true) 1111 .Case("attribute_availability_in_templates", true) 1112 .Case("attribute_cf_returns_not_retained", true) 1113 .Case("attribute_cf_returns_retained", true) 1114 .Case("attribute_cf_returns_on_parameters", true) 1115 .Case("attribute_deprecated_with_message", true) 1116 .Case("attribute_deprecated_with_replacement", true) 1117 .Case("attribute_ext_vector_type", true) 1118 .Case("attribute_ns_returns_not_retained", true) 1119 .Case("attribute_ns_returns_retained", true) 1120 .Case("attribute_ns_consumes_self", true) 1121 .Case("attribute_ns_consumed", true) 1122 .Case("attribute_cf_consumed", true) 1123 .Case("attribute_objc_ivar_unused", true) 1124 .Case("attribute_objc_method_family", true) 1125 .Case("attribute_overloadable", true) 1126 .Case("attribute_unavailable_with_message", true) 1127 .Case("attribute_unused_on_fields", true) 1128 .Case("blocks", LangOpts.Blocks) 1129 .Case("c_thread_safety_attributes", true) 1130 .Case("cxx_exceptions", LangOpts.CXXExceptions) 1131 .Case("cxx_rtti", LangOpts.RTTI && LangOpts.RTTIData) 1132 .Case("enumerator_attributes", true) 1133 .Case("nullability", true) 1134 .Case("nullability_on_arrays", true) 1135 .Case("memory_sanitizer", LangOpts.Sanitize.has(SanitizerKind::Memory)) 1136 .Case("thread_sanitizer", LangOpts.Sanitize.has(SanitizerKind::Thread)) 1137 .Case("dataflow_sanitizer", LangOpts.Sanitize.has(SanitizerKind::DataFlow)) 1138 .Case("efficiency_sanitizer", 1139 LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) 1140 // Objective-C features 1141 .Case("objc_arr", LangOpts.ObjCAutoRefCount) // FIXME: REMOVE? 1142 .Case("objc_arc", LangOpts.ObjCAutoRefCount) 1143 .Case("objc_arc_weak", LangOpts.ObjCWeak) 1144 .Case("objc_default_synthesize_properties", LangOpts.ObjC2) 1145 .Case("objc_fixed_enum", LangOpts.ObjC2) 1146 .Case("objc_instancetype", LangOpts.ObjC2) 1147 .Case("objc_kindof", LangOpts.ObjC2) 1148 .Case("objc_modules", LangOpts.ObjC2 && LangOpts.Modules) 1149 .Case("objc_nonfragile_abi", LangOpts.ObjCRuntime.isNonFragile()) 1150 .Case("objc_property_explicit_atomic", 1151 true) // Does clang support explicit "atomic" keyword? 1152 .Case("objc_protocol_qualifier_mangling", true) 1153 .Case("objc_weak_class", LangOpts.ObjCRuntime.hasWeakClassImport()) 1154 .Case("ownership_holds", true) 1155 .Case("ownership_returns", true) 1156 .Case("ownership_takes", true) 1157 .Case("objc_bool", true) 1158 .Case("objc_subscripting", LangOpts.ObjCRuntime.isNonFragile()) 1159 .Case("objc_array_literals", LangOpts.ObjC2) 1160 .Case("objc_dictionary_literals", LangOpts.ObjC2) 1161 .Case("objc_boxed_expressions", LangOpts.ObjC2) 1162 .Case("objc_boxed_nsvalue_expressions", LangOpts.ObjC2) 1163 .Case("arc_cf_code_audited", true) 1164 .Case("objc_bridge_id", true) 1165 .Case("objc_bridge_id_on_typedefs", true) 1166 .Case("objc_generics", LangOpts.ObjC2) 1167 .Case("objc_generics_variance", LangOpts.ObjC2) 1168 .Case("objc_class_property", LangOpts.ObjC2) 1169 // C11 features 1170 .Case("c_alignas", LangOpts.C11) 1171 .Case("c_alignof", LangOpts.C11) 1172 .Case("c_atomic", LangOpts.C11) 1173 .Case("c_generic_selections", LangOpts.C11) 1174 .Case("c_static_assert", LangOpts.C11) 1175 .Case("c_thread_local", 1176 LangOpts.C11 && PP.getTargetInfo().isTLSSupported()) 1177 // C++11 features 1178 .Case("cxx_access_control_sfinae", LangOpts.CPlusPlus11) 1179 .Case("cxx_alias_templates", LangOpts.CPlusPlus11) 1180 .Case("cxx_alignas", LangOpts.CPlusPlus11) 1181 .Case("cxx_alignof", LangOpts.CPlusPlus11) 1182 .Case("cxx_atomic", LangOpts.CPlusPlus11) 1183 .Case("cxx_attributes", LangOpts.CPlusPlus11) 1184 .Case("cxx_auto_type", LangOpts.CPlusPlus11) 1185 .Case("cxx_constexpr", LangOpts.CPlusPlus11) 1186 .Case("cxx_decltype", LangOpts.CPlusPlus11) 1187 .Case("cxx_decltype_incomplete_return_types", LangOpts.CPlusPlus11) 1188 .Case("cxx_default_function_template_args", LangOpts.CPlusPlus11) 1189 .Case("cxx_defaulted_functions", LangOpts.CPlusPlus11) 1190 .Case("cxx_delegating_constructors", LangOpts.CPlusPlus11) 1191 .Case("cxx_deleted_functions", LangOpts.CPlusPlus11) 1192 .Case("cxx_explicit_conversions", LangOpts.CPlusPlus11) 1193 .Case("cxx_generalized_initializers", LangOpts.CPlusPlus11) 1194 .Case("cxx_implicit_moves", LangOpts.CPlusPlus11) 1195 .Case("cxx_inheriting_constructors", LangOpts.CPlusPlus11) 1196 .Case("cxx_inline_namespaces", LangOpts.CPlusPlus11) 1197 .Case("cxx_lambdas", LangOpts.CPlusPlus11) 1198 .Case("cxx_local_type_template_args", LangOpts.CPlusPlus11) 1199 .Case("cxx_nonstatic_member_init", LangOpts.CPlusPlus11) 1200 .Case("cxx_noexcept", LangOpts.CPlusPlus11) 1201 .Case("cxx_nullptr", LangOpts.CPlusPlus11) 1202 .Case("cxx_override_control", LangOpts.CPlusPlus11) 1203 .Case("cxx_range_for", LangOpts.CPlusPlus11) 1204 .Case("cxx_raw_string_literals", LangOpts.CPlusPlus11) 1205 .Case("cxx_reference_qualified_functions", LangOpts.CPlusPlus11) 1206 .Case("cxx_rvalue_references", LangOpts.CPlusPlus11) 1207 .Case("cxx_strong_enums", LangOpts.CPlusPlus11) 1208 .Case("cxx_static_assert", LangOpts.CPlusPlus11) 1209 .Case("cxx_thread_local", 1210 LangOpts.CPlusPlus11 && PP.getTargetInfo().isTLSSupported()) 1211 .Case("cxx_trailing_return", LangOpts.CPlusPlus11) 1212 .Case("cxx_unicode_literals", LangOpts.CPlusPlus11) 1213 .Case("cxx_unrestricted_unions", LangOpts.CPlusPlus11) 1214 .Case("cxx_user_literals", LangOpts.CPlusPlus11) 1215 .Case("cxx_variadic_templates", LangOpts.CPlusPlus11) 1216 // C++14 features 1217 .Case("cxx_aggregate_nsdmi", LangOpts.CPlusPlus14) 1218 .Case("cxx_binary_literals", LangOpts.CPlusPlus14) 1219 .Case("cxx_contextual_conversions", LangOpts.CPlusPlus14) 1220 .Case("cxx_decltype_auto", LangOpts.CPlusPlus14) 1221 .Case("cxx_generic_lambdas", LangOpts.CPlusPlus14) 1222 .Case("cxx_init_captures", LangOpts.CPlusPlus14) 1223 .Case("cxx_relaxed_constexpr", LangOpts.CPlusPlus14) 1224 .Case("cxx_return_type_deduction", LangOpts.CPlusPlus14) 1225 .Case("cxx_variable_templates", LangOpts.CPlusPlus14) 1226 // NOTE: For features covered by SD-6, it is preferable to provide *only* 1227 // the SD-6 macro and not a __has_feature check. 1228 1229 // C++ TSes 1230 //.Case("cxx_runtime_arrays", LangOpts.CPlusPlusTSArrays) 1231 //.Case("cxx_concepts", LangOpts.CPlusPlusTSConcepts) 1232 // FIXME: Should this be __has_feature or __has_extension? 1233 //.Case("raw_invocation_type", LangOpts.CPlusPlus) 1234 // Type traits 1235 // N.B. Additional type traits should not be added to the following list. 1236 // Instead, they should be detected by has_extension. 1237 .Case("has_nothrow_assign", LangOpts.CPlusPlus) 1238 .Case("has_nothrow_copy", LangOpts.CPlusPlus) 1239 .Case("has_nothrow_constructor", LangOpts.CPlusPlus) 1240 .Case("has_trivial_assign", LangOpts.CPlusPlus) 1241 .Case("has_trivial_copy", LangOpts.CPlusPlus) 1242 .Case("has_trivial_constructor", LangOpts.CPlusPlus) 1243 .Case("has_trivial_destructor", LangOpts.CPlusPlus) 1244 .Case("has_virtual_destructor", LangOpts.CPlusPlus) 1245 .Case("is_abstract", LangOpts.CPlusPlus) 1246 .Case("is_base_of", LangOpts.CPlusPlus) 1247 .Case("is_class", LangOpts.CPlusPlus) 1248 .Case("is_constructible", LangOpts.CPlusPlus) 1249 .Case("is_convertible_to", LangOpts.CPlusPlus) 1250 .Case("is_empty", LangOpts.CPlusPlus) 1251 .Case("is_enum", LangOpts.CPlusPlus) 1252 .Case("is_final", LangOpts.CPlusPlus) 1253 .Case("is_literal", LangOpts.CPlusPlus) 1254 .Case("is_standard_layout", LangOpts.CPlusPlus) 1255 .Case("is_pod", LangOpts.CPlusPlus) 1256 .Case("is_polymorphic", LangOpts.CPlusPlus) 1257 .Case("is_sealed", LangOpts.CPlusPlus && LangOpts.MicrosoftExt) 1258 .Case("is_trivial", LangOpts.CPlusPlus) 1259 .Case("is_trivially_assignable", LangOpts.CPlusPlus) 1260 .Case("is_trivially_constructible", LangOpts.CPlusPlus) 1261 .Case("is_trivially_copyable", LangOpts.CPlusPlus) 1262 .Case("is_union", LangOpts.CPlusPlus) 1263 .Case("modules", LangOpts.Modules) 1264 .Case("safe_stack", LangOpts.Sanitize.has(SanitizerKind::SafeStack)) 1265 .Case("tls", PP.getTargetInfo().isTLSSupported()) 1266 .Case("underlying_type", LangOpts.CPlusPlus) 1267 .Default(false); 1268 } 1269 1270 /// HasExtension - Return true if we recognize and implement the feature 1271 /// specified by the identifier, either as an extension or a standard language 1272 /// feature. 1273 static bool HasExtension(const Preprocessor &PP, StringRef Extension) { 1274 if (HasFeature(PP, Extension)) 1275 return true; 1276 1277 // If the use of an extension results in an error diagnostic, extensions are 1278 // effectively unavailable, so just return false here. 1279 if (PP.getDiagnostics().getExtensionHandlingBehavior() >= 1280 diag::Severity::Error) 1281 return false; 1282 1283 const LangOptions &LangOpts = PP.getLangOpts(); 1284 1285 // Normalize the extension name, __foo__ becomes foo. 1286 if (Extension.startswith("__") && Extension.endswith("__") && 1287 Extension.size() >= 4) 1288 Extension = Extension.substr(2, Extension.size() - 4); 1289 1290 // Because we inherit the feature list from HasFeature, this string switch 1291 // must be less restrictive than HasFeature's. 1292 return llvm::StringSwitch<bool>(Extension) 1293 // C11 features supported by other languages as extensions. 1294 .Case("c_alignas", true) 1295 .Case("c_alignof", true) 1296 .Case("c_atomic", true) 1297 .Case("c_generic_selections", true) 1298 .Case("c_static_assert", true) 1299 .Case("c_thread_local", PP.getTargetInfo().isTLSSupported()) 1300 // C++11 features supported by other languages as extensions. 1301 .Case("cxx_atomic", LangOpts.CPlusPlus) 1302 .Case("cxx_deleted_functions", LangOpts.CPlusPlus) 1303 .Case("cxx_explicit_conversions", LangOpts.CPlusPlus) 1304 .Case("cxx_inline_namespaces", LangOpts.CPlusPlus) 1305 .Case("cxx_local_type_template_args", LangOpts.CPlusPlus) 1306 .Case("cxx_nonstatic_member_init", LangOpts.CPlusPlus) 1307 .Case("cxx_override_control", LangOpts.CPlusPlus) 1308 .Case("cxx_range_for", LangOpts.CPlusPlus) 1309 .Case("cxx_reference_qualified_functions", LangOpts.CPlusPlus) 1310 .Case("cxx_rvalue_references", LangOpts.CPlusPlus) 1311 .Case("cxx_variadic_templates", LangOpts.CPlusPlus) 1312 // C++14 features supported by other languages as extensions. 1313 .Case("cxx_binary_literals", true) 1314 .Case("cxx_init_captures", LangOpts.CPlusPlus11) 1315 .Case("cxx_variable_templates", LangOpts.CPlusPlus) 1316 .Default(false); 1317 } 1318 1319 /// EvaluateHasIncludeCommon - Process a '__has_include("path")' 1320 /// or '__has_include_next("path")' expression. 1321 /// Returns true if successful. 1322 static bool EvaluateHasIncludeCommon(Token &Tok, 1323 IdentifierInfo *II, Preprocessor &PP, 1324 const DirectoryLookup *LookupFrom, 1325 const FileEntry *LookupFromFile) { 1326 // Save the location of the current token. If a '(' is later found, use 1327 // that location. If not, use the end of this location instead. 1328 SourceLocation LParenLoc = Tok.getLocation(); 1329 1330 // These expressions are only allowed within a preprocessor directive. 1331 if (!PP.isParsingIfOrElifDirective()) { 1332 PP.Diag(LParenLoc, diag::err_pp_directive_required) << II->getName(); 1333 // Return a valid identifier token. 1334 assert(Tok.is(tok::identifier)); 1335 Tok.setIdentifierInfo(II); 1336 return false; 1337 } 1338 1339 // Get '('. 1340 PP.LexNonComment(Tok); 1341 1342 // Ensure we have a '('. 1343 if (Tok.isNot(tok::l_paren)) { 1344 // No '(', use end of last token. 1345 LParenLoc = PP.getLocForEndOfToken(LParenLoc); 1346 PP.Diag(LParenLoc, diag::err_pp_expected_after) << II << tok::l_paren; 1347 // If the next token looks like a filename or the start of one, 1348 // assume it is and process it as such. 1349 if (!Tok.is(tok::angle_string_literal) && !Tok.is(tok::string_literal) && 1350 !Tok.is(tok::less)) 1351 return false; 1352 } else { 1353 // Save '(' location for possible missing ')' message. 1354 LParenLoc = Tok.getLocation(); 1355 1356 if (PP.getCurrentLexer()) { 1357 // Get the file name. 1358 PP.getCurrentLexer()->LexIncludeFilename(Tok); 1359 } else { 1360 // We're in a macro, so we can't use LexIncludeFilename; just 1361 // grab the next token. 1362 PP.Lex(Tok); 1363 } 1364 } 1365 1366 // Reserve a buffer to get the spelling. 1367 SmallString<128> FilenameBuffer; 1368 StringRef Filename; 1369 SourceLocation EndLoc; 1370 1371 switch (Tok.getKind()) { 1372 case tok::eod: 1373 // If the token kind is EOD, the error has already been diagnosed. 1374 return false; 1375 1376 case tok::angle_string_literal: 1377 case tok::string_literal: { 1378 bool Invalid = false; 1379 Filename = PP.getSpelling(Tok, FilenameBuffer, &Invalid); 1380 if (Invalid) 1381 return false; 1382 break; 1383 } 1384 1385 case tok::less: 1386 // This could be a <foo/bar.h> file coming from a macro expansion. In this 1387 // case, glue the tokens together into FilenameBuffer and interpret those. 1388 FilenameBuffer.push_back('<'); 1389 if (PP.ConcatenateIncludeName(FilenameBuffer, EndLoc)) { 1390 // Let the caller know a <eod> was found by changing the Token kind. 1391 Tok.setKind(tok::eod); 1392 return false; // Found <eod> but no ">"? Diagnostic already emitted. 1393 } 1394 Filename = FilenameBuffer; 1395 break; 1396 default: 1397 PP.Diag(Tok.getLocation(), diag::err_pp_expects_filename); 1398 return false; 1399 } 1400 1401 SourceLocation FilenameLoc = Tok.getLocation(); 1402 1403 // Get ')'. 1404 PP.LexNonComment(Tok); 1405 1406 // Ensure we have a trailing ). 1407 if (Tok.isNot(tok::r_paren)) { 1408 PP.Diag(PP.getLocForEndOfToken(FilenameLoc), diag::err_pp_expected_after) 1409 << II << tok::r_paren; 1410 PP.Diag(LParenLoc, diag::note_matching) << tok::l_paren; 1411 return false; 1412 } 1413 1414 bool isAngled = PP.GetIncludeFilenameSpelling(Tok.getLocation(), Filename); 1415 // If GetIncludeFilenameSpelling set the start ptr to null, there was an 1416 // error. 1417 if (Filename.empty()) 1418 return false; 1419 1420 // Search include directories. 1421 const DirectoryLookup *CurDir; 1422 const FileEntry *File = 1423 PP.LookupFile(FilenameLoc, Filename, isAngled, LookupFrom, LookupFromFile, 1424 CurDir, nullptr, nullptr, nullptr); 1425 1426 // Get the result value. A result of true means the file exists. 1427 return File != nullptr; 1428 } 1429 1430 /// EvaluateHasInclude - Process a '__has_include("path")' expression. 1431 /// Returns true if successful. 1432 static bool EvaluateHasInclude(Token &Tok, IdentifierInfo *II, 1433 Preprocessor &PP) { 1434 return EvaluateHasIncludeCommon(Tok, II, PP, nullptr, nullptr); 1435 } 1436 1437 /// EvaluateHasIncludeNext - Process '__has_include_next("path")' expression. 1438 /// Returns true if successful. 1439 static bool EvaluateHasIncludeNext(Token &Tok, 1440 IdentifierInfo *II, Preprocessor &PP) { 1441 // __has_include_next is like __has_include, except that we start 1442 // searching after the current found directory. If we can't do this, 1443 // issue a diagnostic. 1444 // FIXME: Factor out duplication with 1445 // Preprocessor::HandleIncludeNextDirective. 1446 const DirectoryLookup *Lookup = PP.GetCurDirLookup(); 1447 const FileEntry *LookupFromFile = nullptr; 1448 if (PP.isInPrimaryFile() && PP.getLangOpts().IsHeaderFile) { 1449 // If the main file is a header, then it's either for PCH/AST generation, 1450 // or libclang opened it. Either way, handle it as a normal include below 1451 // and do not complain about __has_include_next. 1452 } else if (PP.isInPrimaryFile()) { 1453 Lookup = nullptr; 1454 PP.Diag(Tok, diag::pp_include_next_in_primary); 1455 } else if (PP.getCurrentSubmodule()) { 1456 // Start looking up in the directory *after* the one in which the current 1457 // file would be found, if any. 1458 assert(PP.getCurrentLexer() && "#include_next directive in macro?"); 1459 LookupFromFile = PP.getCurrentLexer()->getFileEntry(); 1460 Lookup = nullptr; 1461 } else if (!Lookup) { 1462 PP.Diag(Tok, diag::pp_include_next_absolute_path); 1463 } else { 1464 // Start looking up in the next directory. 1465 ++Lookup; 1466 } 1467 1468 return EvaluateHasIncludeCommon(Tok, II, PP, Lookup, LookupFromFile); 1469 } 1470 1471 /// \brief Process single-argument builtin feature-like macros that return 1472 /// integer values. 1473 static void EvaluateFeatureLikeBuiltinMacro(llvm::raw_svector_ostream& OS, 1474 Token &Tok, IdentifierInfo *II, 1475 Preprocessor &PP, 1476 llvm::function_ref< 1477 int(Token &Tok, 1478 bool &HasLexedNextTok)> Op) { 1479 // Parse the initial '('. 1480 PP.LexUnexpandedToken(Tok); 1481 if (Tok.isNot(tok::l_paren)) { 1482 PP.Diag(Tok.getLocation(), diag::err_pp_expected_after) << II 1483 << tok::l_paren; 1484 1485 // Provide a dummy '0' value on output stream to elide further errors. 1486 if (!Tok.isOneOf(tok::eof, tok::eod)) { 1487 OS << 0; 1488 Tok.setKind(tok::numeric_constant); 1489 } 1490 return; 1491 } 1492 1493 unsigned ParenDepth = 1; 1494 SourceLocation LParenLoc = Tok.getLocation(); 1495 llvm::Optional<int> Result; 1496 1497 Token ResultTok; 1498 bool SuppressDiagnostic = false; 1499 while (true) { 1500 // Parse next token. 1501 PP.LexUnexpandedToken(Tok); 1502 1503 already_lexed: 1504 switch (Tok.getKind()) { 1505 case tok::eof: 1506 case tok::eod: 1507 // Don't provide even a dummy value if the eod or eof marker is 1508 // reached. Simply provide a diagnostic. 1509 PP.Diag(Tok.getLocation(), diag::err_unterm_macro_invoc); 1510 return; 1511 1512 case tok::comma: 1513 if (!SuppressDiagnostic) { 1514 PP.Diag(Tok.getLocation(), diag::err_too_many_args_in_macro_invoc); 1515 SuppressDiagnostic = true; 1516 } 1517 continue; 1518 1519 case tok::l_paren: 1520 ++ParenDepth; 1521 if (Result.hasValue()) 1522 break; 1523 if (!SuppressDiagnostic) { 1524 PP.Diag(Tok.getLocation(), diag::err_pp_nested_paren) << II; 1525 SuppressDiagnostic = true; 1526 } 1527 continue; 1528 1529 case tok::r_paren: 1530 if (--ParenDepth > 0) 1531 continue; 1532 1533 // The last ')' has been reached; return the value if one found or 1534 // a diagnostic and a dummy value. 1535 if (Result.hasValue()) 1536 OS << Result.getValue(); 1537 else { 1538 OS << 0; 1539 if (!SuppressDiagnostic) 1540 PP.Diag(Tok.getLocation(), diag::err_too_few_args_in_macro_invoc); 1541 } 1542 Tok.setKind(tok::numeric_constant); 1543 return; 1544 1545 default: { 1546 // Parse the macro argument, if one not found so far. 1547 if (Result.hasValue()) 1548 break; 1549 1550 bool HasLexedNextToken = false; 1551 Result = Op(Tok, HasLexedNextToken); 1552 ResultTok = Tok; 1553 if (HasLexedNextToken) 1554 goto already_lexed; 1555 continue; 1556 } 1557 } 1558 1559 // Diagnose missing ')'. 1560 if (!SuppressDiagnostic) { 1561 if (auto Diag = PP.Diag(Tok.getLocation(), diag::err_pp_expected_after)) { 1562 if (IdentifierInfo *LastII = ResultTok.getIdentifierInfo()) 1563 Diag << LastII; 1564 else 1565 Diag << ResultTok.getKind(); 1566 Diag << tok::r_paren << ResultTok.getLocation(); 1567 } 1568 PP.Diag(LParenLoc, diag::note_matching) << tok::l_paren; 1569 SuppressDiagnostic = true; 1570 } 1571 } 1572 } 1573 1574 /// \brief Helper function to return the IdentifierInfo structure of a Token 1575 /// or generate a diagnostic if none available. 1576 static IdentifierInfo *ExpectFeatureIdentifierInfo(Token &Tok, 1577 Preprocessor &PP, 1578 signed DiagID) { 1579 IdentifierInfo *II; 1580 if (!Tok.isAnnotation() && (II = Tok.getIdentifierInfo())) 1581 return II; 1582 1583 PP.Diag(Tok.getLocation(), DiagID); 1584 return nullptr; 1585 } 1586 1587 /// ExpandBuiltinMacro - If an identifier token is read that is to be expanded 1588 /// as a builtin macro, handle it and return the next token as 'Tok'. 1589 void Preprocessor::ExpandBuiltinMacro(Token &Tok) { 1590 // Figure out which token this is. 1591 IdentifierInfo *II = Tok.getIdentifierInfo(); 1592 assert(II && "Can't be a macro without id info!"); 1593 1594 // If this is an _Pragma or Microsoft __pragma directive, expand it, 1595 // invoke the pragma handler, then lex the token after it. 1596 if (II == Ident_Pragma) 1597 return Handle_Pragma(Tok); 1598 else if (II == Ident__pragma) // in non-MS mode this is null 1599 return HandleMicrosoft__pragma(Tok); 1600 1601 ++NumBuiltinMacroExpanded; 1602 1603 SmallString<128> TmpBuffer; 1604 llvm::raw_svector_ostream OS(TmpBuffer); 1605 1606 // Set up the return result. 1607 Tok.setIdentifierInfo(nullptr); 1608 Tok.clearFlag(Token::NeedsCleaning); 1609 1610 if (II == Ident__LINE__) { 1611 // C99 6.10.8: "__LINE__: The presumed line number (within the current 1612 // source file) of the current source line (an integer constant)". This can 1613 // be affected by #line. 1614 SourceLocation Loc = Tok.getLocation(); 1615 1616 // Advance to the location of the first _, this might not be the first byte 1617 // of the token if it starts with an escaped newline. 1618 Loc = AdvanceToTokenCharacter(Loc, 0); 1619 1620 // One wrinkle here is that GCC expands __LINE__ to location of the *end* of 1621 // a macro expansion. This doesn't matter for object-like macros, but 1622 // can matter for a function-like macro that expands to contain __LINE__. 1623 // Skip down through expansion points until we find a file loc for the 1624 // end of the expansion history. 1625 Loc = SourceMgr.getExpansionRange(Loc).second; 1626 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Loc); 1627 1628 // __LINE__ expands to a simple numeric value. 1629 OS << (PLoc.isValid()? PLoc.getLine() : 1); 1630 Tok.setKind(tok::numeric_constant); 1631 } else if (II == Ident__FILE__ || II == Ident__BASE_FILE__) { 1632 // C99 6.10.8: "__FILE__: The presumed name of the current source file (a 1633 // character string literal)". This can be affected by #line. 1634 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation()); 1635 1636 // __BASE_FILE__ is a GNU extension that returns the top of the presumed 1637 // #include stack instead of the current file. 1638 if (II == Ident__BASE_FILE__ && PLoc.isValid()) { 1639 SourceLocation NextLoc = PLoc.getIncludeLoc(); 1640 while (NextLoc.isValid()) { 1641 PLoc = SourceMgr.getPresumedLoc(NextLoc); 1642 if (PLoc.isInvalid()) 1643 break; 1644 1645 NextLoc = PLoc.getIncludeLoc(); 1646 } 1647 } 1648 1649 // Escape this filename. Turn '\' -> '\\' '"' -> '\"' 1650 SmallString<128> FN; 1651 if (PLoc.isValid()) { 1652 FN += PLoc.getFilename(); 1653 Lexer::Stringify(FN); 1654 OS << '"' << FN << '"'; 1655 } 1656 Tok.setKind(tok::string_literal); 1657 } else if (II == Ident__DATE__) { 1658 Diag(Tok.getLocation(), diag::warn_pp_date_time); 1659 if (!DATELoc.isValid()) 1660 ComputeDATE_TIME(DATELoc, TIMELoc, *this); 1661 Tok.setKind(tok::string_literal); 1662 Tok.setLength(strlen("\"Mmm dd yyyy\"")); 1663 Tok.setLocation(SourceMgr.createExpansionLoc(DATELoc, Tok.getLocation(), 1664 Tok.getLocation(), 1665 Tok.getLength())); 1666 return; 1667 } else if (II == Ident__TIME__) { 1668 Diag(Tok.getLocation(), diag::warn_pp_date_time); 1669 if (!TIMELoc.isValid()) 1670 ComputeDATE_TIME(DATELoc, TIMELoc, *this); 1671 Tok.setKind(tok::string_literal); 1672 Tok.setLength(strlen("\"hh:mm:ss\"")); 1673 Tok.setLocation(SourceMgr.createExpansionLoc(TIMELoc, Tok.getLocation(), 1674 Tok.getLocation(), 1675 Tok.getLength())); 1676 return; 1677 } else if (II == Ident__INCLUDE_LEVEL__) { 1678 // Compute the presumed include depth of this token. This can be affected 1679 // by GNU line markers. 1680 unsigned Depth = 0; 1681 1682 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation()); 1683 if (PLoc.isValid()) { 1684 PLoc = SourceMgr.getPresumedLoc(PLoc.getIncludeLoc()); 1685 for (; PLoc.isValid(); ++Depth) 1686 PLoc = SourceMgr.getPresumedLoc(PLoc.getIncludeLoc()); 1687 } 1688 1689 // __INCLUDE_LEVEL__ expands to a simple numeric value. 1690 OS << Depth; 1691 Tok.setKind(tok::numeric_constant); 1692 } else if (II == Ident__TIMESTAMP__) { 1693 Diag(Tok.getLocation(), diag::warn_pp_date_time); 1694 // MSVC, ICC, GCC, VisualAge C++ extension. The generated string should be 1695 // of the form "Ddd Mmm dd hh::mm::ss yyyy", which is returned by asctime. 1696 1697 // Get the file that we are lexing out of. If we're currently lexing from 1698 // a macro, dig into the include stack. 1699 const FileEntry *CurFile = nullptr; 1700 PreprocessorLexer *TheLexer = getCurrentFileLexer(); 1701 1702 if (TheLexer) 1703 CurFile = SourceMgr.getFileEntryForID(TheLexer->getFileID()); 1704 1705 const char *Result; 1706 if (CurFile) { 1707 time_t TT = CurFile->getModificationTime(); 1708 struct tm *TM = localtime(&TT); 1709 Result = asctime(TM); 1710 } else { 1711 Result = "??? ??? ?? ??:??:?? ????\n"; 1712 } 1713 // Surround the string with " and strip the trailing newline. 1714 OS << '"' << StringRef(Result).drop_back() << '"'; 1715 Tok.setKind(tok::string_literal); 1716 } else if (II == Ident__COUNTER__) { 1717 // __COUNTER__ expands to a simple numeric value. 1718 OS << CounterValue++; 1719 Tok.setKind(tok::numeric_constant); 1720 } else if (II == Ident__has_feature) { 1721 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1722 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1723 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1724 diag::err_feature_check_malformed); 1725 return II && HasFeature(*this, II->getName()); 1726 }); 1727 } else if (II == Ident__has_extension) { 1728 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1729 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1730 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1731 diag::err_feature_check_malformed); 1732 return II && HasExtension(*this, II->getName()); 1733 }); 1734 } else if (II == Ident__has_builtin) { 1735 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1736 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1737 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1738 diag::err_feature_check_malformed); 1739 if (!II) 1740 return false; 1741 else if (II->getBuiltinID() != 0) 1742 return true; 1743 else { 1744 const LangOptions &LangOpts = getLangOpts(); 1745 return llvm::StringSwitch<bool>(II->getName()) 1746 .Case("__make_integer_seq", LangOpts.CPlusPlus) 1747 .Case("__type_pack_element", LangOpts.CPlusPlus) 1748 .Default(false); 1749 } 1750 }); 1751 } else if (II == Ident__is_identifier) { 1752 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1753 [](Token &Tok, bool &HasLexedNextToken) -> int { 1754 return Tok.is(tok::identifier); 1755 }); 1756 } else if (II == Ident__has_attribute) { 1757 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1758 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1759 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1760 diag::err_feature_check_malformed); 1761 return II ? hasAttribute(AttrSyntax::GNU, nullptr, II, 1762 getTargetInfo(), getLangOpts()) : 0; 1763 }); 1764 } else if (II == Ident__has_declspec) { 1765 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1766 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1767 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1768 diag::err_feature_check_malformed); 1769 return II ? hasAttribute(AttrSyntax::Declspec, nullptr, II, 1770 getTargetInfo(), getLangOpts()) : 0; 1771 }); 1772 } else if (II == Ident__has_cpp_attribute) { 1773 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1774 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1775 IdentifierInfo *ScopeII = nullptr; 1776 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1777 diag::err_feature_check_malformed); 1778 if (!II) 1779 return false; 1780 1781 // It is possible to receive a scope token. Read the "::", if it is 1782 // available, and the subsequent identifier. 1783 LexUnexpandedToken(Tok); 1784 if (Tok.isNot(tok::coloncolon)) 1785 HasLexedNextToken = true; 1786 else { 1787 ScopeII = II; 1788 LexUnexpandedToken(Tok); 1789 II = ExpectFeatureIdentifierInfo(Tok, *this, 1790 diag::err_feature_check_malformed); 1791 } 1792 1793 return II ? hasAttribute(AttrSyntax::CXX, ScopeII, II, 1794 getTargetInfo(), getLangOpts()) : 0; 1795 }); 1796 } else if (II == Ident__has_include || 1797 II == Ident__has_include_next) { 1798 // The argument to these two builtins should be a parenthesized 1799 // file name string literal using angle brackets (<>) or 1800 // double-quotes (""). 1801 bool Value; 1802 if (II == Ident__has_include) 1803 Value = EvaluateHasInclude(Tok, II, *this); 1804 else 1805 Value = EvaluateHasIncludeNext(Tok, II, *this); 1806 1807 if (Tok.isNot(tok::r_paren)) 1808 return; 1809 OS << (int)Value; 1810 Tok.setKind(tok::numeric_constant); 1811 } else if (II == Ident__has_warning) { 1812 // The argument should be a parenthesized string literal. 1813 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1814 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1815 std::string WarningName; 1816 SourceLocation StrStartLoc = Tok.getLocation(); 1817 1818 HasLexedNextToken = Tok.is(tok::string_literal); 1819 if (!FinishLexStringLiteral(Tok, WarningName, "'__has_warning'", 1820 /*MacroExpansion=*/false)) 1821 return false; 1822 1823 // FIXME: Should we accept "-R..." flags here, or should that be 1824 // handled by a separate __has_remark? 1825 if (WarningName.size() < 3 || WarningName[0] != '-' || 1826 WarningName[1] != 'W') { 1827 Diag(StrStartLoc, diag::warn_has_warning_invalid_option); 1828 return false; 1829 } 1830 1831 // Finally, check if the warning flags maps to a diagnostic group. 1832 // We construct a SmallVector here to talk to getDiagnosticIDs(). 1833 // Although we don't use the result, this isn't a hot path, and not 1834 // worth special casing. 1835 SmallVector<diag::kind, 10> Diags; 1836 return !getDiagnostics().getDiagnosticIDs()-> 1837 getDiagnosticsInGroup(diag::Flavor::WarningOrError, 1838 WarningName.substr(2), Diags); 1839 }); 1840 } else if (II == Ident__building_module) { 1841 // The argument to this builtin should be an identifier. The 1842 // builtin evaluates to 1 when that identifier names the module we are 1843 // currently building. 1844 EvaluateFeatureLikeBuiltinMacro(OS, Tok, II, *this, 1845 [this](Token &Tok, bool &HasLexedNextToken) -> int { 1846 IdentifierInfo *II = ExpectFeatureIdentifierInfo(Tok, *this, 1847 diag::err_expected_id_building_module); 1848 return getLangOpts().isCompilingModule() && II && 1849 (II->getName() == getLangOpts().CurrentModule); 1850 }); 1851 } else if (II == Ident__MODULE__) { 1852 // The current module as an identifier. 1853 OS << getLangOpts().CurrentModule; 1854 IdentifierInfo *ModuleII = getIdentifierInfo(getLangOpts().CurrentModule); 1855 Tok.setIdentifierInfo(ModuleII); 1856 Tok.setKind(ModuleII->getTokenID()); 1857 } else if (II == Ident__identifier) { 1858 SourceLocation Loc = Tok.getLocation(); 1859 1860 // We're expecting '__identifier' '(' identifier ')'. Try to recover 1861 // if the parens are missing. 1862 LexNonComment(Tok); 1863 if (Tok.isNot(tok::l_paren)) { 1864 // No '(', use end of last token. 1865 Diag(getLocForEndOfToken(Loc), diag::err_pp_expected_after) 1866 << II << tok::l_paren; 1867 // If the next token isn't valid as our argument, we can't recover. 1868 if (!Tok.isAnnotation() && Tok.getIdentifierInfo()) 1869 Tok.setKind(tok::identifier); 1870 return; 1871 } 1872 1873 SourceLocation LParenLoc = Tok.getLocation(); 1874 LexNonComment(Tok); 1875 1876 if (!Tok.isAnnotation() && Tok.getIdentifierInfo()) 1877 Tok.setKind(tok::identifier); 1878 else { 1879 Diag(Tok.getLocation(), diag::err_pp_identifier_arg_not_identifier) 1880 << Tok.getKind(); 1881 // Don't walk past anything that's not a real token. 1882 if (Tok.isOneOf(tok::eof, tok::eod) || Tok.isAnnotation()) 1883 return; 1884 } 1885 1886 // Discard the ')', preserving 'Tok' as our result. 1887 Token RParen; 1888 LexNonComment(RParen); 1889 if (RParen.isNot(tok::r_paren)) { 1890 Diag(getLocForEndOfToken(Tok.getLocation()), diag::err_pp_expected_after) 1891 << Tok.getKind() << tok::r_paren; 1892 Diag(LParenLoc, diag::note_matching) << tok::l_paren; 1893 } 1894 return; 1895 } else { 1896 llvm_unreachable("Unknown identifier!"); 1897 } 1898 CreateString(OS.str(), Tok, Tok.getLocation(), Tok.getLocation()); 1899 } 1900 1901 void Preprocessor::markMacroAsUsed(MacroInfo *MI) { 1902 // If the 'used' status changed, and the macro requires 'unused' warning, 1903 // remove its SourceLocation from the warn-for-unused-macro locations. 1904 if (MI->isWarnIfUnused() && !MI->isUsed()) 1905 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc()); 1906 MI->setIsUsed(true); 1907 } 1908