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