1 //===--- PPDirectives.cpp - Directive Handling for Preprocessor -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Implements # directive processing for the Preprocessor.
13 //===----------------------------------------------------------------------===//
15 #include "clang/Lex/Preprocessor.h"
16 #include "clang/Basic/FileManager.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "clang/Lex/CodeCompletionHandler.h"
19 #include "clang/Lex/HeaderSearch.h"
20 #include "clang/Lex/HeaderSearchOptions.h"
21 #include "clang/Lex/LexDiagnostic.h"
22 #include "clang/Lex/LiteralSupport.h"
23 #include "clang/Lex/MacroInfo.h"
24 #include "clang/Lex/ModuleLoader.h"
25 #include "clang/Lex/Pragma.h"
26 #include "llvm/ADT/APInt.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/SaveAndRestore.h"
29 using namespace clang;
31 //===----------------------------------------------------------------------===//
32 // Utility Methods for Preprocessor Directive Handling.
33 //===----------------------------------------------------------------------===//
35 MacroInfo *Preprocessor::AllocateMacroInfo() {
36 MacroInfoChain *MIChain;
40 MICache = MICache->Next;
43 MIChain = BP.Allocate<MacroInfoChain>();
46 MIChain->Next = MIChainHead;
49 MIChainHead->Prev = MIChain;
50 MIChainHead = MIChain;
52 return &(MIChain->MI);
55 MacroInfo *Preprocessor::AllocateMacroInfo(SourceLocation L) {
56 MacroInfo *MI = AllocateMacroInfo();
57 new (MI) MacroInfo(L);
61 MacroInfo *Preprocessor::AllocateDeserializedMacroInfo(SourceLocation L,
62 unsigned SubModuleID) {
63 LLVM_STATIC_ASSERT(llvm::AlignOf<MacroInfo>::Alignment >= sizeof(SubModuleID),
64 "alignment for MacroInfo is less than the ID");
65 DeserializedMacroInfoChain *MIChain =
66 BP.Allocate<DeserializedMacroInfoChain>();
67 MIChain->Next = DeserialMIChainHead;
68 DeserialMIChainHead = MIChain;
70 MacroInfo *MI = &MIChain->MI;
71 new (MI) MacroInfo(L);
72 MI->FromASTFile = true;
73 MI->setOwningModuleID(SubModuleID);
78 Preprocessor::AllocateDefMacroDirective(MacroInfo *MI, SourceLocation Loc,
80 DefMacroDirective *MD = BP.Allocate<DefMacroDirective>();
81 new (MD) DefMacroDirective(MI, Loc, isImported);
86 Preprocessor::AllocateUndefMacroDirective(SourceLocation UndefLoc) {
87 UndefMacroDirective *MD = BP.Allocate<UndefMacroDirective>();
88 new (MD) UndefMacroDirective(UndefLoc);
92 VisibilityMacroDirective *
93 Preprocessor::AllocateVisibilityMacroDirective(SourceLocation Loc,
95 VisibilityMacroDirective *MD = BP.Allocate<VisibilityMacroDirective>();
96 new (MD) VisibilityMacroDirective(Loc, isPublic);
100 /// \brief Release the specified MacroInfo to be reused for allocating
101 /// new MacroInfo objects.
102 void Preprocessor::ReleaseMacroInfo(MacroInfo *MI) {
103 MacroInfoChain *MIChain = (MacroInfoChain*) MI;
104 if (MacroInfoChain *Prev = MIChain->Prev) {
105 MacroInfoChain *Next = MIChain->Next;
111 assert(MIChainHead == MIChain);
112 MIChainHead = MIChain->Next;
113 MIChainHead->Prev = 0;
115 MIChain->Next = MICache;
121 /// \brief Read and discard all tokens remaining on the current line until
122 /// the tok::eod token is found.
123 void Preprocessor::DiscardUntilEndOfDirective() {
126 LexUnexpandedToken(Tmp);
127 assert(Tmp.isNot(tok::eof) && "EOF seen while discarding directive tokens");
128 } while (Tmp.isNot(tok::eod));
131 /// \brief Lex and validate a macro name, which occurs after a
132 /// \#define or \#undef.
134 /// This sets the token kind to eod and discards the rest
135 /// of the macro line if the macro name is invalid. \p isDefineUndef is 1 if
136 /// this is due to a a \#define, 2 if \#undef directive, 0 if it is something
137 /// else (e.g. \#ifdef).
138 void Preprocessor::ReadMacroName(Token &MacroNameTok, char isDefineUndef) {
139 // Read the token, don't allow macro expansion on it.
140 LexUnexpandedToken(MacroNameTok);
142 if (MacroNameTok.is(tok::code_completion)) {
144 CodeComplete->CodeCompleteMacroName(isDefineUndef == 1);
145 setCodeCompletionReached();
146 LexUnexpandedToken(MacroNameTok);
149 // Missing macro name?
150 if (MacroNameTok.is(tok::eod)) {
151 Diag(MacroNameTok, diag::err_pp_missing_macro_name);
155 IdentifierInfo *II = MacroNameTok.getIdentifierInfo();
157 bool Invalid = false;
158 std::string Spelling = getSpelling(MacroNameTok, &Invalid);
162 const IdentifierInfo &Info = Identifiers.get(Spelling);
164 // Allow #defining |and| and friends in microsoft mode.
165 if (Info.isCPlusPlusOperatorKeyword() && getLangOpts().MicrosoftMode) {
166 MacroNameTok.setIdentifierInfo(getIdentifierInfo(Spelling));
170 if (Info.isCPlusPlusOperatorKeyword())
171 // C++ 2.5p2: Alternative tokens behave the same as its primary token
172 // except for their spellings.
173 Diag(MacroNameTok, diag::err_pp_operator_used_as_macro_name) << Spelling;
175 Diag(MacroNameTok, diag::err_pp_macro_not_identifier);
176 // Fall through on error.
177 } else if (isDefineUndef && II->getPPKeywordID() == tok::pp_defined) {
178 // Error if defining "defined": C99 6.10.8/4, C++ [cpp.predefined]p4.
179 Diag(MacroNameTok, diag::err_defined_macro_name);
180 } else if (isDefineUndef == 2 && II->hasMacroDefinition() &&
181 getMacroInfo(II)->isBuiltinMacro()) {
182 // Warn if undefining "__LINE__" and other builtins, per C99 6.10.8/4
183 // and C++ [cpp.predefined]p4], but allow it as an extension.
184 Diag(MacroNameTok, diag::ext_pp_undef_builtin_macro);
187 // Okay, we got a good identifier node. Return it.
191 // Invalid macro name, read and discard the rest of the line. Then set the
192 // token kind to tok::eod.
193 MacroNameTok.setKind(tok::eod);
194 return DiscardUntilEndOfDirective();
197 /// \brief Ensure that the next token is a tok::eod token.
199 /// If not, emit a diagnostic and consume up until the eod. If EnableMacros is
200 /// true, then we consider macros that expand to zero tokens as being ok.
201 void Preprocessor::CheckEndOfDirective(const char *DirType, bool EnableMacros) {
203 // Lex unexpanded tokens for most directives: macros might expand to zero
204 // tokens, causing us to miss diagnosing invalid lines. Some directives (like
205 // #line) allow empty macros.
209 LexUnexpandedToken(Tmp);
211 // There should be no tokens after the directive, but we allow them as an
213 while (Tmp.is(tok::comment)) // Skip comments in -C mode.
214 LexUnexpandedToken(Tmp);
216 if (Tmp.isNot(tok::eod)) {
217 // Add a fixit in GNU/C99/C++ mode. Don't offer a fixit for strict-C89,
218 // or if this is a macro-style preprocessing directive, because it is more
219 // trouble than it is worth to insert /**/ and check that there is no /**/
220 // in the range also.
222 if ((LangOpts.GNUMode || LangOpts.C99 || LangOpts.CPlusPlus) &&
224 Hint = FixItHint::CreateInsertion(Tmp.getLocation(),"//");
225 Diag(Tmp, diag::ext_pp_extra_tokens_at_eol) << DirType << Hint;
226 DiscardUntilEndOfDirective();
232 /// SkipExcludedConditionalBlock - We just read a \#if or related directive and
233 /// decided that the subsequent tokens are in the \#if'd out portion of the
234 /// file. Lex the rest of the file, until we see an \#endif. If
235 /// FoundNonSkipPortion is true, then we have already emitted code for part of
236 /// this \#if directive, so \#else/\#elif blocks should never be entered.
237 /// If ElseOk is true, then \#else directives are ok, if not, then we have
238 /// already seen one so a \#else directive is a duplicate. When this returns,
239 /// the caller can lex the first valid token.
240 void Preprocessor::SkipExcludedConditionalBlock(SourceLocation IfTokenLoc,
241 bool FoundNonSkipPortion,
243 SourceLocation ElseLoc) {
245 assert(!CurTokenLexer && CurPPLexer && "Lexing a macro, not a file?");
247 CurPPLexer->pushConditionalLevel(IfTokenLoc, /*isSkipping*/false,
248 FoundNonSkipPortion, FoundElse);
251 PTHSkipExcludedConditionalBlock();
255 // Enter raw mode to disable identifier lookup (and thus macro expansion),
256 // disabling warnings, etc.
257 CurPPLexer->LexingRawMode = true;
262 if (Tok.is(tok::code_completion)) {
264 CodeComplete->CodeCompleteInConditionalExclusion();
265 setCodeCompletionReached();
269 // If this is the end of the buffer, we have an error.
270 if (Tok.is(tok::eof)) {
271 // Emit errors for each unterminated conditional on the stack, including
273 while (!CurPPLexer->ConditionalStack.empty()) {
274 if (CurLexer->getFileLoc() != CodeCompletionFileLoc)
275 Diag(CurPPLexer->ConditionalStack.back().IfLoc,
276 diag::err_pp_unterminated_conditional);
277 CurPPLexer->ConditionalStack.pop_back();
280 // Just return and let the caller lex after this #include.
284 // If this token is not a preprocessor directive, just skip it.
285 if (Tok.isNot(tok::hash) || !Tok.isAtStartOfLine())
288 // We just parsed a # character at the start of a line, so we're in
289 // directive mode. Tell the lexer this so any newlines we see will be
290 // converted into an EOD token (this terminates the macro).
291 CurPPLexer->ParsingPreprocessorDirective = true;
292 if (CurLexer) CurLexer->SetKeepWhitespaceMode(false);
295 // Read the next token, the directive flavor.
296 LexUnexpandedToken(Tok);
298 // If this isn't an identifier directive (e.g. is "# 1\n" or "#\n", or
299 // something bogus), skip it.
300 if (Tok.isNot(tok::raw_identifier)) {
301 CurPPLexer->ParsingPreprocessorDirective = false;
302 // Restore comment saving mode.
303 if (CurLexer) CurLexer->resetExtendedTokenMode();
307 // If the first letter isn't i or e, it isn't intesting to us. We know that
308 // this is safe in the face of spelling differences, because there is no way
309 // to spell an i/e in a strange way that is another letter. Skipping this
310 // allows us to avoid looking up the identifier info for #define/#undef and
311 // other common directives.
312 const char *RawCharData = Tok.getRawIdentifierData();
314 char FirstChar = RawCharData[0];
315 if (FirstChar >= 'a' && FirstChar <= 'z' &&
316 FirstChar != 'i' && FirstChar != 'e') {
317 CurPPLexer->ParsingPreprocessorDirective = false;
318 // Restore comment saving mode.
319 if (CurLexer) CurLexer->resetExtendedTokenMode();
323 // Get the identifier name without trigraphs or embedded newlines. Note
324 // that we can't use Tok.getIdentifierInfo() because its lookup is disabled
326 char DirectiveBuf[20];
328 if (!Tok.needsCleaning() && Tok.getLength() < 20) {
329 Directive = StringRef(RawCharData, Tok.getLength());
331 std::string DirectiveStr = getSpelling(Tok);
332 unsigned IdLen = DirectiveStr.size();
334 CurPPLexer->ParsingPreprocessorDirective = false;
335 // Restore comment saving mode.
336 if (CurLexer) CurLexer->resetExtendedTokenMode();
339 memcpy(DirectiveBuf, &DirectiveStr[0], IdLen);
340 Directive = StringRef(DirectiveBuf, IdLen);
343 if (Directive.startswith("if")) {
344 StringRef Sub = Directive.substr(2);
345 if (Sub.empty() || // "if"
346 Sub == "def" || // "ifdef"
347 Sub == "ndef") { // "ifndef"
348 // We know the entire #if/#ifdef/#ifndef block will be skipped, don't
349 // bother parsing the condition.
350 DiscardUntilEndOfDirective();
351 CurPPLexer->pushConditionalLevel(Tok.getLocation(), /*wasskipping*/true,
352 /*foundnonskip*/false,
355 } else if (Directive[0] == 'e') {
356 StringRef Sub = Directive.substr(1);
357 if (Sub == "ndif") { // "endif"
358 PPConditionalInfo CondInfo;
359 CondInfo.WasSkipping = true; // Silence bogus warning.
360 bool InCond = CurPPLexer->popConditionalLevel(CondInfo);
361 (void)InCond; // Silence warning in no-asserts mode.
362 assert(!InCond && "Can't be skipping if not in a conditional!");
364 // If we popped the outermost skipping block, we're done skipping!
365 if (!CondInfo.WasSkipping) {
366 // Restore the value of LexingRawMode so that trailing comments
367 // are handled correctly, if we've reached the outermost block.
368 CurPPLexer->LexingRawMode = false;
369 CheckEndOfDirective("endif");
370 CurPPLexer->LexingRawMode = true;
372 Callbacks->Endif(Tok.getLocation(), CondInfo.IfLoc);
375 DiscardUntilEndOfDirective();
377 } else if (Sub == "lse") { // "else".
378 // #else directive in a skipping conditional. If not in some other
379 // skipping conditional, and if #else hasn't already been seen, enter it
380 // as a non-skipping conditional.
381 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel();
383 // If this is a #else with a #else before it, report the error.
384 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_else_after_else);
386 // Note that we've seen a #else in this conditional.
387 CondInfo.FoundElse = true;
389 // If the conditional is at the top level, and the #if block wasn't
390 // entered, enter the #else block now.
391 if (!CondInfo.WasSkipping && !CondInfo.FoundNonSkip) {
392 CondInfo.FoundNonSkip = true;
393 // Restore the value of LexingRawMode so that trailing comments
394 // are handled correctly.
395 CurPPLexer->LexingRawMode = false;
396 CheckEndOfDirective("else");
397 CurPPLexer->LexingRawMode = true;
399 Callbacks->Else(Tok.getLocation(), CondInfo.IfLoc);
402 DiscardUntilEndOfDirective(); // C99 6.10p4.
404 } else if (Sub == "lif") { // "elif".
405 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel();
408 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
409 // If this is in a skipping block or if we're already handled this #if
410 // block, don't bother parsing the condition.
411 if (CondInfo.WasSkipping || CondInfo.FoundNonSkip) {
412 DiscardUntilEndOfDirective();
415 // Restore the value of LexingRawMode so that identifiers are
416 // looked up, etc, inside the #elif expression.
417 assert(CurPPLexer->LexingRawMode && "We have to be skipping here!");
418 CurPPLexer->LexingRawMode = false;
419 IdentifierInfo *IfNDefMacro = 0;
420 ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro);
421 CurPPLexer->LexingRawMode = true;
423 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
425 // If this is a #elif with a #else before it, report the error.
426 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_elif_after_else);
428 // If this condition is true, enter it!
430 CondInfo.FoundNonSkip = true;
432 Callbacks->Elif(Tok.getLocation(),
433 SourceRange(ConditionalBegin, ConditionalEnd),
434 ShouldEnter, CondInfo.IfLoc);
440 CurPPLexer->ParsingPreprocessorDirective = false;
441 // Restore comment saving mode.
442 if (CurLexer) CurLexer->resetExtendedTokenMode();
445 // Finally, if we are out of the conditional (saw an #endif or ran off the end
446 // of the file, just stop skipping and return to lexing whatever came after
448 CurPPLexer->LexingRawMode = false;
451 SourceLocation BeginLoc = ElseLoc.isValid() ? ElseLoc : IfTokenLoc;
452 Callbacks->SourceRangeSkipped(SourceRange(BeginLoc, Tok.getLocation()));
456 void Preprocessor::PTHSkipExcludedConditionalBlock() {
460 assert(CurPTHLexer->LexingRawMode == false);
462 // Skip to the next '#else', '#elif', or #endif.
463 if (CurPTHLexer->SkipBlock()) {
464 // We have reached an #endif. Both the '#' and 'endif' tokens
465 // have been consumed by the PTHLexer. Just pop off the condition level.
466 PPConditionalInfo CondInfo;
467 bool InCond = CurPTHLexer->popConditionalLevel(CondInfo);
468 (void)InCond; // Silence warning in no-asserts mode.
469 assert(!InCond && "Can't be skipping if not in a conditional!");
473 // We have reached a '#else' or '#elif'. Lex the next token to get
474 // the directive flavor.
476 LexUnexpandedToken(Tok);
478 // We can actually look up the IdentifierInfo here since we aren't in
480 tok::PPKeywordKind K = Tok.getIdentifierInfo()->getPPKeywordID();
482 if (K == tok::pp_else) {
483 // #else: Enter the else condition. We aren't in a nested condition
484 // since we skip those. We're always in the one matching the last
485 // blocked we skipped.
486 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel();
487 // Note that we've seen a #else in this conditional.
488 CondInfo.FoundElse = true;
490 // If the #if block wasn't entered then enter the #else block now.
491 if (!CondInfo.FoundNonSkip) {
492 CondInfo.FoundNonSkip = true;
494 // Scan until the eod token.
495 CurPTHLexer->ParsingPreprocessorDirective = true;
496 DiscardUntilEndOfDirective();
497 CurPTHLexer->ParsingPreprocessorDirective = false;
502 // Otherwise skip this block.
506 assert(K == tok::pp_elif);
507 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel();
509 // If this is a #elif with a #else before it, report the error.
510 if (CondInfo.FoundElse)
511 Diag(Tok, diag::pp_err_elif_after_else);
513 // If this is in a skipping block or if we're already handled this #if
514 // block, don't bother parsing the condition. We just skip this block.
515 if (CondInfo.FoundNonSkip)
518 // Evaluate the condition of the #elif.
519 IdentifierInfo *IfNDefMacro = 0;
520 CurPTHLexer->ParsingPreprocessorDirective = true;
521 bool ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro);
522 CurPTHLexer->ParsingPreprocessorDirective = false;
524 // If this condition is true, enter it!
526 CondInfo.FoundNonSkip = true;
530 // Otherwise, skip this block and go to the next one.
535 Module *Preprocessor::getModuleForLocation(SourceLocation FilenameLoc) {
536 ModuleMap &ModMap = HeaderInfo.getModuleMap();
537 if (SourceMgr.isInMainFile(FilenameLoc)) {
538 if (Module *CurMod = getCurrentModule())
539 return CurMod; // Compiling a module.
540 return HeaderInfo.getModuleMap().SourceModule; // Compiling a source.
542 // Try to determine the module of the include directive.
543 FileID IDOfIncl = SourceMgr.getFileID(FilenameLoc);
544 if (const FileEntry *EntryOfIncl = SourceMgr.getFileEntryForID(IDOfIncl)) {
545 // The include comes from a file.
546 return ModMap.findModuleForHeader(EntryOfIncl).getModule();
548 // The include does not come from a file,
549 // so it is probably a module compilation.
550 return getCurrentModule();
554 bool Preprocessor::violatesPrivateInclude(
555 Module *RequestingModule,
556 const FileEntry *IncFileEnt,
557 ModuleMap::ModuleHeaderRole Role,
558 Module *RequestedModule) {
560 // Check for consistency between the module header role
561 // as obtained from the lookup and as obtained from the module.
562 // This check is not cheap, so enable it only for debugging.
563 SmallVectorImpl<const FileEntry *> &PvtHdrs
564 = RequestedModule->PrivateHeaders;
565 SmallVectorImpl<const FileEntry *>::iterator Look
566 = std::find(PvtHdrs.begin(), PvtHdrs.end(), IncFileEnt);
567 bool IsPrivate = Look != PvtHdrs.end();
568 assert((IsPrivate && Role == ModuleMap::PrivateHeader)
569 || (!IsPrivate && Role != ModuleMap::PrivateHeader));
571 return Role == ModuleMap::PrivateHeader &&
572 RequestedModule->getTopLevelModule() != RequestingModule;
575 bool Preprocessor::violatesUseDeclarations(
576 Module *RequestingModule,
577 Module *RequestedModule) {
578 ModuleMap &ModMap = HeaderInfo.getModuleMap();
579 ModMap.resolveUses(RequestingModule, /*Complain=*/false);
580 const SmallVectorImpl<Module *> &AllowedUses = RequestingModule->DirectUses;
581 SmallVectorImpl<Module *>::const_iterator Declared =
582 std::find(AllowedUses.begin(), AllowedUses.end(), RequestedModule);
583 return Declared == AllowedUses.end();
586 void Preprocessor::verifyModuleInclude(SourceLocation FilenameLoc,
588 const FileEntry *IncFileEnt) {
589 Module *RequestingModule = getModuleForLocation(FilenameLoc);
590 if (RequestingModule)
591 HeaderInfo.getModuleMap().resolveUses(RequestingModule, /*Complain=*/false);
592 ModuleMap::KnownHeader RequestedModule =
593 HeaderInfo.getModuleMap().findModuleForHeader(IncFileEnt,
596 if (RequestingModule == RequestedModule.getModule())
597 return; // No faults wihin a module, or between files both not in modules.
599 if (RequestingModule != HeaderInfo.getModuleMap().SourceModule)
600 return; // No errors for indirect modules.
601 // This may be a bit of a problem for modules with no source files.
603 if (RequestedModule && violatesPrivateInclude(RequestingModule, IncFileEnt,
604 RequestedModule.getRole(),
605 RequestedModule.getModule()))
606 Diag(FilenameLoc, diag::error_use_of_private_header_outside_module)
609 // FIXME: Add support for FixIts in module map files and offer adding the
610 // required use declaration.
611 if (RequestingModule && getLangOpts().ModulesDeclUse &&
612 violatesUseDeclarations(RequestingModule, RequestedModule.getModule()))
613 Diag(FilenameLoc, diag::error_undeclared_use_of_module)
617 const FileEntry *Preprocessor::LookupFile(
618 SourceLocation FilenameLoc,
621 const DirectoryLookup *FromDir,
622 const DirectoryLookup *&CurDir,
623 SmallVectorImpl<char> *SearchPath,
624 SmallVectorImpl<char> *RelativePath,
625 ModuleMap::KnownHeader *SuggestedModule,
627 // If the header lookup mechanism may be relative to the current file, pass in
628 // info about where the current file is.
629 const FileEntry *CurFileEnt = 0;
631 FileID FID = getCurrentFileLexer()->getFileID();
632 CurFileEnt = SourceMgr.getFileEntryForID(FID);
634 // If there is no file entry associated with this file, it must be the
635 // predefines buffer. Any other file is not lexed with a normal lexer, so
636 // it won't be scanned for preprocessor directives. If we have the
637 // predefines buffer, resolve #include references (which come from the
638 // -include command line argument) as if they came from the main file, this
639 // affects file lookup etc.
640 if (CurFileEnt == 0) {
641 FID = SourceMgr.getMainFileID();
642 CurFileEnt = SourceMgr.getFileEntryForID(FID);
646 // Do a standard file entry lookup.
647 CurDir = CurDirLookup;
648 const FileEntry *FE = HeaderInfo.LookupFile(
649 Filename, isAngled, FromDir, CurDir, CurFileEnt,
650 SearchPath, RelativePath, SuggestedModule, SkipCache);
653 verifyModuleInclude(FilenameLoc, Filename, FE);
657 // Otherwise, see if this is a subframework header. If so, this is relative
658 // to one of the headers on the #include stack. Walk the list of the current
659 // headers on the #include stack and pass them to HeaderInfo.
661 if ((CurFileEnt = SourceMgr.getFileEntryForID(CurPPLexer->getFileID())))
662 if ((FE = HeaderInfo.LookupSubframeworkHeader(Filename, CurFileEnt,
663 SearchPath, RelativePath,
668 for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) {
669 IncludeStackInfo &ISEntry = IncludeMacroStack[e-i-1];
670 if (IsFileLexer(ISEntry)) {
672 SourceMgr.getFileEntryForID(ISEntry.ThePPLexer->getFileID())))
673 if ((FE = HeaderInfo.LookupSubframeworkHeader(
674 Filename, CurFileEnt, SearchPath, RelativePath,
680 // Otherwise, we really couldn't find the file.
685 //===----------------------------------------------------------------------===//
686 // Preprocessor Directive Handling.
687 //===----------------------------------------------------------------------===//
689 class Preprocessor::ResetMacroExpansionHelper {
691 ResetMacroExpansionHelper(Preprocessor *pp)
692 : PP(pp), save(pp->DisableMacroExpansion) {
693 if (pp->MacroExpansionInDirectivesOverride)
694 pp->DisableMacroExpansion = false;
696 ~ResetMacroExpansionHelper() {
697 PP->DisableMacroExpansion = save;
704 /// HandleDirective - This callback is invoked when the lexer sees a # token
705 /// at the start of a line. This consumes the directive, modifies the
706 /// lexer/preprocessor state, and advances the lexer(s) so that the next token
707 /// read is the correct one.
708 void Preprocessor::HandleDirective(Token &Result) {
709 // FIXME: Traditional: # with whitespace before it not recognized by K&R?
711 // We just parsed a # character at the start of a line, so we're in directive
712 // mode. Tell the lexer this so any newlines we see will be converted into an
713 // EOD token (which terminates the directive).
714 CurPPLexer->ParsingPreprocessorDirective = true;
715 if (CurLexer) CurLexer->SetKeepWhitespaceMode(false);
717 bool ImmediatelyAfterTopLevelIfndef =
718 CurPPLexer->MIOpt.getImmediatelyAfterTopLevelIfndef();
719 CurPPLexer->MIOpt.resetImmediatelyAfterTopLevelIfndef();
723 // We are about to read a token. For the multiple-include optimization FA to
724 // work, we have to remember if we had read any tokens *before* this
726 bool ReadAnyTokensBeforeDirective =CurPPLexer->MIOpt.getHasReadAnyTokensVal();
728 // Save the '#' token in case we need to return it later.
729 Token SavedHash = Result;
731 // Read the next token, the directive flavor. This isn't expanded due to
733 LexUnexpandedToken(Result);
735 // C99 6.10.3p11: Is this preprocessor directive in macro invocation? e.g.:
740 // If so, the user is relying on undefined behavior, emit a diagnostic. Do
741 // not support this for #include-like directives, since that can result in
742 // terrible diagnostics, and does not work in GCC.
744 if (IdentifierInfo *II = Result.getIdentifierInfo()) {
745 switch (II->getPPKeywordID()) {
746 case tok::pp_include:
748 case tok::pp_include_next:
749 case tok::pp___include_macros:
750 Diag(Result, diag::err_embedded_include) << II->getName();
751 DiscardUntilEndOfDirective();
757 Diag(Result, diag::ext_embedded_directive);
760 // Temporarily enable macro expansion if set so
761 // and reset to previous state when returning from this function.
762 ResetMacroExpansionHelper helper(this);
764 switch (Result.getKind()) {
766 return; // null directive.
767 case tok::code_completion:
769 CodeComplete->CodeCompleteDirective(
770 CurPPLexer->getConditionalStackDepth() > 0);
771 setCodeCompletionReached();
773 case tok::numeric_constant: // # 7 GNU line marker directive.
774 if (getLangOpts().AsmPreprocessor)
775 break; // # 4 is not a preprocessor directive in .S files.
776 return HandleDigitDirective(Result);
778 IdentifierInfo *II = Result.getIdentifierInfo();
779 if (II == 0) break; // Not an identifier.
781 // Ask what the preprocessor keyword ID is.
782 switch (II->getPPKeywordID()) {
784 // C99 6.10.1 - Conditional Inclusion.
786 return HandleIfDirective(Result, ReadAnyTokensBeforeDirective);
788 return HandleIfdefDirective(Result, false, true/*not valid for miopt*/);
790 return HandleIfdefDirective(Result, true, ReadAnyTokensBeforeDirective);
792 return HandleElifDirective(Result);
794 return HandleElseDirective(Result);
796 return HandleEndifDirective(Result);
798 // C99 6.10.2 - Source File Inclusion.
799 case tok::pp_include:
801 return HandleIncludeDirective(SavedHash.getLocation(), Result);
802 case tok::pp___include_macros:
804 return HandleIncludeMacrosDirective(SavedHash.getLocation(), Result);
806 // C99 6.10.3 - Macro Replacement.
808 return HandleDefineDirective(Result, ImmediatelyAfterTopLevelIfndef);
810 return HandleUndefDirective(Result);
812 // C99 6.10.4 - Line Control.
814 return HandleLineDirective(Result);
816 // C99 6.10.5 - Error Directive.
818 return HandleUserDiagnosticDirective(Result, false);
820 // C99 6.10.6 - Pragma Directive.
822 return HandlePragmaDirective(SavedHash.getLocation(), PIK_HashPragma);
826 return HandleImportDirective(SavedHash.getLocation(), Result);
827 case tok::pp_include_next:
828 return HandleIncludeNextDirective(SavedHash.getLocation(), Result);
830 case tok::pp_warning:
831 Diag(Result, diag::ext_pp_warning_directive);
832 return HandleUserDiagnosticDirective(Result, true);
834 return HandleIdentSCCSDirective(Result);
836 return HandleIdentSCCSDirective(Result);
838 //isExtension = true; // FIXME: implement #assert
840 case tok::pp_unassert:
841 //isExtension = true; // FIXME: implement #unassert
844 case tok::pp___public_macro:
845 if (getLangOpts().Modules)
846 return HandleMacroPublicDirective(Result);
849 case tok::pp___private_macro:
850 if (getLangOpts().Modules)
851 return HandleMacroPrivateDirective(Result);
857 // If this is a .S file, treat unknown # directives as non-preprocessor
858 // directives. This is important because # may be a comment or introduce
859 // various pseudo-ops. Just return the # token and push back the following
860 // token to be lexed next time.
861 if (getLangOpts().AsmPreprocessor) {
862 Token *Toks = new Token[2];
863 // Return the # and the token after it.
867 // If the second token is a hashhash token, then we need to translate it to
868 // unknown so the token lexer doesn't try to perform token pasting.
869 if (Result.is(tok::hashhash))
870 Toks[1].setKind(tok::unknown);
872 // Enter this token stream so that we re-lex the tokens. Make sure to
873 // enable macro expansion, in case the token after the # is an identifier
875 EnterTokenStream(Toks, 2, false, true);
879 // If we reached here, the preprocessing token is not valid!
880 Diag(Result, diag::err_pp_invalid_directive);
882 // Read the rest of the PP line.
883 DiscardUntilEndOfDirective();
885 // Okay, we're done parsing the directive.
888 /// GetLineValue - Convert a numeric token into an unsigned value, emitting
889 /// Diagnostic DiagID if it is invalid, and returning the value in Val.
890 static bool GetLineValue(Token &DigitTok, unsigned &Val,
891 unsigned DiagID, Preprocessor &PP,
892 bool IsGNULineDirective=false) {
893 if (DigitTok.isNot(tok::numeric_constant)) {
894 PP.Diag(DigitTok, DiagID);
896 if (DigitTok.isNot(tok::eod))
897 PP.DiscardUntilEndOfDirective();
901 SmallString<64> IntegerBuffer;
902 IntegerBuffer.resize(DigitTok.getLength());
903 const char *DigitTokBegin = &IntegerBuffer[0];
904 bool Invalid = false;
905 unsigned ActualLength = PP.getSpelling(DigitTok, DigitTokBegin, &Invalid);
909 // Verify that we have a simple digit-sequence, and compute the value. This
910 // is always a simple digit string computed in decimal, so we do this manually
913 for (unsigned i = 0; i != ActualLength; ++i) {
914 // C++1y [lex.fcon]p1:
915 // Optional separating single quotes in a digit-sequence are ignored
916 if (DigitTokBegin[i] == '\'')
919 if (!isDigit(DigitTokBegin[i])) {
920 PP.Diag(PP.AdvanceToTokenCharacter(DigitTok.getLocation(), i),
921 diag::err_pp_line_digit_sequence) << IsGNULineDirective;
922 PP.DiscardUntilEndOfDirective();
926 unsigned NextVal = Val*10+(DigitTokBegin[i]-'0');
927 if (NextVal < Val) { // overflow.
928 PP.Diag(DigitTok, DiagID);
929 PP.DiscardUntilEndOfDirective();
935 if (DigitTokBegin[0] == '0' && Val)
936 PP.Diag(DigitTok.getLocation(), diag::warn_pp_line_decimal)
937 << IsGNULineDirective;
942 /// \brief Handle a \#line directive: C99 6.10.4.
944 /// The two acceptable forms are:
946 /// # line digit-sequence
947 /// # line digit-sequence "s-char-sequence"
949 void Preprocessor::HandleLineDirective(Token &Tok) {
950 // Read the line # and string argument. Per C99 6.10.4p5, these tokens are
955 // Validate the number and convert it to an unsigned.
957 if (GetLineValue(DigitTok, LineNo, diag::err_pp_line_requires_integer,*this))
961 Diag(DigitTok, diag::ext_pp_line_zero);
963 // Enforce C99 6.10.4p3: "The digit sequence shall not specify ... a
964 // number greater than 2147483647". C90 requires that the line # be <= 32767.
965 unsigned LineLimit = 32768U;
966 if (LangOpts.C99 || LangOpts.CPlusPlus11)
967 LineLimit = 2147483648U;
968 if (LineNo >= LineLimit)
969 Diag(DigitTok, diag::ext_pp_line_too_big) << LineLimit;
970 else if (LangOpts.CPlusPlus11 && LineNo >= 32768U)
971 Diag(DigitTok, diag::warn_cxx98_compat_pp_line_too_big);
977 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
978 // string followed by eod.
979 if (StrTok.is(tok::eod))
981 else if (StrTok.isNot(tok::string_literal)) {
982 Diag(StrTok, diag::err_pp_line_invalid_filename);
983 return DiscardUntilEndOfDirective();
984 } else if (StrTok.hasUDSuffix()) {
985 Diag(StrTok, diag::err_invalid_string_udl);
986 return DiscardUntilEndOfDirective();
988 // Parse and validate the string, converting it into a unique ID.
989 StringLiteralParser Literal(&StrTok, 1, *this);
990 assert(Literal.isAscii() && "Didn't allow wide strings in");
991 if (Literal.hadError)
992 return DiscardUntilEndOfDirective();
993 if (Literal.Pascal) {
994 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
995 return DiscardUntilEndOfDirective();
997 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
999 // Verify that there is nothing after the string, other than EOD. Because
1000 // of C99 6.10.4p5, macros that expand to empty tokens are ok.
1001 CheckEndOfDirective("line", true);
1004 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID);
1007 Callbacks->FileChanged(CurPPLexer->getSourceLocation(),
1008 PPCallbacks::RenameFile,
1012 /// ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line
1013 /// marker directive.
1014 static bool ReadLineMarkerFlags(bool &IsFileEntry, bool &IsFileExit,
1015 bool &IsSystemHeader, bool &IsExternCHeader,
1020 if (FlagTok.is(tok::eod)) return false;
1021 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
1028 if (FlagTok.is(tok::eod)) return false;
1029 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
1031 } else if (FlagVal == 2) {
1034 SourceManager &SM = PP.getSourceManager();
1035 // If we are leaving the current presumed file, check to make sure the
1036 // presumed include stack isn't empty!
1038 SM.getDecomposedExpansionLoc(FlagTok.getLocation()).first;
1039 PresumedLoc PLoc = SM.getPresumedLoc(FlagTok.getLocation());
1040 if (PLoc.isInvalid())
1043 // If there is no include loc (main file) or if the include loc is in a
1044 // different physical file, then we aren't in a "1" line marker flag region.
1045 SourceLocation IncLoc = PLoc.getIncludeLoc();
1046 if (IncLoc.isInvalid() ||
1047 SM.getDecomposedExpansionLoc(IncLoc).first != CurFileID) {
1048 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_pop);
1049 PP.DiscardUntilEndOfDirective();
1054 if (FlagTok.is(tok::eod)) return false;
1055 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
1059 // We must have 3 if there are still flags.
1061 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
1062 PP.DiscardUntilEndOfDirective();
1066 IsSystemHeader = true;
1069 if (FlagTok.is(tok::eod)) return false;
1070 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
1073 // We must have 4 if there is yet another flag.
1075 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
1076 PP.DiscardUntilEndOfDirective();
1080 IsExternCHeader = true;
1083 if (FlagTok.is(tok::eod)) return false;
1085 // There are no more valid flags here.
1086 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
1087 PP.DiscardUntilEndOfDirective();
1091 /// HandleDigitDirective - Handle a GNU line marker directive, whose syntax is
1092 /// one of the following forms:
1095 /// # 42 "file" ('1' | '2')?
1096 /// # 42 "file" ('1' | '2')? '3' '4'?
1098 void Preprocessor::HandleDigitDirective(Token &DigitTok) {
1099 // Validate the number and convert it to an unsigned. GNU does not have a
1100 // line # limit other than it fit in 32-bits.
1102 if (GetLineValue(DigitTok, LineNo, diag::err_pp_linemarker_requires_integer,
1109 bool IsFileEntry = false, IsFileExit = false;
1110 bool IsSystemHeader = false, IsExternCHeader = false;
1111 int FilenameID = -1;
1113 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
1114 // string followed by eod.
1115 if (StrTok.is(tok::eod))
1117 else if (StrTok.isNot(tok::string_literal)) {
1118 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
1119 return DiscardUntilEndOfDirective();
1120 } else if (StrTok.hasUDSuffix()) {
1121 Diag(StrTok, diag::err_invalid_string_udl);
1122 return DiscardUntilEndOfDirective();
1124 // Parse and validate the string, converting it into a unique ID.
1125 StringLiteralParser Literal(&StrTok, 1, *this);
1126 assert(Literal.isAscii() && "Didn't allow wide strings in");
1127 if (Literal.hadError)
1128 return DiscardUntilEndOfDirective();
1129 if (Literal.Pascal) {
1130 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
1131 return DiscardUntilEndOfDirective();
1133 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
1135 // If a filename was present, read any flags that are present.
1136 if (ReadLineMarkerFlags(IsFileEntry, IsFileExit,
1137 IsSystemHeader, IsExternCHeader, *this))
1141 // Create a line note with this information.
1142 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID,
1143 IsFileEntry, IsFileExit,
1144 IsSystemHeader, IsExternCHeader);
1146 // If the preprocessor has callbacks installed, notify them of the #line
1147 // change. This is used so that the line marker comes out in -E mode for
1150 PPCallbacks::FileChangeReason Reason = PPCallbacks::RenameFile;
1152 Reason = PPCallbacks::EnterFile;
1153 else if (IsFileExit)
1154 Reason = PPCallbacks::ExitFile;
1155 SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
1156 if (IsExternCHeader)
1157 FileKind = SrcMgr::C_ExternCSystem;
1158 else if (IsSystemHeader)
1159 FileKind = SrcMgr::C_System;
1161 Callbacks->FileChanged(CurPPLexer->getSourceLocation(), Reason, FileKind);
1166 /// HandleUserDiagnosticDirective - Handle a #warning or #error directive.
1168 void Preprocessor::HandleUserDiagnosticDirective(Token &Tok,
1170 // PTH doesn't emit #warning or #error directives.
1172 return CurPTHLexer->DiscardToEndOfLine();
1174 // Read the rest of the line raw. We do this because we don't want macros
1175 // to be expanded and we don't require that the tokens be valid preprocessing
1176 // tokens. For example, this is allowed: "#warning ` 'foo". GCC does
1177 // collapse multiple consequtive white space between tokens, but this isn't
1178 // specified by the standard.
1179 SmallString<128> Message;
1180 CurLexer->ReadToEndOfLine(&Message);
1182 // Find the first non-whitespace character, so that we can make the
1183 // diagnostic more succinct.
1184 StringRef Msg = Message.str().ltrim(" ");
1187 Diag(Tok, diag::pp_hash_warning) << Msg;
1189 Diag(Tok, diag::err_pp_hash_error) << Msg;
1192 /// HandleIdentSCCSDirective - Handle a #ident/#sccs directive.
1194 void Preprocessor::HandleIdentSCCSDirective(Token &Tok) {
1195 // Yes, this directive is an extension.
1196 Diag(Tok, diag::ext_pp_ident_directive);
1198 // Read the string argument.
1202 // If the token kind isn't a string, it's a malformed directive.
1203 if (StrTok.isNot(tok::string_literal) &&
1204 StrTok.isNot(tok::wide_string_literal)) {
1205 Diag(StrTok, diag::err_pp_malformed_ident);
1206 if (StrTok.isNot(tok::eod))
1207 DiscardUntilEndOfDirective();
1211 if (StrTok.hasUDSuffix()) {
1212 Diag(StrTok, diag::err_invalid_string_udl);
1213 return DiscardUntilEndOfDirective();
1216 // Verify that there is nothing after the string, other than EOD.
1217 CheckEndOfDirective("ident");
1220 bool Invalid = false;
1221 std::string Str = getSpelling(StrTok, &Invalid);
1223 Callbacks->Ident(Tok.getLocation(), Str);
1227 /// \brief Handle a #public directive.
1228 void Preprocessor::HandleMacroPublicDirective(Token &Tok) {
1230 ReadMacroName(MacroNameTok, 2);
1232 // Error reading macro name? If so, diagnostic already issued.
1233 if (MacroNameTok.is(tok::eod))
1236 // Check to see if this is the last token on the #__public_macro line.
1237 CheckEndOfDirective("__public_macro");
1239 IdentifierInfo *II = MacroNameTok.getIdentifierInfo();
1240 // Okay, we finally have a valid identifier to undef.
1241 MacroDirective *MD = getMacroDirective(II);
1243 // If the macro is not defined, this is an error.
1245 Diag(MacroNameTok, diag::err_pp_visibility_non_macro) << II;
1249 // Note that this macro has now been exported.
1250 appendMacroDirective(II, AllocateVisibilityMacroDirective(
1251 MacroNameTok.getLocation(), /*IsPublic=*/true));
1254 /// \brief Handle a #private directive.
1255 void Preprocessor::HandleMacroPrivateDirective(Token &Tok) {
1257 ReadMacroName(MacroNameTok, 2);
1259 // Error reading macro name? If so, diagnostic already issued.
1260 if (MacroNameTok.is(tok::eod))
1263 // Check to see if this is the last token on the #__private_macro line.
1264 CheckEndOfDirective("__private_macro");
1266 IdentifierInfo *II = MacroNameTok.getIdentifierInfo();
1267 // Okay, we finally have a valid identifier to undef.
1268 MacroDirective *MD = getMacroDirective(II);
1270 // If the macro is not defined, this is an error.
1272 Diag(MacroNameTok, diag::err_pp_visibility_non_macro) << II;
1276 // Note that this macro has now been marked private.
1277 appendMacroDirective(II, AllocateVisibilityMacroDirective(
1278 MacroNameTok.getLocation(), /*IsPublic=*/false));
1281 //===----------------------------------------------------------------------===//
1282 // Preprocessor Include Directive Handling.
1283 //===----------------------------------------------------------------------===//
1285 /// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully
1286 /// checked and spelled filename, e.g. as an operand of \#include. This returns
1287 /// true if the input filename was in <>'s or false if it were in ""'s. The
1288 /// caller is expected to provide a buffer that is large enough to hold the
1289 /// spelling of the filename, but is also expected to handle the case when
1290 /// this method decides to use a different buffer.
1291 bool Preprocessor::GetIncludeFilenameSpelling(SourceLocation Loc,
1292 StringRef &Buffer) {
1293 // Get the text form of the filename.
1294 assert(!Buffer.empty() && "Can't have tokens with empty spellings!");
1296 // Make sure the filename is <x> or "x".
1298 if (Buffer[0] == '<') {
1299 if (Buffer.back() != '>') {
1300 Diag(Loc, diag::err_pp_expects_filename);
1301 Buffer = StringRef();
1305 } else if (Buffer[0] == '"') {
1306 if (Buffer.back() != '"') {
1307 Diag(Loc, diag::err_pp_expects_filename);
1308 Buffer = StringRef();
1313 Diag(Loc, diag::err_pp_expects_filename);
1314 Buffer = StringRef();
1318 // Diagnose #include "" as invalid.
1319 if (Buffer.size() <= 2) {
1320 Diag(Loc, diag::err_pp_empty_filename);
1321 Buffer = StringRef();
1325 // Skip the brackets.
1326 Buffer = Buffer.substr(1, Buffer.size()-2);
1330 /// \brief Handle cases where the \#include name is expanded from a macro
1331 /// as multiple tokens, which need to be glued together.
1333 /// This occurs for code like:
1335 /// \#define FOO <a/b.h>
1338 /// because in this case, "<a/b.h>" is returned as 7 tokens, not one.
1340 /// This code concatenates and consumes tokens up to the '>' token. It returns
1341 /// false if the > was found, otherwise it returns true if it finds and consumes
1343 bool Preprocessor::ConcatenateIncludeName(
1344 SmallString<128> &FilenameBuffer,
1345 SourceLocation &End) {
1349 while (CurTok.isNot(tok::eod)) {
1350 End = CurTok.getLocation();
1352 // FIXME: Provide code completion for #includes.
1353 if (CurTok.is(tok::code_completion)) {
1354 setCodeCompletionReached();
1359 // Append the spelling of this token to the buffer. If there was a space
1360 // before it, add it now.
1361 if (CurTok.hasLeadingSpace())
1362 FilenameBuffer.push_back(' ');
1364 // Get the spelling of the token, directly into FilenameBuffer if possible.
1365 unsigned PreAppendSize = FilenameBuffer.size();
1366 FilenameBuffer.resize(PreAppendSize+CurTok.getLength());
1368 const char *BufPtr = &FilenameBuffer[PreAppendSize];
1369 unsigned ActualLen = getSpelling(CurTok, BufPtr);
1371 // If the token was spelled somewhere else, copy it into FilenameBuffer.
1372 if (BufPtr != &FilenameBuffer[PreAppendSize])
1373 memcpy(&FilenameBuffer[PreAppendSize], BufPtr, ActualLen);
1375 // Resize FilenameBuffer to the correct size.
1376 if (CurTok.getLength() != ActualLen)
1377 FilenameBuffer.resize(PreAppendSize+ActualLen);
1379 // If we found the '>' marker, return success.
1380 if (CurTok.is(tok::greater))
1386 // If we hit the eod marker, emit an error and return true so that the caller
1387 // knows the EOD has been read.
1388 Diag(CurTok.getLocation(), diag::err_pp_expects_filename);
1392 /// HandleIncludeDirective - The "\#include" tokens have just been read, read
1393 /// the file to be included from the lexer, then include it! This is a common
1394 /// routine with functionality shared between \#include, \#include_next and
1395 /// \#import. LookupFrom is set when this is a \#include_next directive, it
1396 /// specifies the file to start searching from.
1397 void Preprocessor::HandleIncludeDirective(SourceLocation HashLoc,
1399 const DirectoryLookup *LookupFrom,
1403 CurPPLexer->LexIncludeFilename(FilenameTok);
1405 // Reserve a buffer to get the spelling.
1406 SmallString<128> FilenameBuffer;
1409 SourceLocation CharEnd; // the end of this directive, in characters
1411 switch (FilenameTok.getKind()) {
1413 // If the token kind is EOD, the error has already been diagnosed.
1416 case tok::angle_string_literal:
1417 case tok::string_literal:
1418 Filename = getSpelling(FilenameTok, FilenameBuffer);
1419 End = FilenameTok.getLocation();
1420 CharEnd = End.getLocWithOffset(FilenameTok.getLength());
1424 // This could be a <foo/bar.h> file coming from a macro expansion. In this
1425 // case, glue the tokens together into FilenameBuffer and interpret those.
1426 FilenameBuffer.push_back('<');
1427 if (ConcatenateIncludeName(FilenameBuffer, End))
1428 return; // Found <eod> but no ">"? Diagnostic already emitted.
1429 Filename = FilenameBuffer.str();
1430 CharEnd = End.getLocWithOffset(1);
1433 Diag(FilenameTok.getLocation(), diag::err_pp_expects_filename);
1434 DiscardUntilEndOfDirective();
1438 CharSourceRange FilenameRange
1439 = CharSourceRange::getCharRange(FilenameTok.getLocation(), CharEnd);
1440 StringRef OriginalFilename = Filename;
1442 GetIncludeFilenameSpelling(FilenameTok.getLocation(), Filename);
1443 // If GetIncludeFilenameSpelling set the start ptr to null, there was an
1445 if (Filename.empty()) {
1446 DiscardUntilEndOfDirective();
1450 // Verify that there is nothing after the filename, other than EOD. Note that
1451 // we allow macros that expand to nothing after the filename, because this
1452 // falls into the category of "#include pp-tokens new-line" specified in
1454 CheckEndOfDirective(IncludeTok.getIdentifierInfo()->getNameStart(), true);
1456 // Check that we don't have infinite #include recursion.
1457 if (IncludeMacroStack.size() == MaxAllowedIncludeStackDepth-1) {
1458 Diag(FilenameTok, diag::err_pp_include_too_deep);
1462 // Complain about attempts to #include files in an audit pragma.
1463 if (PragmaARCCFCodeAuditedLoc.isValid()) {
1464 Diag(HashLoc, diag::err_pp_include_in_arc_cf_code_audited);
1465 Diag(PragmaARCCFCodeAuditedLoc, diag::note_pragma_entered_here);
1467 // Immediately leave the pragma.
1468 PragmaARCCFCodeAuditedLoc = SourceLocation();
1471 if (HeaderInfo.HasIncludeAliasMap()) {
1472 // Map the filename with the brackets still attached. If the name doesn't
1473 // map to anything, fall back on the filename we've already gotten the
1475 StringRef NewName = HeaderInfo.MapHeaderToIncludeAlias(OriginalFilename);
1476 if (!NewName.empty())
1480 // Search include directories.
1481 const DirectoryLookup *CurDir;
1482 SmallString<1024> SearchPath;
1483 SmallString<1024> RelativePath;
1484 // We get the raw path only if we have 'Callbacks' to which we later pass
1486 ModuleMap::KnownHeader SuggestedModule;
1487 SourceLocation FilenameLoc = FilenameTok.getLocation();
1488 const FileEntry *File = LookupFile(
1489 FilenameLoc, Filename, isAngled, LookupFrom, CurDir,
1490 Callbacks ? &SearchPath : NULL, Callbacks ? &RelativePath : NULL,
1491 HeaderInfo.getHeaderSearchOpts().ModuleMaps ? &SuggestedModule : 0);
1495 // Give the clients a chance to recover.
1496 SmallString<128> RecoveryPath;
1497 if (Callbacks->FileNotFound(Filename, RecoveryPath)) {
1498 if (const DirectoryEntry *DE = FileMgr.getDirectory(RecoveryPath)) {
1499 // Add the recovery path to the list of search paths.
1500 DirectoryLookup DL(DE, SrcMgr::C_User, false);
1501 HeaderInfo.AddSearchPath(DL, isAngled);
1503 // Try the lookup again, skipping the cache.
1504 File = LookupFile(FilenameLoc, Filename, isAngled, LookupFrom, CurDir,
1505 0, 0, HeaderInfo.getHeaderSearchOpts().ModuleMaps
1508 /*SkipCache*/ true);
1513 if (!SuggestedModule || !getLangOpts().Modules) {
1514 // Notify the callback object that we've seen an inclusion directive.
1515 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled,
1516 FilenameRange, File,
1517 SearchPath, RelativePath,
1518 /*ImportedModule=*/0);
1523 if (!SuppressIncludeNotFoundError) {
1524 // If the file could not be located and it was included via angle
1525 // brackets, we can attempt a lookup as though it were a quoted path to
1526 // provide the user with a possible fixit.
1529 FilenameLoc, Filename, false, LookupFrom, CurDir,
1530 Callbacks ? &SearchPath : 0, Callbacks ? &RelativePath : 0,
1531 HeaderInfo.getHeaderSearchOpts().ModuleMaps ? &SuggestedModule : 0);
1533 SourceRange Range(FilenameTok.getLocation(), CharEnd);
1534 Diag(FilenameTok, diag::err_pp_file_not_found_not_fatal) <<
1536 FixItHint::CreateReplacement(Range, "\"" + Filename.str() + "\"");
1539 // If the file is still not found, just go with the vanilla diagnostic
1541 Diag(FilenameTok, diag::err_pp_file_not_found) << Filename;
1547 // If we are supposed to import a module rather than including the header,
1549 if (SuggestedModule && getLangOpts().Modules) {
1550 // Compute the module access path corresponding to this module.
1551 // FIXME: Should we have a second loadModule() overload to avoid this
1552 // extra lookup step?
1553 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1554 for (Module *Mod = SuggestedModule.getModule(); Mod; Mod = Mod->Parent)
1555 Path.push_back(std::make_pair(getIdentifierInfo(Mod->Name),
1556 FilenameTok.getLocation()));
1557 std::reverse(Path.begin(), Path.end());
1559 // Warn that we're replacing the include/import with a module import.
1560 SmallString<128> PathString;
1561 for (unsigned I = 0, N = Path.size(); I != N; ++I) {
1564 PathString += Path[I].first->getName();
1566 int IncludeKind = 0;
1568 switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) {
1569 case tok::pp_include:
1573 case tok::pp_import:
1577 case tok::pp_include_next:
1581 case tok::pp___include_macros:
1586 llvm_unreachable("unknown include directive kind");
1589 // Determine whether we are actually building the module that this
1590 // include directive maps to.
1591 bool BuildingImportedModule
1592 = Path[0].first->getName() == getLangOpts().CurrentModule;
1594 if (!BuildingImportedModule && getLangOpts().ObjC2) {
1595 // If we're not building the imported module, warn that we're going
1596 // to automatically turn this inclusion directive into a module import.
1597 // We only do this in Objective-C, where we have a module-import syntax.
1598 CharSourceRange ReplaceRange(SourceRange(HashLoc, CharEnd),
1599 /*IsTokenRange=*/false);
1600 Diag(HashLoc, diag::warn_auto_module_import)
1601 << IncludeKind << PathString
1602 << FixItHint::CreateReplacement(ReplaceRange,
1603 "@import " + PathString.str().str() + ";");
1606 // Load the module. Only make macros visible. We'll make the declarations
1607 // visible when the parser gets here.
1608 Module::NameVisibilityKind Visibility = Module::MacrosVisible;
1609 ModuleLoadResult Imported
1610 = TheModuleLoader.loadModule(IncludeTok.getLocation(), Path, Visibility,
1611 /*IsIncludeDirective=*/true);
1612 assert((Imported == 0 || Imported == SuggestedModule.getModule()) &&
1613 "the imported module is different than the suggested one");
1615 if (!Imported && hadModuleLoaderFatalFailure()) {
1616 // With a fatal failure in the module loader, we abort parsing.
1617 Token &Result = IncludeTok;
1619 Result.startToken();
1620 CurLexer->FormTokenWithChars(Result, CurLexer->BufferEnd, tok::eof);
1621 CurLexer->cutOffLexing();
1623 assert(CurPTHLexer && "#include but no current lexer set!");
1624 CurPTHLexer->getEOF(Result);
1629 // If this header isn't part of the module we're building, we're done.
1630 if (!BuildingImportedModule && Imported) {
1632 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled,
1633 FilenameRange, File,
1634 SearchPath, RelativePath, Imported);
1637 if (IncludeKind != 3) {
1638 // Let the parser know that we hit a module import, and it should
1639 // make the module visible.
1640 // FIXME: Produce this as the current token directly, rather than
1641 // allocating a new token for it.
1642 Token *Tok = new Token[1];
1643 Tok[0].startToken();
1644 Tok[0].setKind(tok::annot_module_include);
1645 Tok[0].setLocation(HashLoc);
1646 Tok[0].setAnnotationEndLoc(End);
1647 Tok[0].setAnnotationValue(Imported);
1648 EnterTokenStream(Tok, 1, true, true);
1653 // If we failed to find a submodule that we expected to find, we can
1654 // continue. Otherwise, there's an error in the included file, so we
1655 // don't want to include it.
1656 if (!BuildingImportedModule && !Imported.isMissingExpected()) {
1661 if (Callbacks && SuggestedModule) {
1662 // We didn't notify the callback object that we've seen an inclusion
1663 // directive before. Now that we are parsing the include normally and not
1664 // turning it to a module import, notify the callback object.
1665 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled,
1666 FilenameRange, File,
1667 SearchPath, RelativePath,
1668 /*ImportedModule=*/0);
1671 // The #included file will be considered to be a system header if either it is
1672 // in a system include directory, or if the #includer is a system include
1674 SrcMgr::CharacteristicKind FileCharacter =
1675 std::max(HeaderInfo.getFileDirFlavor(File),
1676 SourceMgr.getFileCharacteristic(FilenameTok.getLocation()));
1678 // Ask HeaderInfo if we should enter this #include file. If not, #including
1679 // this file will have no effect.
1680 if (!HeaderInfo.ShouldEnterIncludeFile(File, isImport)) {
1682 Callbacks->FileSkipped(*File, FilenameTok, FileCharacter);
1686 // Look up the file, create a File ID for it.
1687 SourceLocation IncludePos = End;
1688 // If the filename string was the result of macro expansions, set the include
1689 // position on the file where it will be included and after the expansions.
1690 if (IncludePos.isMacroID())
1691 IncludePos = SourceMgr.getExpansionRange(IncludePos).second;
1692 FileID FID = SourceMgr.createFileID(File, IncludePos, FileCharacter);
1693 assert(!FID.isInvalid() && "Expected valid file ID");
1695 // Finally, if all is good, enter the new file!
1696 EnterSourceFile(FID, CurDir, FilenameTok.getLocation());
1699 /// HandleIncludeNextDirective - Implements \#include_next.
1701 void Preprocessor::HandleIncludeNextDirective(SourceLocation HashLoc,
1702 Token &IncludeNextTok) {
1703 Diag(IncludeNextTok, diag::ext_pp_include_next_directive);
1705 // #include_next is like #include, except that we start searching after
1706 // the current found directory. If we can't do this, issue a
1708 const DirectoryLookup *Lookup = CurDirLookup;
1709 if (isInPrimaryFile()) {
1711 Diag(IncludeNextTok, diag::pp_include_next_in_primary);
1712 } else if (Lookup == 0) {
1713 Diag(IncludeNextTok, diag::pp_include_next_absolute_path);
1715 // Start looking up in the next directory.
1719 return HandleIncludeDirective(HashLoc, IncludeNextTok, Lookup);
1722 /// HandleMicrosoftImportDirective - Implements \#import for Microsoft Mode
1723 void Preprocessor::HandleMicrosoftImportDirective(Token &Tok) {
1724 // The Microsoft #import directive takes a type library and generates header
1725 // files from it, and includes those. This is beyond the scope of what clang
1726 // does, so we ignore it and error out. However, #import can optionally have
1727 // trailing attributes that span multiple lines. We're going to eat those
1728 // so we can continue processing from there.
1729 Diag(Tok, diag::err_pp_import_directive_ms );
1731 // Read tokens until we get to the end of the directive. Note that the
1732 // directive can be split over multiple lines using the backslash character.
1733 DiscardUntilEndOfDirective();
1736 /// HandleImportDirective - Implements \#import.
1738 void Preprocessor::HandleImportDirective(SourceLocation HashLoc,
1740 if (!LangOpts.ObjC1) { // #import is standard for ObjC.
1741 if (LangOpts.MicrosoftMode)
1742 return HandleMicrosoftImportDirective(ImportTok);
1743 Diag(ImportTok, diag::ext_pp_import_directive);
1745 return HandleIncludeDirective(HashLoc, ImportTok, 0, true);
1748 /// HandleIncludeMacrosDirective - The -imacros command line option turns into a
1749 /// pseudo directive in the predefines buffer. This handles it by sucking all
1750 /// tokens through the preprocessor and discarding them (only keeping the side
1751 /// effects on the preprocessor).
1752 void Preprocessor::HandleIncludeMacrosDirective(SourceLocation HashLoc,
1753 Token &IncludeMacrosTok) {
1754 // This directive should only occur in the predefines buffer. If not, emit an
1755 // error and reject it.
1756 SourceLocation Loc = IncludeMacrosTok.getLocation();
1757 if (strcmp(SourceMgr.getBufferName(Loc), "<built-in>") != 0) {
1758 Diag(IncludeMacrosTok.getLocation(),
1759 diag::pp_include_macros_out_of_predefines);
1760 DiscardUntilEndOfDirective();
1764 // Treat this as a normal #include for checking purposes. If this is
1765 // successful, it will push a new lexer onto the include stack.
1766 HandleIncludeDirective(HashLoc, IncludeMacrosTok, 0, false);
1771 assert(TmpTok.isNot(tok::eof) && "Didn't find end of -imacros!");
1772 } while (TmpTok.isNot(tok::hashhash));
1775 //===----------------------------------------------------------------------===//
1776 // Preprocessor Macro Directive Handling.
1777 //===----------------------------------------------------------------------===//
1779 /// ReadMacroDefinitionArgList - The ( starting an argument list of a macro
1780 /// definition has just been read. Lex the rest of the arguments and the
1781 /// closing ), updating MI with what we learn. Return true if an error occurs
1782 /// parsing the arg list.
1783 bool Preprocessor::ReadMacroDefinitionArgList(MacroInfo *MI, Token &Tok) {
1784 SmallVector<IdentifierInfo*, 32> Arguments;
1787 LexUnexpandedToken(Tok);
1788 switch (Tok.getKind()) {
1790 // Found the end of the argument list.
1791 if (Arguments.empty()) // #define FOO()
1793 // Otherwise we have #define FOO(A,)
1794 Diag(Tok, diag::err_pp_expected_ident_in_arg_list);
1796 case tok::ellipsis: // #define X(... -> C99 varargs
1798 Diag(Tok, LangOpts.CPlusPlus11 ?
1799 diag::warn_cxx98_compat_variadic_macro :
1800 diag::ext_variadic_macro);
1802 // OpenCL v1.2 s6.9.e: variadic macros are not supported.
1803 if (LangOpts.OpenCL) {
1804 Diag(Tok, diag::err_pp_opencl_variadic_macros);
1808 // Lex the token after the identifier.
1809 LexUnexpandedToken(Tok);
1810 if (Tok.isNot(tok::r_paren)) {
1811 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1814 // Add the __VA_ARGS__ identifier as an argument.
1815 Arguments.push_back(Ident__VA_ARGS__);
1816 MI->setIsC99Varargs();
1817 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
1819 case tok::eod: // #define X(
1820 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1823 // Handle keywords and identifiers here to accept things like
1824 // #define Foo(for) for.
1825 IdentifierInfo *II = Tok.getIdentifierInfo();
1828 Diag(Tok, diag::err_pp_invalid_tok_in_arg_list);
1832 // If this is already used as an argument, it is used multiple times (e.g.
1834 if (std::find(Arguments.begin(), Arguments.end(), II) !=
1835 Arguments.end()) { // C99 6.10.3p6
1836 Diag(Tok, diag::err_pp_duplicate_name_in_arg_list) << II;
1840 // Add the argument to the macro info.
1841 Arguments.push_back(II);
1843 // Lex the token after the identifier.
1844 LexUnexpandedToken(Tok);
1846 switch (Tok.getKind()) {
1847 default: // #define X(A B
1848 Diag(Tok, diag::err_pp_expected_comma_in_arg_list);
1850 case tok::r_paren: // #define X(A)
1851 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
1853 case tok::comma: // #define X(A,
1855 case tok::ellipsis: // #define X(A... -> GCC extension
1856 // Diagnose extension.
1857 Diag(Tok, diag::ext_named_variadic_macro);
1859 // Lex the token after the identifier.
1860 LexUnexpandedToken(Tok);
1861 if (Tok.isNot(tok::r_paren)) {
1862 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1866 MI->setIsGNUVarargs();
1867 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
1874 /// HandleDefineDirective - Implements \#define. This consumes the entire macro
1875 /// line then lets the caller lex the next real token.
1876 void Preprocessor::HandleDefineDirective(Token &DefineTok,
1877 bool ImmediatelyAfterHeaderGuard) {
1881 ReadMacroName(MacroNameTok, 1);
1883 // Error reading macro name? If so, diagnostic already issued.
1884 if (MacroNameTok.is(tok::eod))
1887 Token LastTok = MacroNameTok;
1889 // If we are supposed to keep comments in #defines, reenable comment saving
1891 if (CurLexer) CurLexer->SetCommentRetentionState(KeepMacroComments);
1893 // Create the new macro.
1894 MacroInfo *MI = AllocateMacroInfo(MacroNameTok.getLocation());
1897 LexUnexpandedToken(Tok);
1899 // If this is a function-like macro definition, parse the argument list,
1900 // marking each of the identifiers as being used as macro arguments. Also,
1901 // check other constraints on the first token of the macro body.
1902 if (Tok.is(tok::eod)) {
1903 if (ImmediatelyAfterHeaderGuard) {
1904 // Save this macro information since it may part of a header guard.
1905 CurPPLexer->MIOpt.SetDefinedMacro(MacroNameTok.getIdentifierInfo(),
1906 MacroNameTok.getLocation());
1908 // If there is no body to this macro, we have no special handling here.
1909 } else if (Tok.hasLeadingSpace()) {
1910 // This is a normal token with leading space. Clear the leading space
1911 // marker on the first token to get proper expansion.
1912 Tok.clearFlag(Token::LeadingSpace);
1913 } else if (Tok.is(tok::l_paren)) {
1914 // This is a function-like macro definition. Read the argument list.
1915 MI->setIsFunctionLike();
1916 if (ReadMacroDefinitionArgList(MI, LastTok)) {
1918 ReleaseMacroInfo(MI);
1919 // Throw away the rest of the line.
1920 if (CurPPLexer->ParsingPreprocessorDirective)
1921 DiscardUntilEndOfDirective();
1925 // If this is a definition of a variadic C99 function-like macro, not using
1926 // the GNU named varargs extension, enabled __VA_ARGS__.
1928 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
1929 // This gets unpoisoned where it is allowed.
1930 assert(Ident__VA_ARGS__->isPoisoned() && "__VA_ARGS__ should be poisoned!");
1931 if (MI->isC99Varargs())
1932 Ident__VA_ARGS__->setIsPoisoned(false);
1934 // Read the first token after the arg list for down below.
1935 LexUnexpandedToken(Tok);
1936 } else if (LangOpts.C99 || LangOpts.CPlusPlus11) {
1937 // C99 requires whitespace between the macro definition and the body. Emit
1938 // a diagnostic for something like "#define X+".
1939 Diag(Tok, diag::ext_c99_whitespace_required_after_macro_name);
1941 // C90 6.8 TC1 says: "In the definition of an object-like macro, if the
1942 // first character of a replacement list is not a character required by
1943 // subclause 5.2.1, then there shall be white-space separation between the
1944 // identifier and the replacement list.". 5.2.1 lists this set:
1945 // "A-Za-z0-9!"#%&'()*+,_./:;<=>?[\]^_{|}~" as well as whitespace, which
1946 // is irrelevant here.
1947 bool isInvalid = false;
1948 if (Tok.is(tok::at)) // @ is not in the list above.
1950 else if (Tok.is(tok::unknown)) {
1951 // If we have an unknown token, it is something strange like "`". Since
1952 // all of valid characters would have lexed into a single character
1953 // token of some sort, we know this is not a valid case.
1957 Diag(Tok, diag::ext_missing_whitespace_after_macro_name);
1959 Diag(Tok, diag::warn_missing_whitespace_after_macro_name);
1962 if (!Tok.is(tok::eod))
1965 // Read the rest of the macro body.
1966 if (MI->isObjectLike()) {
1967 // Object-like macros are very simple, just read their body.
1968 while (Tok.isNot(tok::eod)) {
1970 MI->AddTokenToBody(Tok);
1971 // Get the next token of the macro.
1972 LexUnexpandedToken(Tok);
1976 // Otherwise, read the body of a function-like macro. While we are at it,
1977 // check C99 6.10.3.2p1: ensure that # operators are followed by macro
1978 // parameters in function-like macro expansions.
1979 while (Tok.isNot(tok::eod)) {
1982 if (Tok.isNot(tok::hash) && Tok.isNot(tok::hashhash)) {
1983 MI->AddTokenToBody(Tok);
1985 // Get the next token of the macro.
1986 LexUnexpandedToken(Tok);
1990 // If we're in -traditional mode, then we should ignore stringification
1991 // and token pasting. Mark the tokens as unknown so as not to confuse
1993 if (getLangOpts().TraditionalCPP) {
1994 Tok.setKind(tok::unknown);
1995 MI->AddTokenToBody(Tok);
1997 // Get the next token of the macro.
1998 LexUnexpandedToken(Tok);
2002 if (Tok.is(tok::hashhash)) {
2004 // If we see token pasting, check if it looks like the gcc comma
2005 // pasting extension. We'll use this information to suppress
2006 // diagnostics later on.
2008 // Get the next token of the macro.
2009 LexUnexpandedToken(Tok);
2011 if (Tok.is(tok::eod)) {
2012 MI->AddTokenToBody(LastTok);
2016 unsigned NumTokens = MI->getNumTokens();
2017 if (NumTokens && Tok.getIdentifierInfo() == Ident__VA_ARGS__ &&
2018 MI->getReplacementToken(NumTokens-1).is(tok::comma))
2019 MI->setHasCommaPasting();
2021 // Things look ok, add the '##' token to the macro.
2022 MI->AddTokenToBody(LastTok);
2026 // Get the next token of the macro.
2027 LexUnexpandedToken(Tok);
2029 // Check for a valid macro arg identifier.
2030 if (Tok.getIdentifierInfo() == 0 ||
2031 MI->getArgumentNum(Tok.getIdentifierInfo()) == -1) {
2033 // If this is assembler-with-cpp mode, we accept random gibberish after
2034 // the '#' because '#' is often a comment character. However, change
2035 // the kind of the token to tok::unknown so that the preprocessor isn't
2037 if (getLangOpts().AsmPreprocessor && Tok.isNot(tok::eod)) {
2038 LastTok.setKind(tok::unknown);
2039 MI->AddTokenToBody(LastTok);
2042 Diag(Tok, diag::err_pp_stringize_not_parameter);
2043 ReleaseMacroInfo(MI);
2045 // Disable __VA_ARGS__ again.
2046 Ident__VA_ARGS__->setIsPoisoned(true);
2051 // Things look ok, add the '#' and param name tokens to the macro.
2052 MI->AddTokenToBody(LastTok);
2053 MI->AddTokenToBody(Tok);
2056 // Get the next token of the macro.
2057 LexUnexpandedToken(Tok);
2062 // Disable __VA_ARGS__ again.
2063 Ident__VA_ARGS__->setIsPoisoned(true);
2065 // Check that there is no paste (##) operator at the beginning or end of the
2066 // replacement list.
2067 unsigned NumTokens = MI->getNumTokens();
2068 if (NumTokens != 0) {
2069 if (MI->getReplacementToken(0).is(tok::hashhash)) {
2070 Diag(MI->getReplacementToken(0), diag::err_paste_at_start);
2071 ReleaseMacroInfo(MI);
2074 if (MI->getReplacementToken(NumTokens-1).is(tok::hashhash)) {
2075 Diag(MI->getReplacementToken(NumTokens-1), diag::err_paste_at_end);
2076 ReleaseMacroInfo(MI);
2081 MI->setDefinitionEndLoc(LastTok.getLocation());
2083 // Finally, if this identifier already had a macro defined for it, verify that
2084 // the macro bodies are identical, and issue diagnostics if they are not.
2085 if (const MacroInfo *OtherMI=getMacroInfo(MacroNameTok.getIdentifierInfo())) {
2086 // It is very common for system headers to have tons of macro redefinitions
2087 // and for warnings to be disabled in system headers. If this is the case,
2088 // then don't bother calling MacroInfo::isIdenticalTo.
2089 if (!getDiagnostics().getSuppressSystemWarnings() ||
2090 !SourceMgr.isInSystemHeader(DefineTok.getLocation())) {
2091 if (!OtherMI->isUsed() && OtherMI->isWarnIfUnused())
2092 Diag(OtherMI->getDefinitionLoc(), diag::pp_macro_not_used);
2094 // Warn if defining "__LINE__" and other builtins, per C99 6.10.8/4 and
2095 // C++ [cpp.predefined]p4, but allow it as an extension.
2096 if (OtherMI->isBuiltinMacro())
2097 Diag(MacroNameTok, diag::ext_pp_redef_builtin_macro);
2098 // Macros must be identical. This means all tokens and whitespace
2099 // separation must be the same. C99 6.10.3p2.
2100 else if (!OtherMI->isAllowRedefinitionsWithoutWarning() &&
2101 !MI->isIdenticalTo(*OtherMI, *this, /*Syntactic=*/LangOpts.MicrosoftExt)) {
2102 Diag(MI->getDefinitionLoc(), diag::ext_pp_macro_redef)
2103 << MacroNameTok.getIdentifierInfo();
2104 Diag(OtherMI->getDefinitionLoc(), diag::note_previous_definition);
2107 if (OtherMI->isWarnIfUnused())
2108 WarnUnusedMacroLocs.erase(OtherMI->getDefinitionLoc());
2111 DefMacroDirective *MD =
2112 appendDefMacroDirective(MacroNameTok.getIdentifierInfo(), MI);
2114 assert(!MI->isUsed());
2115 // If we need warning for not using the macro, add its location in the
2116 // warn-because-unused-macro set. If it gets used it will be removed from set.
2117 if (getSourceManager().isInMainFile(MI->getDefinitionLoc()) &&
2118 Diags->getDiagnosticLevel(diag::pp_macro_not_used,
2119 MI->getDefinitionLoc()) != DiagnosticsEngine::Ignored) {
2120 MI->setIsWarnIfUnused(true);
2121 WarnUnusedMacroLocs.insert(MI->getDefinitionLoc());
2124 // If the callbacks want to know, tell them about the macro definition.
2126 Callbacks->MacroDefined(MacroNameTok, MD);
2129 /// HandleUndefDirective - Implements \#undef.
2131 void Preprocessor::HandleUndefDirective(Token &UndefTok) {
2135 ReadMacroName(MacroNameTok, 2);
2137 // Error reading macro name? If so, diagnostic already issued.
2138 if (MacroNameTok.is(tok::eod))
2141 // Check to see if this is the last token on the #undef line.
2142 CheckEndOfDirective("undef");
2144 // Okay, we finally have a valid identifier to undef.
2145 MacroDirective *MD = getMacroDirective(MacroNameTok.getIdentifierInfo());
2146 const MacroInfo *MI = MD ? MD->getMacroInfo() : 0;
2148 // If the callbacks want to know, tell them about the macro #undef.
2149 // Note: no matter if the macro was defined or not.
2151 Callbacks->MacroUndefined(MacroNameTok, MD);
2153 // If the macro is not defined, this is a noop undef, just return.
2154 if (MI == 0) return;
2156 if (!MI->isUsed() && MI->isWarnIfUnused())
2157 Diag(MI->getDefinitionLoc(), diag::pp_macro_not_used);
2159 if (MI->isWarnIfUnused())
2160 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc());
2162 appendMacroDirective(MacroNameTok.getIdentifierInfo(),
2163 AllocateUndefMacroDirective(MacroNameTok.getLocation()));
2167 //===----------------------------------------------------------------------===//
2168 // Preprocessor Conditional Directive Handling.
2169 //===----------------------------------------------------------------------===//
2171 /// HandleIfdefDirective - Implements the \#ifdef/\#ifndef directive. isIfndef
2172 /// is true when this is a \#ifndef directive. ReadAnyTokensBeforeDirective is
2173 /// true if any tokens have been returned or pp-directives activated before this
2174 /// \#ifndef has been lexed.
2176 void Preprocessor::HandleIfdefDirective(Token &Result, bool isIfndef,
2177 bool ReadAnyTokensBeforeDirective) {
2179 Token DirectiveTok = Result;
2182 ReadMacroName(MacroNameTok);
2184 // Error reading macro name? If so, diagnostic already issued.
2185 if (MacroNameTok.is(tok::eod)) {
2186 // Skip code until we get to #endif. This helps with recovery by not
2187 // emitting an error when the #endif is reached.
2188 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
2189 /*Foundnonskip*/false, /*FoundElse*/false);
2193 // Check to see if this is the last token on the #if[n]def line.
2194 CheckEndOfDirective(isIfndef ? "ifndef" : "ifdef");
2196 IdentifierInfo *MII = MacroNameTok.getIdentifierInfo();
2197 MacroDirective *MD = getMacroDirective(MII);
2198 MacroInfo *MI = MD ? MD->getMacroInfo() : 0;
2200 if (CurPPLexer->getConditionalStackDepth() == 0) {
2201 // If the start of a top-level #ifdef and if the macro is not defined,
2202 // inform MIOpt that this might be the start of a proper include guard.
2203 // Otherwise it is some other form of unknown conditional which we can't
2205 if (!ReadAnyTokensBeforeDirective && MI == 0) {
2206 assert(isIfndef && "#ifdef shouldn't reach here");
2207 CurPPLexer->MIOpt.EnterTopLevelIfndef(MII, MacroNameTok.getLocation());
2209 CurPPLexer->MIOpt.EnterTopLevelConditional();
2212 // If there is a macro, process it.
2213 if (MI) // Mark it used.
2214 markMacroAsUsed(MI);
2218 Callbacks->Ifndef(DirectiveTok.getLocation(), MacroNameTok, MD);
2220 Callbacks->Ifdef(DirectiveTok.getLocation(), MacroNameTok, MD);
2223 // Should we include the stuff contained by this directive?
2224 if (!MI == isIfndef) {
2225 // Yes, remember that we are inside a conditional, then lex the next token.
2226 CurPPLexer->pushConditionalLevel(DirectiveTok.getLocation(),
2227 /*wasskip*/false, /*foundnonskip*/true,
2228 /*foundelse*/false);
2230 // No, skip the contents of this block.
2231 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
2232 /*Foundnonskip*/false,
2233 /*FoundElse*/false);
2237 /// HandleIfDirective - Implements the \#if directive.
2239 void Preprocessor::HandleIfDirective(Token &IfToken,
2240 bool ReadAnyTokensBeforeDirective) {
2243 // Parse and evaluate the conditional expression.
2244 IdentifierInfo *IfNDefMacro = 0;
2245 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
2246 const bool ConditionalTrue = EvaluateDirectiveExpression(IfNDefMacro);
2247 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
2249 // If this condition is equivalent to #ifndef X, and if this is the first
2250 // directive seen, handle it for the multiple-include optimization.
2251 if (CurPPLexer->getConditionalStackDepth() == 0) {
2252 if (!ReadAnyTokensBeforeDirective && IfNDefMacro && ConditionalTrue)
2253 // FIXME: Pass in the location of the macro name, not the 'if' token.
2254 CurPPLexer->MIOpt.EnterTopLevelIfndef(IfNDefMacro, IfToken.getLocation());
2256 CurPPLexer->MIOpt.EnterTopLevelConditional();
2260 Callbacks->If(IfToken.getLocation(),
2261 SourceRange(ConditionalBegin, ConditionalEnd),
2264 // Should we include the stuff contained by this directive?
2265 if (ConditionalTrue) {
2266 // Yes, remember that we are inside a conditional, then lex the next token.
2267 CurPPLexer->pushConditionalLevel(IfToken.getLocation(), /*wasskip*/false,
2268 /*foundnonskip*/true, /*foundelse*/false);
2270 // No, skip the contents of this block.
2271 SkipExcludedConditionalBlock(IfToken.getLocation(), /*Foundnonskip*/false,
2272 /*FoundElse*/false);
2276 /// HandleEndifDirective - Implements the \#endif directive.
2278 void Preprocessor::HandleEndifDirective(Token &EndifToken) {
2281 // Check that this is the whole directive.
2282 CheckEndOfDirective("endif");
2284 PPConditionalInfo CondInfo;
2285 if (CurPPLexer->popConditionalLevel(CondInfo)) {
2286 // No conditionals on the stack: this is an #endif without an #if.
2287 Diag(EndifToken, diag::err_pp_endif_without_if);
2291 // If this the end of a top-level #endif, inform MIOpt.
2292 if (CurPPLexer->getConditionalStackDepth() == 0)
2293 CurPPLexer->MIOpt.ExitTopLevelConditional();
2295 assert(!CondInfo.WasSkipping && !CurPPLexer->LexingRawMode &&
2296 "This code should only be reachable in the non-skipping case!");
2299 Callbacks->Endif(EndifToken.getLocation(), CondInfo.IfLoc);
2302 /// HandleElseDirective - Implements the \#else directive.
2304 void Preprocessor::HandleElseDirective(Token &Result) {
2307 // #else directive in a non-skipping conditional... start skipping.
2308 CheckEndOfDirective("else");
2310 PPConditionalInfo CI;
2311 if (CurPPLexer->popConditionalLevel(CI)) {
2312 Diag(Result, diag::pp_err_else_without_if);
2316 // If this is a top-level #else, inform the MIOpt.
2317 if (CurPPLexer->getConditionalStackDepth() == 0)
2318 CurPPLexer->MIOpt.EnterTopLevelConditional();
2320 // If this is a #else with a #else before it, report the error.
2321 if (CI.FoundElse) Diag(Result, diag::pp_err_else_after_else);
2324 Callbacks->Else(Result.getLocation(), CI.IfLoc);
2326 // Finally, skip the rest of the contents of this block.
2327 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
2328 /*FoundElse*/true, Result.getLocation());
2331 /// HandleElifDirective - Implements the \#elif directive.
2333 void Preprocessor::HandleElifDirective(Token &ElifToken) {
2336 // #elif directive in a non-skipping conditional... start skipping.
2337 // We don't care what the condition is, because we will always skip it (since
2338 // the block immediately before it was included).
2339 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
2340 DiscardUntilEndOfDirective();
2341 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
2343 PPConditionalInfo CI;
2344 if (CurPPLexer->popConditionalLevel(CI)) {
2345 Diag(ElifToken, diag::pp_err_elif_without_if);
2349 // If this is a top-level #elif, inform the MIOpt.
2350 if (CurPPLexer->getConditionalStackDepth() == 0)
2351 CurPPLexer->MIOpt.EnterTopLevelConditional();
2353 // If this is a #elif with a #else before it, report the error.
2354 if (CI.FoundElse) Diag(ElifToken, diag::pp_err_elif_after_else);
2357 Callbacks->Elif(ElifToken.getLocation(),
2358 SourceRange(ConditionalBegin, ConditionalEnd),
2361 // Finally, skip the rest of the contents of this block.
2362 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
2363 /*FoundElse*/CI.FoundElse,
2364 ElifToken.getLocation());