blob: e86680ef646c110678ccd5990ae10eb4bb1950a0 [file] [log] [blame]
Chris Lattnera3b605e2008-03-09 03:13:06 +00001//===--- PPDirectives.cpp - Directive Handling for Preprocessor -----------===//
Chris Lattner141e71f2008-03-09 01:54:53 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements # directive processing for the Preprocessor.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Lex/Preprocessor.h"
Chris Lattner359cc442009-01-26 05:29:08 +000015#include "clang/Lex/LiteralSupport.h"
Chris Lattner141e71f2008-03-09 01:54:53 +000016#include "clang/Lex/HeaderSearch.h"
17#include "clang/Lex/MacroInfo.h"
Chris Lattner500d3292009-01-29 05:15:15 +000018#include "clang/Lex/LexDiagnostic.h"
Douglas Gregorf44e8542010-08-24 19:08:16 +000019#include "clang/Lex/CodeCompletionHandler.h"
Douglas Gregorfba18aa2011-09-15 22:00:41 +000020#include "clang/Lex/ModuleLoader.h"
Douglas Gregor80c60f72010-09-09 22:45:38 +000021#include "clang/Lex/Pragma.h"
Chris Lattner6e290142009-11-30 04:18:44 +000022#include "clang/Basic/FileManager.h"
Chris Lattner141e71f2008-03-09 01:54:53 +000023#include "clang/Basic/SourceManager.h"
Chris Lattner359cc442009-01-26 05:29:08 +000024#include "llvm/ADT/APInt.h"
Douglas Gregore3a82562011-11-30 18:02:36 +000025#include "llvm/Support/ErrorHandling.h"
Chris Lattner141e71f2008-03-09 01:54:53 +000026using namespace clang;
27
28//===----------------------------------------------------------------------===//
29// Utility Methods for Preprocessor Directive Handling.
30//===----------------------------------------------------------------------===//
31
Chris Lattnerf47724b2010-08-17 15:55:45 +000032MacroInfo *Preprocessor::AllocateMacroInfo() {
Ted Kremenek9714a232010-10-19 22:15:20 +000033 MacroInfoChain *MIChain;
Mike Stump1eb44332009-09-09 15:08:12 +000034
Ted Kremenek9714a232010-10-19 22:15:20 +000035 if (MICache) {
36 MIChain = MICache;
37 MICache = MICache->Next;
Ted Kremenekaf8fa252010-10-19 18:16:54 +000038 }
Ted Kremenek9714a232010-10-19 22:15:20 +000039 else {
40 MIChain = BP.Allocate<MacroInfoChain>();
41 }
42
43 MIChain->Next = MIChainHead;
44 MIChain->Prev = 0;
45 if (MIChainHead)
46 MIChainHead->Prev = MIChain;
47 MIChainHead = MIChain;
48
49 return &(MIChain->MI);
Chris Lattnerf47724b2010-08-17 15:55:45 +000050}
51
52MacroInfo *Preprocessor::AllocateMacroInfo(SourceLocation L) {
53 MacroInfo *MI = AllocateMacroInfo();
Ted Kremenek0ea76722008-12-15 19:56:42 +000054 new (MI) MacroInfo(L);
55 return MI;
56}
57
Chris Lattnerf47724b2010-08-17 15:55:45 +000058MacroInfo *Preprocessor::CloneMacroInfo(const MacroInfo &MacroToClone) {
59 MacroInfo *MI = AllocateMacroInfo();
60 new (MI) MacroInfo(MacroToClone, BP);
61 return MI;
62}
63
Chris Lattner0301b3f2009-02-20 22:19:20 +000064/// ReleaseMacroInfo - Release the specified MacroInfo. This memory will
65/// be reused for allocating new MacroInfo objects.
Chris Lattner2c1ab902010-08-18 16:08:51 +000066void Preprocessor::ReleaseMacroInfo(MacroInfo *MI) {
Ted Kremenek9714a232010-10-19 22:15:20 +000067 MacroInfoChain *MIChain = (MacroInfoChain*) MI;
68 if (MacroInfoChain *Prev = MIChain->Prev) {
69 MacroInfoChain *Next = MIChain->Next;
70 Prev->Next = Next;
71 if (Next)
72 Next->Prev = Prev;
73 }
74 else {
75 assert(MIChainHead == MIChain);
76 MIChainHead = MIChain->Next;
77 MIChainHead->Prev = 0;
78 }
79 MIChain->Next = MICache;
80 MICache = MIChain;
Chris Lattner0301b3f2009-02-20 22:19:20 +000081
Ted Kremenek9714a232010-10-19 22:15:20 +000082 MI->Destroy();
83}
Chris Lattner0301b3f2009-02-20 22:19:20 +000084
Chris Lattner141e71f2008-03-09 01:54:53 +000085/// DiscardUntilEndOfDirective - Read and discard all tokens remaining on the
Peter Collingbourne84021552011-02-28 02:37:51 +000086/// current line until the tok::eod token is found.
Chris Lattner141e71f2008-03-09 01:54:53 +000087void Preprocessor::DiscardUntilEndOfDirective() {
88 Token Tmp;
89 do {
90 LexUnexpandedToken(Tmp);
Peter Collingbournea5ef5842011-02-22 13:49:06 +000091 assert(Tmp.isNot(tok::eof) && "EOF seen while discarding directive tokens");
Peter Collingbourne84021552011-02-28 02:37:51 +000092 } while (Tmp.isNot(tok::eod));
Chris Lattner141e71f2008-03-09 01:54:53 +000093}
94
Chris Lattner141e71f2008-03-09 01:54:53 +000095/// ReadMacroName - Lex and validate a macro name, which occurs after a
Peter Collingbourne84021552011-02-28 02:37:51 +000096/// #define or #undef. This sets the token kind to eod and discards the rest
Chris Lattner141e71f2008-03-09 01:54:53 +000097/// of the macro line if the macro name is invalid. isDefineUndef is 1 if
98/// this is due to a a #define, 2 if #undef directive, 0 if it is something
99/// else (e.g. #ifdef).
100void Preprocessor::ReadMacroName(Token &MacroNameTok, char isDefineUndef) {
101 // Read the token, don't allow macro expansion on it.
102 LexUnexpandedToken(MacroNameTok);
Mike Stump1eb44332009-09-09 15:08:12 +0000103
Douglas Gregor1fbb4472010-08-24 20:21:13 +0000104 if (MacroNameTok.is(tok::code_completion)) {
105 if (CodeComplete)
106 CodeComplete->CodeCompleteMacroName(isDefineUndef == 1);
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +0000107 setCodeCompletionReached();
Douglas Gregor1fbb4472010-08-24 20:21:13 +0000108 LexUnexpandedToken(MacroNameTok);
Douglas Gregor1fbb4472010-08-24 20:21:13 +0000109 }
110
Chris Lattner141e71f2008-03-09 01:54:53 +0000111 // Missing macro name?
Peter Collingbourne84021552011-02-28 02:37:51 +0000112 if (MacroNameTok.is(tok::eod)) {
Chris Lattner3692b092008-11-18 07:59:24 +0000113 Diag(MacroNameTok, diag::err_pp_missing_macro_name);
114 return;
115 }
Mike Stump1eb44332009-09-09 15:08:12 +0000116
Chris Lattner141e71f2008-03-09 01:54:53 +0000117 IdentifierInfo *II = MacroNameTok.getIdentifierInfo();
118 if (II == 0) {
Douglas Gregor453091c2010-03-16 22:30:13 +0000119 bool Invalid = false;
120 std::string Spelling = getSpelling(MacroNameTok, &Invalid);
121 if (Invalid)
122 return;
123
Chris Lattner9485d232008-12-13 20:12:40 +0000124 const IdentifierInfo &Info = Identifiers.get(Spelling);
125 if (Info.isCPlusPlusOperatorKeyword())
Chris Lattner141e71f2008-03-09 01:54:53 +0000126 // C++ 2.5p2: Alternative tokens behave the same as its primary token
127 // except for their spellings.
Chris Lattner56b05c82008-11-18 08:02:48 +0000128 Diag(MacroNameTok, diag::err_pp_operator_used_as_macro_name) << Spelling;
Chris Lattner141e71f2008-03-09 01:54:53 +0000129 else
130 Diag(MacroNameTok, diag::err_pp_macro_not_identifier);
131 // Fall through on error.
132 } else if (isDefineUndef && II->getPPKeywordID() == tok::pp_defined) {
133 // Error if defining "defined": C99 6.10.8.4.
134 Diag(MacroNameTok, diag::err_defined_macro_name);
135 } else if (isDefineUndef && II->hasMacroDefinition() &&
136 getMacroInfo(II)->isBuiltinMacro()) {
137 // Error if defining "__LINE__" and other builtins: C99 6.10.8.4.
138 if (isDefineUndef == 1)
139 Diag(MacroNameTok, diag::pp_redef_builtin_macro);
140 else
141 Diag(MacroNameTok, diag::pp_undef_builtin_macro);
142 } else {
143 // Okay, we got a good identifier node. Return it.
144 return;
145 }
Mike Stump1eb44332009-09-09 15:08:12 +0000146
Chris Lattner141e71f2008-03-09 01:54:53 +0000147 // Invalid macro name, read and discard the rest of the line. Then set the
Peter Collingbourne84021552011-02-28 02:37:51 +0000148 // token kind to tok::eod.
149 MacroNameTok.setKind(tok::eod);
Chris Lattner141e71f2008-03-09 01:54:53 +0000150 return DiscardUntilEndOfDirective();
151}
152
Peter Collingbourne84021552011-02-28 02:37:51 +0000153/// CheckEndOfDirective - Ensure that the next token is a tok::eod token. If
154/// not, emit a diagnostic and consume up until the eod. If EnableMacros is
Chris Lattnerab82f412009-04-17 23:30:53 +0000155/// true, then we consider macros that expand to zero tokens as being ok.
156void Preprocessor::CheckEndOfDirective(const char *DirType, bool EnableMacros) {
Chris Lattner141e71f2008-03-09 01:54:53 +0000157 Token Tmp;
Chris Lattnerab82f412009-04-17 23:30:53 +0000158 // Lex unexpanded tokens for most directives: macros might expand to zero
159 // tokens, causing us to miss diagnosing invalid lines. Some directives (like
160 // #line) allow empty macros.
161 if (EnableMacros)
162 Lex(Tmp);
163 else
164 LexUnexpandedToken(Tmp);
Mike Stump1eb44332009-09-09 15:08:12 +0000165
Chris Lattner141e71f2008-03-09 01:54:53 +0000166 // There should be no tokens after the directive, but we allow them as an
167 // extension.
168 while (Tmp.is(tok::comment)) // Skip comments in -C mode.
169 LexUnexpandedToken(Tmp);
Mike Stump1eb44332009-09-09 15:08:12 +0000170
Peter Collingbourne84021552011-02-28 02:37:51 +0000171 if (Tmp.isNot(tok::eod)) {
Chris Lattner959875a2009-04-14 05:15:20 +0000172 // Add a fixit in GNU/C99/C++ mode. Don't offer a fixit for strict-C89,
Peter Collingbourneb2eb53d2011-02-22 13:49:00 +0000173 // or if this is a macro-style preprocessing directive, because it is more
174 // trouble than it is worth to insert /**/ and check that there is no /**/
175 // in the range also.
Douglas Gregor849b2432010-03-31 17:46:05 +0000176 FixItHint Hint;
Peter Collingbourneb2eb53d2011-02-22 13:49:00 +0000177 if ((Features.GNUMode || Features.C99 || Features.CPlusPlus) &&
178 !CurTokenLexer)
Douglas Gregor849b2432010-03-31 17:46:05 +0000179 Hint = FixItHint::CreateInsertion(Tmp.getLocation(),"//");
180 Diag(Tmp, diag::ext_pp_extra_tokens_at_eol) << DirType << Hint;
Chris Lattner141e71f2008-03-09 01:54:53 +0000181 DiscardUntilEndOfDirective();
182 }
183}
184
185
186
187/// SkipExcludedConditionalBlock - We just read a #if or related directive and
188/// decided that the subsequent tokens are in the #if'd out portion of the
189/// file. Lex the rest of the file, until we see an #endif. If
190/// FoundNonSkipPortion is true, then we have already emitted code for part of
191/// this #if directive, so #else/#elif blocks should never be entered. If ElseOk
192/// is true, then #else directives are ok, if not, then we have already seen one
193/// so a #else directive is a duplicate. When this returns, the caller can lex
194/// the first valid token.
195void Preprocessor::SkipExcludedConditionalBlock(SourceLocation IfTokenLoc,
196 bool FoundNonSkipPortion,
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +0000197 bool FoundElse,
198 SourceLocation ElseLoc) {
Chris Lattner141e71f2008-03-09 01:54:53 +0000199 ++NumSkipped;
Ted Kremenekf6452c52008-11-18 01:04:47 +0000200 assert(CurTokenLexer == 0 && CurPPLexer && "Lexing a macro, not a file?");
Chris Lattner141e71f2008-03-09 01:54:53 +0000201
Ted Kremenek60e45d42008-11-18 00:34:22 +0000202 CurPPLexer->pushConditionalLevel(IfTokenLoc, /*isSkipping*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +0000203 FoundNonSkipPortion, FoundElse);
Mike Stump1eb44332009-09-09 15:08:12 +0000204
Ted Kremenek268ee702008-12-12 18:34:08 +0000205 if (CurPTHLexer) {
206 PTHSkipExcludedConditionalBlock();
207 return;
208 }
Mike Stump1eb44332009-09-09 15:08:12 +0000209
Chris Lattner141e71f2008-03-09 01:54:53 +0000210 // Enter raw mode to disable identifier lookup (and thus macro expansion),
211 // disabling warnings, etc.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000212 CurPPLexer->LexingRawMode = true;
Chris Lattner141e71f2008-03-09 01:54:53 +0000213 Token Tok;
214 while (1) {
Chris Lattner2c6b1932010-01-18 22:33:01 +0000215 CurLexer->Lex(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +0000216
Douglas Gregorf44e8542010-08-24 19:08:16 +0000217 if (Tok.is(tok::code_completion)) {
218 if (CodeComplete)
219 CodeComplete->CodeCompleteInConditionalExclusion();
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +0000220 setCodeCompletionReached();
Douglas Gregorf44e8542010-08-24 19:08:16 +0000221 continue;
222 }
223
Chris Lattner141e71f2008-03-09 01:54:53 +0000224 // If this is the end of the buffer, we have an error.
225 if (Tok.is(tok::eof)) {
226 // Emit errors for each unterminated conditional on the stack, including
227 // the current one.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000228 while (!CurPPLexer->ConditionalStack.empty()) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +0000229 if (CurLexer->getFileLoc() != CodeCompletionFileLoc)
Douglas Gregor2d474ba2010-08-12 17:04:55 +0000230 Diag(CurPPLexer->ConditionalStack.back().IfLoc,
231 diag::err_pp_unterminated_conditional);
Ted Kremenek60e45d42008-11-18 00:34:22 +0000232 CurPPLexer->ConditionalStack.pop_back();
Mike Stump1eb44332009-09-09 15:08:12 +0000233 }
234
Chris Lattner141e71f2008-03-09 01:54:53 +0000235 // Just return and let the caller lex after this #include.
236 break;
237 }
Mike Stump1eb44332009-09-09 15:08:12 +0000238
Chris Lattner141e71f2008-03-09 01:54:53 +0000239 // If this token is not a preprocessor directive, just skip it.
240 if (Tok.isNot(tok::hash) || !Tok.isAtStartOfLine())
241 continue;
Mike Stump1eb44332009-09-09 15:08:12 +0000242
Chris Lattner141e71f2008-03-09 01:54:53 +0000243 // We just parsed a # character at the start of a line, so we're in
244 // directive mode. Tell the lexer this so any newlines we see will be
Peter Collingbourne84021552011-02-28 02:37:51 +0000245 // converted into an EOD token (this terminates the macro).
Ted Kremenek60e45d42008-11-18 00:34:22 +0000246 CurPPLexer->ParsingPreprocessorDirective = true;
Ted Kremenekac6b06d2008-11-18 00:43:07 +0000247 if (CurLexer) CurLexer->SetCommentRetentionState(false);
Chris Lattner141e71f2008-03-09 01:54:53 +0000248
Mike Stump1eb44332009-09-09 15:08:12 +0000249
Chris Lattner141e71f2008-03-09 01:54:53 +0000250 // Read the next token, the directive flavor.
251 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +0000252
Chris Lattner141e71f2008-03-09 01:54:53 +0000253 // If this isn't an identifier directive (e.g. is "# 1\n" or "#\n", or
254 // something bogus), skip it.
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000255 if (Tok.isNot(tok::raw_identifier)) {
Ted Kremenek60e45d42008-11-18 00:34:22 +0000256 CurPPLexer->ParsingPreprocessorDirective = false;
Chris Lattner141e71f2008-03-09 01:54:53 +0000257 // Restore comment saving mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +0000258 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments);
Chris Lattner141e71f2008-03-09 01:54:53 +0000259 continue;
260 }
261
262 // If the first letter isn't i or e, it isn't intesting to us. We know that
263 // this is safe in the face of spelling differences, because there is no way
264 // to spell an i/e in a strange way that is another letter. Skipping this
265 // allows us to avoid looking up the identifier info for #define/#undef and
266 // other common directives.
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000267 const char *RawCharData = Tok.getRawIdentifierData();
268
Chris Lattner141e71f2008-03-09 01:54:53 +0000269 char FirstChar = RawCharData[0];
Mike Stump1eb44332009-09-09 15:08:12 +0000270 if (FirstChar >= 'a' && FirstChar <= 'z' &&
Chris Lattner141e71f2008-03-09 01:54:53 +0000271 FirstChar != 'i' && FirstChar != 'e') {
Ted Kremenek60e45d42008-11-18 00:34:22 +0000272 CurPPLexer->ParsingPreprocessorDirective = false;
Chris Lattner141e71f2008-03-09 01:54:53 +0000273 // Restore comment saving mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +0000274 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments);
Chris Lattner141e71f2008-03-09 01:54:53 +0000275 continue;
276 }
Mike Stump1eb44332009-09-09 15:08:12 +0000277
Chris Lattner141e71f2008-03-09 01:54:53 +0000278 // Get the identifier name without trigraphs or embedded newlines. Note
279 // that we can't use Tok.getIdentifierInfo() because its lookup is disabled
280 // when skipping.
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000281 char DirectiveBuf[20];
Chris Lattner5f9e2722011-07-23 10:55:15 +0000282 StringRef Directive;
Chris Lattner141e71f2008-03-09 01:54:53 +0000283 if (!Tok.needsCleaning() && Tok.getLength() < 20) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000284 Directive = StringRef(RawCharData, Tok.getLength());
Chris Lattner141e71f2008-03-09 01:54:53 +0000285 } else {
286 std::string DirectiveStr = getSpelling(Tok);
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000287 unsigned IdLen = DirectiveStr.size();
Chris Lattner141e71f2008-03-09 01:54:53 +0000288 if (IdLen >= 20) {
Ted Kremenek60e45d42008-11-18 00:34:22 +0000289 CurPPLexer->ParsingPreprocessorDirective = false;
Chris Lattner141e71f2008-03-09 01:54:53 +0000290 // Restore comment saving mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +0000291 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments);
Chris Lattner141e71f2008-03-09 01:54:53 +0000292 continue;
293 }
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000294 memcpy(DirectiveBuf, &DirectiveStr[0], IdLen);
Chris Lattner5f9e2722011-07-23 10:55:15 +0000295 Directive = StringRef(DirectiveBuf, IdLen);
Chris Lattner141e71f2008-03-09 01:54:53 +0000296 }
Mike Stump1eb44332009-09-09 15:08:12 +0000297
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000298 if (Directive.startswith("if")) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000299 StringRef Sub = Directive.substr(2);
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000300 if (Sub.empty() || // "if"
301 Sub == "def" || // "ifdef"
302 Sub == "ndef") { // "ifndef"
Chris Lattner141e71f2008-03-09 01:54:53 +0000303 // We know the entire #if/#ifdef/#ifndef block will be skipped, don't
304 // bother parsing the condition.
305 DiscardUntilEndOfDirective();
Ted Kremenek60e45d42008-11-18 00:34:22 +0000306 CurPPLexer->pushConditionalLevel(Tok.getLocation(), /*wasskipping*/true,
Chris Lattner141e71f2008-03-09 01:54:53 +0000307 /*foundnonskip*/false,
Chandler Carruth3a1a8742011-01-03 17:40:17 +0000308 /*foundelse*/false);
309
310 if (Callbacks)
311 Callbacks->Endif();
Chris Lattner141e71f2008-03-09 01:54:53 +0000312 }
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000313 } else if (Directive[0] == 'e') {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000314 StringRef Sub = Directive.substr(1);
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000315 if (Sub == "ndif") { // "endif"
Chris Lattner35410d52009-04-14 05:07:49 +0000316 CheckEndOfDirective("endif");
Chris Lattner141e71f2008-03-09 01:54:53 +0000317 PPConditionalInfo CondInfo;
318 CondInfo.WasSkipping = true; // Silence bogus warning.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000319 bool InCond = CurPPLexer->popConditionalLevel(CondInfo);
Jeffrey Yasskinc6ed7292010-12-23 01:01:28 +0000320 (void)InCond; // Silence warning in no-asserts mode.
Chris Lattner141e71f2008-03-09 01:54:53 +0000321 assert(!InCond && "Can't be skipping if not in a conditional!");
Mike Stump1eb44332009-09-09 15:08:12 +0000322
Chris Lattner141e71f2008-03-09 01:54:53 +0000323 // If we popped the outermost skipping block, we're done skipping!
324 if (!CondInfo.WasSkipping)
325 break;
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000326 } else if (Sub == "lse") { // "else".
Chris Lattner141e71f2008-03-09 01:54:53 +0000327 // #else directive in a skipping conditional. If not in some other
328 // skipping conditional, and if #else hasn't already been seen, enter it
329 // as a non-skipping conditional.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000330 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel();
Mike Stump1eb44332009-09-09 15:08:12 +0000331
Chris Lattner141e71f2008-03-09 01:54:53 +0000332 // If this is a #else with a #else before it, report the error.
333 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_else_after_else);
Mike Stump1eb44332009-09-09 15:08:12 +0000334
Chris Lattner141e71f2008-03-09 01:54:53 +0000335 // Note that we've seen a #else in this conditional.
336 CondInfo.FoundElse = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000337
Chandler Carruth3a1a8742011-01-03 17:40:17 +0000338 if (Callbacks)
339 Callbacks->Else();
340
Chris Lattner141e71f2008-03-09 01:54:53 +0000341 // If the conditional is at the top level, and the #if block wasn't
342 // entered, enter the #else block now.
343 if (!CondInfo.WasSkipping && !CondInfo.FoundNonSkip) {
344 CondInfo.FoundNonSkip = true;
Argyrios Kyrtzidise26224e2011-05-21 04:26:04 +0000345 CheckEndOfDirective("else");
Chris Lattner141e71f2008-03-09 01:54:53 +0000346 break;
Argyrios Kyrtzidise26224e2011-05-21 04:26:04 +0000347 } else {
348 DiscardUntilEndOfDirective(); // C99 6.10p4.
Chris Lattner141e71f2008-03-09 01:54:53 +0000349 }
Benjamin Kramerb939a4e2009-12-31 13:32:38 +0000350 } else if (Sub == "lif") { // "elif".
Ted Kremenek60e45d42008-11-18 00:34:22 +0000351 PPConditionalInfo &CondInfo = CurPPLexer->peekConditionalLevel();
Chris Lattner141e71f2008-03-09 01:54:53 +0000352
353 bool ShouldEnter;
Chandler Carruth3a1a8742011-01-03 17:40:17 +0000354 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
Chris Lattner141e71f2008-03-09 01:54:53 +0000355 // If this is in a skipping block or if we're already handled this #if
356 // block, don't bother parsing the condition.
357 if (CondInfo.WasSkipping || CondInfo.FoundNonSkip) {
358 DiscardUntilEndOfDirective();
359 ShouldEnter = false;
360 } else {
361 // Restore the value of LexingRawMode so that identifiers are
362 // looked up, etc, inside the #elif expression.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000363 assert(CurPPLexer->LexingRawMode && "We have to be skipping here!");
364 CurPPLexer->LexingRawMode = false;
Chris Lattner141e71f2008-03-09 01:54:53 +0000365 IdentifierInfo *IfNDefMacro = 0;
366 ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro);
Ted Kremenek60e45d42008-11-18 00:34:22 +0000367 CurPPLexer->LexingRawMode = true;
Chris Lattner141e71f2008-03-09 01:54:53 +0000368 }
Chandler Carruth3a1a8742011-01-03 17:40:17 +0000369 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
Mike Stump1eb44332009-09-09 15:08:12 +0000370
Chris Lattner141e71f2008-03-09 01:54:53 +0000371 // If this is a #elif with a #else before it, report the error.
372 if (CondInfo.FoundElse) Diag(Tok, diag::pp_err_elif_after_else);
Mike Stump1eb44332009-09-09 15:08:12 +0000373
Chandler Carruth3a1a8742011-01-03 17:40:17 +0000374 if (Callbacks)
375 Callbacks->Elif(SourceRange(ConditionalBegin, ConditionalEnd));
376
Chris Lattner141e71f2008-03-09 01:54:53 +0000377 // If this condition is true, enter it!
378 if (ShouldEnter) {
379 CondInfo.FoundNonSkip = true;
380 break;
381 }
382 }
383 }
Mike Stump1eb44332009-09-09 15:08:12 +0000384
Ted Kremenek60e45d42008-11-18 00:34:22 +0000385 CurPPLexer->ParsingPreprocessorDirective = false;
Chris Lattner141e71f2008-03-09 01:54:53 +0000386 // Restore comment saving mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +0000387 if (CurLexer) CurLexer->SetCommentRetentionState(KeepComments);
Chris Lattner141e71f2008-03-09 01:54:53 +0000388 }
389
390 // Finally, if we are out of the conditional (saw an #endif or ran off the end
391 // of the file, just stop skipping and return to lexing whatever came after
392 // the #if block.
Ted Kremenek60e45d42008-11-18 00:34:22 +0000393 CurPPLexer->LexingRawMode = false;
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +0000394
395 if (Callbacks) {
396 SourceLocation BeginLoc = ElseLoc.isValid() ? ElseLoc : IfTokenLoc;
397 Callbacks->SourceRangeSkipped(SourceRange(BeginLoc, Tok.getLocation()));
398 }
Chris Lattner141e71f2008-03-09 01:54:53 +0000399}
400
Ted Kremenek268ee702008-12-12 18:34:08 +0000401void Preprocessor::PTHSkipExcludedConditionalBlock() {
Mike Stump1eb44332009-09-09 15:08:12 +0000402
403 while (1) {
Ted Kremenek268ee702008-12-12 18:34:08 +0000404 assert(CurPTHLexer);
405 assert(CurPTHLexer->LexingRawMode == false);
Mike Stump1eb44332009-09-09 15:08:12 +0000406
Ted Kremenek268ee702008-12-12 18:34:08 +0000407 // Skip to the next '#else', '#elif', or #endif.
408 if (CurPTHLexer->SkipBlock()) {
409 // We have reached an #endif. Both the '#' and 'endif' tokens
410 // have been consumed by the PTHLexer. Just pop off the condition level.
411 PPConditionalInfo CondInfo;
412 bool InCond = CurPTHLexer->popConditionalLevel(CondInfo);
Jeffrey Yasskinc6ed7292010-12-23 01:01:28 +0000413 (void)InCond; // Silence warning in no-asserts mode.
Ted Kremenek268ee702008-12-12 18:34:08 +0000414 assert(!InCond && "Can't be skipping if not in a conditional!");
415 break;
416 }
Mike Stump1eb44332009-09-09 15:08:12 +0000417
Ted Kremenek268ee702008-12-12 18:34:08 +0000418 // We have reached a '#else' or '#elif'. Lex the next token to get
419 // the directive flavor.
420 Token Tok;
421 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +0000422
Ted Kremenek268ee702008-12-12 18:34:08 +0000423 // We can actually look up the IdentifierInfo here since we aren't in
424 // raw mode.
425 tok::PPKeywordKind K = Tok.getIdentifierInfo()->getPPKeywordID();
426
427 if (K == tok::pp_else) {
428 // #else: Enter the else condition. We aren't in a nested condition
429 // since we skip those. We're always in the one matching the last
430 // blocked we skipped.
431 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel();
432 // Note that we've seen a #else in this conditional.
433 CondInfo.FoundElse = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000434
Ted Kremenek268ee702008-12-12 18:34:08 +0000435 // If the #if block wasn't entered then enter the #else block now.
436 if (!CondInfo.FoundNonSkip) {
437 CondInfo.FoundNonSkip = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000438
Peter Collingbourne84021552011-02-28 02:37:51 +0000439 // Scan until the eod token.
Ted Kremeneke5680f32008-12-23 01:30:52 +0000440 CurPTHLexer->ParsingPreprocessorDirective = true;
Daniel Dunbar8533bd52009-04-13 17:57:49 +0000441 DiscardUntilEndOfDirective();
Ted Kremeneke5680f32008-12-23 01:30:52 +0000442 CurPTHLexer->ParsingPreprocessorDirective = false;
Mike Stump1eb44332009-09-09 15:08:12 +0000443
Ted Kremenek268ee702008-12-12 18:34:08 +0000444 break;
445 }
Mike Stump1eb44332009-09-09 15:08:12 +0000446
Ted Kremenek268ee702008-12-12 18:34:08 +0000447 // Otherwise skip this block.
448 continue;
449 }
Mike Stump1eb44332009-09-09 15:08:12 +0000450
Ted Kremenek268ee702008-12-12 18:34:08 +0000451 assert(K == tok::pp_elif);
452 PPConditionalInfo &CondInfo = CurPTHLexer->peekConditionalLevel();
453
454 // If this is a #elif with a #else before it, report the error.
455 if (CondInfo.FoundElse)
456 Diag(Tok, diag::pp_err_elif_after_else);
Mike Stump1eb44332009-09-09 15:08:12 +0000457
Ted Kremenek268ee702008-12-12 18:34:08 +0000458 // If this is in a skipping block or if we're already handled this #if
Mike Stump1eb44332009-09-09 15:08:12 +0000459 // block, don't bother parsing the condition. We just skip this block.
Ted Kremenek268ee702008-12-12 18:34:08 +0000460 if (CondInfo.FoundNonSkip)
461 continue;
462
463 // Evaluate the condition of the #elif.
464 IdentifierInfo *IfNDefMacro = 0;
465 CurPTHLexer->ParsingPreprocessorDirective = true;
466 bool ShouldEnter = EvaluateDirectiveExpression(IfNDefMacro);
467 CurPTHLexer->ParsingPreprocessorDirective = false;
468
469 // If this condition is true, enter it!
470 if (ShouldEnter) {
471 CondInfo.FoundNonSkip = true;
472 break;
473 }
474
475 // Otherwise, skip this block and go to the next one.
476 continue;
477 }
478}
479
Chris Lattner10725092008-03-09 04:17:44 +0000480/// LookupFile - Given a "foo" or <foo> reference, look up the indicated file,
481/// return null on failure. isAngled indicates whether the file reference is
482/// for system #include's or not (i.e. using <> instead of "").
Chandler Carruthb5142bb2011-03-16 18:34:36 +0000483const FileEntry *Preprocessor::LookupFile(
Chris Lattner5f9e2722011-07-23 10:55:15 +0000484 StringRef Filename,
Chandler Carruthb5142bb2011-03-16 18:34:36 +0000485 bool isAngled,
486 const DirectoryLookup *FromDir,
487 const DirectoryLookup *&CurDir,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000488 SmallVectorImpl<char> *SearchPath,
Douglas Gregorfba18aa2011-09-15 22:00:41 +0000489 SmallVectorImpl<char> *RelativePath,
Douglas Gregor1c2e9332011-11-20 17:46:46 +0000490 ModuleMap::Module **SuggestedModule,
491 bool SkipCache) {
Chris Lattner10725092008-03-09 04:17:44 +0000492 // If the header lookup mechanism may be relative to the current file, pass in
493 // info about where the current file is.
Douglas Gregor10fe93d2010-08-08 07:49:23 +0000494 const FileEntry *CurFileEnt = 0;
Chris Lattner10725092008-03-09 04:17:44 +0000495 if (!FromDir) {
Chris Lattner2b2453a2009-01-17 06:22:33 +0000496 FileID FID = getCurrentFileLexer()->getFileID();
Douglas Gregor10fe93d2010-08-08 07:49:23 +0000497 CurFileEnt = SourceMgr.getFileEntryForID(FID);
Mike Stump1eb44332009-09-09 15:08:12 +0000498
Chris Lattnerbe5c64d2009-02-04 19:45:07 +0000499 // If there is no file entry associated with this file, it must be the
500 // predefines buffer. Any other file is not lexed with a normal lexer, so
Douglas Gregor10fe93d2010-08-08 07:49:23 +0000501 // it won't be scanned for preprocessor directives. If we have the
502 // predefines buffer, resolve #include references (which come from the
503 // -include command line argument) as if they came from the main file, this
504 // affects file lookup etc.
505 if (CurFileEnt == 0) {
Chris Lattnerbe5c64d2009-02-04 19:45:07 +0000506 FID = SourceMgr.getMainFileID();
507 CurFileEnt = SourceMgr.getFileEntryForID(FID);
508 }
Chris Lattner10725092008-03-09 04:17:44 +0000509 }
Mike Stump1eb44332009-09-09 15:08:12 +0000510
Chris Lattner10725092008-03-09 04:17:44 +0000511 // Do a standard file entry lookup.
512 CurDir = CurDirLookup;
Chandler Carruthb5142bb2011-03-16 18:34:36 +0000513 const FileEntry *FE = HeaderInfo.LookupFile(
Manuel Klimek74124942011-04-26 21:50:03 +0000514 Filename, isAngled, FromDir, CurDir, CurFileEnt,
Douglas Gregor1c2e9332011-11-20 17:46:46 +0000515 SearchPath, RelativePath, SuggestedModule, SkipCache);
Chris Lattnerf45b6462010-01-22 00:14:44 +0000516 if (FE) return FE;
Mike Stump1eb44332009-09-09 15:08:12 +0000517
Chris Lattner10725092008-03-09 04:17:44 +0000518 // Otherwise, see if this is a subframework header. If so, this is relative
519 // to one of the headers on the #include stack. Walk the list of the current
520 // headers on the #include stack and pass them to HeaderInfo.
Douglas Gregorfba18aa2011-09-15 22:00:41 +0000521 // FIXME: SuggestedModule!
Ted Kremenek81d24e12008-11-20 16:19:53 +0000522 if (IsFileLexer()) {
Ted Kremenek41938c82008-11-19 21:57:25 +0000523 if ((CurFileEnt = SourceMgr.getFileEntryForID(CurPPLexer->getFileID())))
Chandler Carruthb5142bb2011-03-16 18:34:36 +0000524 if ((FE = HeaderInfo.LookupSubframeworkHeader(Filename, CurFileEnt,
Manuel Klimek74124942011-04-26 21:50:03 +0000525 SearchPath, RelativePath)))
Chris Lattner10725092008-03-09 04:17:44 +0000526 return FE;
527 }
Mike Stump1eb44332009-09-09 15:08:12 +0000528
Chris Lattner10725092008-03-09 04:17:44 +0000529 for (unsigned i = 0, e = IncludeMacroStack.size(); i != e; ++i) {
530 IncludeStackInfo &ISEntry = IncludeMacroStack[e-i-1];
Ted Kremenek81d24e12008-11-20 16:19:53 +0000531 if (IsFileLexer(ISEntry)) {
Mike Stump1eb44332009-09-09 15:08:12 +0000532 if ((CurFileEnt =
Ted Kremenek41938c82008-11-19 21:57:25 +0000533 SourceMgr.getFileEntryForID(ISEntry.ThePPLexer->getFileID())))
Manuel Klimek74124942011-04-26 21:50:03 +0000534 if ((FE = HeaderInfo.LookupSubframeworkHeader(
535 Filename, CurFileEnt, SearchPath, RelativePath)))
Chris Lattner10725092008-03-09 04:17:44 +0000536 return FE;
537 }
538 }
Mike Stump1eb44332009-09-09 15:08:12 +0000539
Chris Lattner10725092008-03-09 04:17:44 +0000540 // Otherwise, we really couldn't find the file.
541 return 0;
542}
543
Chris Lattner141e71f2008-03-09 01:54:53 +0000544
545//===----------------------------------------------------------------------===//
546// Preprocessor Directive Handling.
547//===----------------------------------------------------------------------===//
548
549/// HandleDirective - This callback is invoked when the lexer sees a # token
Mike Stump1eb44332009-09-09 15:08:12 +0000550/// at the start of a line. This consumes the directive, modifies the
Chris Lattner141e71f2008-03-09 01:54:53 +0000551/// lexer/preprocessor state, and advances the lexer(s) so that the next token
552/// read is the correct one.
553void Preprocessor::HandleDirective(Token &Result) {
554 // FIXME: Traditional: # with whitespace before it not recognized by K&R?
Mike Stump1eb44332009-09-09 15:08:12 +0000555
Chris Lattner141e71f2008-03-09 01:54:53 +0000556 // We just parsed a # character at the start of a line, so we're in directive
557 // mode. Tell the lexer this so any newlines we see will be converted into an
Peter Collingbourne84021552011-02-28 02:37:51 +0000558 // EOD token (which terminates the directive).
Ted Kremenek60e45d42008-11-18 00:34:22 +0000559 CurPPLexer->ParsingPreprocessorDirective = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000560
Chris Lattner141e71f2008-03-09 01:54:53 +0000561 ++NumDirectives;
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +0000562
Chris Lattner141e71f2008-03-09 01:54:53 +0000563 // We are about to read a token. For the multiple-include optimization FA to
Mike Stump1eb44332009-09-09 15:08:12 +0000564 // work, we have to remember if we had read any tokens *before* this
Chris Lattner141e71f2008-03-09 01:54:53 +0000565 // pp-directive.
Chris Lattner1d9c54d2009-12-14 04:54:40 +0000566 bool ReadAnyTokensBeforeDirective =CurPPLexer->MIOpt.getHasReadAnyTokensVal();
Mike Stump1eb44332009-09-09 15:08:12 +0000567
Chris Lattner42aa16c2009-03-18 21:00:25 +0000568 // Save the '#' token in case we need to return it later.
569 Token SavedHash = Result;
Mike Stump1eb44332009-09-09 15:08:12 +0000570
Chris Lattner141e71f2008-03-09 01:54:53 +0000571 // Read the next token, the directive flavor. This isn't expanded due to
572 // C99 6.10.3p8.
573 LexUnexpandedToken(Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000574
Chris Lattner141e71f2008-03-09 01:54:53 +0000575 // C99 6.10.3p11: Is this preprocessor directive in macro invocation? e.g.:
576 // #define A(x) #x
577 // A(abc
578 // #warning blah
579 // def)
580 // If so, the user is relying on non-portable behavior, emit a diagnostic.
581 if (InMacroArgs)
582 Diag(Result, diag::ext_embedded_directive);
Mike Stump1eb44332009-09-09 15:08:12 +0000583
Chris Lattner141e71f2008-03-09 01:54:53 +0000584TryAgain:
585 switch (Result.getKind()) {
Peter Collingbourne84021552011-02-28 02:37:51 +0000586 case tok::eod:
Chris Lattner141e71f2008-03-09 01:54:53 +0000587 return; // null directive.
588 case tok::comment:
589 // Handle stuff like "# /*foo*/ define X" in -E -C mode.
590 LexUnexpandedToken(Result);
591 goto TryAgain;
Douglas Gregorf44e8542010-08-24 19:08:16 +0000592 case tok::code_completion:
593 if (CodeComplete)
594 CodeComplete->CodeCompleteDirective(
595 CurPPLexer->getConditionalStackDepth() > 0);
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +0000596 setCodeCompletionReached();
Douglas Gregorf44e8542010-08-24 19:08:16 +0000597 return;
Chris Lattner478a18e2009-01-26 06:19:46 +0000598 case tok::numeric_constant: // # 7 GNU line marker directive.
Chris Lattner5f607c42009-03-18 20:41:10 +0000599 if (getLangOptions().AsmPreprocessor)
600 break; // # 4 is not a preprocessor directive in .S files.
Chris Lattner478a18e2009-01-26 06:19:46 +0000601 return HandleDigitDirective(Result);
Chris Lattner141e71f2008-03-09 01:54:53 +0000602 default:
603 IdentifierInfo *II = Result.getIdentifierInfo();
604 if (II == 0) break; // Not an identifier.
Mike Stump1eb44332009-09-09 15:08:12 +0000605
Chris Lattner141e71f2008-03-09 01:54:53 +0000606 // Ask what the preprocessor keyword ID is.
607 switch (II->getPPKeywordID()) {
608 default: break;
609 // C99 6.10.1 - Conditional Inclusion.
610 case tok::pp_if:
611 return HandleIfDirective(Result, ReadAnyTokensBeforeDirective);
612 case tok::pp_ifdef:
613 return HandleIfdefDirective(Result, false, true/*not valid for miopt*/);
614 case tok::pp_ifndef:
615 return HandleIfdefDirective(Result, true, ReadAnyTokensBeforeDirective);
616 case tok::pp_elif:
617 return HandleElifDirective(Result);
618 case tok::pp_else:
619 return HandleElseDirective(Result);
620 case tok::pp_endif:
621 return HandleEndifDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000622
Chris Lattner141e71f2008-03-09 01:54:53 +0000623 // C99 6.10.2 - Source File Inclusion.
624 case tok::pp_include:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000625 // Handle #include.
626 return HandleIncludeDirective(SavedHash.getLocation(), Result);
Chris Lattnerb8e240e2009-04-08 18:24:34 +0000627 case tok::pp___include_macros:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000628 // Handle -imacros.
629 return HandleIncludeMacrosDirective(SavedHash.getLocation(), Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000630
Chris Lattner141e71f2008-03-09 01:54:53 +0000631 // C99 6.10.3 - Macro Replacement.
632 case tok::pp_define:
633 return HandleDefineDirective(Result);
634 case tok::pp_undef:
635 return HandleUndefDirective(Result);
636
637 // C99 6.10.4 - Line Control.
638 case tok::pp_line:
Chris Lattner359cc442009-01-26 05:29:08 +0000639 return HandleLineDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000640
Chris Lattner141e71f2008-03-09 01:54:53 +0000641 // C99 6.10.5 - Error Directive.
642 case tok::pp_error:
643 return HandleUserDiagnosticDirective(Result, false);
Mike Stump1eb44332009-09-09 15:08:12 +0000644
Chris Lattner141e71f2008-03-09 01:54:53 +0000645 // C99 6.10.6 - Pragma Directive.
646 case tok::pp_pragma:
Douglas Gregor80c60f72010-09-09 22:45:38 +0000647 return HandlePragmaDirective(PIK_HashPragma);
Mike Stump1eb44332009-09-09 15:08:12 +0000648
Chris Lattner141e71f2008-03-09 01:54:53 +0000649 // GNU Extensions.
650 case tok::pp_import:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000651 return HandleImportDirective(SavedHash.getLocation(), Result);
Chris Lattner141e71f2008-03-09 01:54:53 +0000652 case tok::pp_include_next:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000653 return HandleIncludeNextDirective(SavedHash.getLocation(), Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000654
Chris Lattner141e71f2008-03-09 01:54:53 +0000655 case tok::pp_warning:
656 Diag(Result, diag::ext_pp_warning_directive);
657 return HandleUserDiagnosticDirective(Result, true);
658 case tok::pp_ident:
659 return HandleIdentSCCSDirective(Result);
660 case tok::pp_sccs:
661 return HandleIdentSCCSDirective(Result);
662 case tok::pp_assert:
663 //isExtension = true; // FIXME: implement #assert
664 break;
665 case tok::pp_unassert:
666 //isExtension = true; // FIXME: implement #unassert
667 break;
Douglas Gregor7143aab2011-09-01 17:04:32 +0000668
669 case tok::pp___export_macro__:
670 return HandleMacroExportDirective(Result);
Douglas Gregoraa93a872011-10-17 15:32:29 +0000671 case tok::pp___private_macro__:
672 return HandleMacroPrivateDirective(Result);
Chris Lattner141e71f2008-03-09 01:54:53 +0000673 }
674 break;
675 }
Mike Stump1eb44332009-09-09 15:08:12 +0000676
Chris Lattner42aa16c2009-03-18 21:00:25 +0000677 // If this is a .S file, treat unknown # directives as non-preprocessor
678 // directives. This is important because # may be a comment or introduce
679 // various pseudo-ops. Just return the # token and push back the following
680 // token to be lexed next time.
681 if (getLangOptions().AsmPreprocessor) {
Daniel Dunbar3d399a02009-07-13 21:48:50 +0000682 Token *Toks = new Token[2];
Chris Lattner42aa16c2009-03-18 21:00:25 +0000683 // Return the # and the token after it.
Mike Stump1eb44332009-09-09 15:08:12 +0000684 Toks[0] = SavedHash;
Chris Lattner42aa16c2009-03-18 21:00:25 +0000685 Toks[1] = Result;
Chris Lattnerba3ca522011-01-06 05:01:51 +0000686
687 // If the second token is a hashhash token, then we need to translate it to
688 // unknown so the token lexer doesn't try to perform token pasting.
689 if (Result.is(tok::hashhash))
690 Toks[1].setKind(tok::unknown);
691
Chris Lattner42aa16c2009-03-18 21:00:25 +0000692 // Enter this token stream so that we re-lex the tokens. Make sure to
693 // enable macro expansion, in case the token after the # is an identifier
694 // that is expanded.
695 EnterTokenStream(Toks, 2, false, true);
696 return;
697 }
Mike Stump1eb44332009-09-09 15:08:12 +0000698
Chris Lattner141e71f2008-03-09 01:54:53 +0000699 // If we reached here, the preprocessing token is not valid!
700 Diag(Result, diag::err_pp_invalid_directive);
Mike Stump1eb44332009-09-09 15:08:12 +0000701
Chris Lattner141e71f2008-03-09 01:54:53 +0000702 // Read the rest of the PP line.
703 DiscardUntilEndOfDirective();
Mike Stump1eb44332009-09-09 15:08:12 +0000704
Chris Lattner141e71f2008-03-09 01:54:53 +0000705 // Okay, we're done parsing the directive.
706}
707
Chris Lattner478a18e2009-01-26 06:19:46 +0000708/// GetLineValue - Convert a numeric token into an unsigned value, emitting
709/// Diagnostic DiagID if it is invalid, and returning the value in Val.
710static bool GetLineValue(Token &DigitTok, unsigned &Val,
711 unsigned DiagID, Preprocessor &PP) {
712 if (DigitTok.isNot(tok::numeric_constant)) {
713 PP.Diag(DigitTok, DiagID);
Mike Stump1eb44332009-09-09 15:08:12 +0000714
Peter Collingbourne84021552011-02-28 02:37:51 +0000715 if (DigitTok.isNot(tok::eod))
Chris Lattner478a18e2009-01-26 06:19:46 +0000716 PP.DiscardUntilEndOfDirective();
717 return true;
718 }
Mike Stump1eb44332009-09-09 15:08:12 +0000719
Chris Lattner478a18e2009-01-26 06:19:46 +0000720 llvm::SmallString<64> IntegerBuffer;
721 IntegerBuffer.resize(DigitTok.getLength());
722 const char *DigitTokBegin = &IntegerBuffer[0];
Douglas Gregor453091c2010-03-16 22:30:13 +0000723 bool Invalid = false;
724 unsigned ActualLength = PP.getSpelling(DigitTok, DigitTokBegin, &Invalid);
725 if (Invalid)
726 return true;
727
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000728 // Verify that we have a simple digit-sequence, and compute the value. This
729 // is always a simple digit string computed in decimal, so we do this manually
730 // here.
731 Val = 0;
732 for (unsigned i = 0; i != ActualLength; ++i) {
733 if (!isdigit(DigitTokBegin[i])) {
734 PP.Diag(PP.AdvanceToTokenCharacter(DigitTok.getLocation(), i),
735 diag::err_pp_line_digit_sequence);
736 PP.DiscardUntilEndOfDirective();
737 return true;
738 }
Mike Stump1eb44332009-09-09 15:08:12 +0000739
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000740 unsigned NextVal = Val*10+(DigitTokBegin[i]-'0');
741 if (NextVal < Val) { // overflow.
742 PP.Diag(DigitTok, DiagID);
743 PP.DiscardUntilEndOfDirective();
744 return true;
745 }
746 Val = NextVal;
Chris Lattner478a18e2009-01-26 06:19:46 +0000747 }
Mike Stump1eb44332009-09-09 15:08:12 +0000748
749 // Reject 0, this is needed both by #line numbers and flags.
Chris Lattner478a18e2009-01-26 06:19:46 +0000750 if (Val == 0) {
751 PP.Diag(DigitTok, DiagID);
752 PP.DiscardUntilEndOfDirective();
753 return true;
754 }
Mike Stump1eb44332009-09-09 15:08:12 +0000755
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000756 if (DigitTokBegin[0] == '0')
757 PP.Diag(DigitTok.getLocation(), diag::warn_pp_line_decimal);
Mike Stump1eb44332009-09-09 15:08:12 +0000758
Chris Lattner478a18e2009-01-26 06:19:46 +0000759 return false;
760}
761
Mike Stump1eb44332009-09-09 15:08:12 +0000762/// HandleLineDirective - Handle #line directive: C99 6.10.4. The two
Chris Lattner359cc442009-01-26 05:29:08 +0000763/// acceptable forms are:
764/// # line digit-sequence
765/// # line digit-sequence "s-char-sequence"
766void Preprocessor::HandleLineDirective(Token &Tok) {
767 // Read the line # and string argument. Per C99 6.10.4p5, these tokens are
768 // expanded.
769 Token DigitTok;
770 Lex(DigitTok);
771
Chris Lattner359cc442009-01-26 05:29:08 +0000772 // Validate the number and convert it to an unsigned.
Chris Lattner478a18e2009-01-26 06:19:46 +0000773 unsigned LineNo;
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000774 if (GetLineValue(DigitTok, LineNo, diag::err_pp_line_requires_integer,*this))
Chris Lattner359cc442009-01-26 05:29:08 +0000775 return;
Chris Lattner359cc442009-01-26 05:29:08 +0000776
Chris Lattner478a18e2009-01-26 06:19:46 +0000777 // Enforce C99 6.10.4p3: "The digit sequence shall not specify ... a
778 // number greater than 2147483647". C90 requires that the line # be <= 32767.
Eli Friedman158ebfb2011-10-10 23:35:28 +0000779 unsigned LineLimit = 32768U;
780 if (Features.C99 || Features.CPlusPlus0x)
781 LineLimit = 2147483648U;
Chris Lattner359cc442009-01-26 05:29:08 +0000782 if (LineNo >= LineLimit)
783 Diag(DigitTok, diag::ext_pp_line_too_big) << LineLimit;
Richard Smith661a9962011-10-15 01:18:56 +0000784 else if (Features.CPlusPlus0x && LineNo >= 32768U)
785 Diag(DigitTok, diag::warn_cxx98_compat_pp_line_too_big);
Mike Stump1eb44332009-09-09 15:08:12 +0000786
Chris Lattner5b9a5042009-01-26 07:57:50 +0000787 int FilenameID = -1;
Chris Lattner359cc442009-01-26 05:29:08 +0000788 Token StrTok;
789 Lex(StrTok);
790
Peter Collingbourne84021552011-02-28 02:37:51 +0000791 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
792 // string followed by eod.
793 if (StrTok.is(tok::eod))
Chris Lattner359cc442009-01-26 05:29:08 +0000794 ; // ok
795 else if (StrTok.isNot(tok::string_literal)) {
796 Diag(StrTok, diag::err_pp_line_invalid_filename);
797 DiscardUntilEndOfDirective();
798 return;
799 } else {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000800 // Parse and validate the string, converting it into a unique ID.
801 StringLiteralParser Literal(&StrTok, 1, *this);
Douglas Gregor5cee1192011-07-27 05:40:30 +0000802 assert(Literal.isAscii() && "Didn't allow wide strings in");
Chris Lattner5b9a5042009-01-26 07:57:50 +0000803 if (Literal.hadError)
804 return DiscardUntilEndOfDirective();
805 if (Literal.Pascal) {
806 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
807 return DiscardUntilEndOfDirective();
808 }
Jay Foad65aa6882011-06-21 15:13:30 +0000809 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
Mike Stump1eb44332009-09-09 15:08:12 +0000810
Peter Collingbourne84021552011-02-28 02:37:51 +0000811 // Verify that there is nothing after the string, other than EOD. Because
Chris Lattnerab82f412009-04-17 23:30:53 +0000812 // of C99 6.10.4p5, macros that expand to empty tokens are ok.
813 CheckEndOfDirective("line", true);
Chris Lattner359cc442009-01-26 05:29:08 +0000814 }
Mike Stump1eb44332009-09-09 15:08:12 +0000815
Chris Lattner4c4ea172009-02-03 21:52:55 +0000816 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID);
Mike Stump1eb44332009-09-09 15:08:12 +0000817
Chris Lattner16629382009-03-27 17:13:49 +0000818 if (Callbacks)
Chris Lattner86d0ef72010-04-14 04:28:50 +0000819 Callbacks->FileChanged(CurPPLexer->getSourceLocation(),
820 PPCallbacks::RenameFile,
Chris Lattner16629382009-03-27 17:13:49 +0000821 SrcMgr::C_User);
Chris Lattner359cc442009-01-26 05:29:08 +0000822}
823
Chris Lattner478a18e2009-01-26 06:19:46 +0000824/// ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line
825/// marker directive.
826static bool ReadLineMarkerFlags(bool &IsFileEntry, bool &IsFileExit,
827 bool &IsSystemHeader, bool &IsExternCHeader,
828 Preprocessor &PP) {
829 unsigned FlagVal;
830 Token FlagTok;
831 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000832 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000833 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
834 return true;
835
836 if (FlagVal == 1) {
837 IsFileEntry = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000838
Chris Lattner478a18e2009-01-26 06:19:46 +0000839 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000840 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000841 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
842 return true;
843 } else if (FlagVal == 2) {
844 IsFileExit = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000845
Chris Lattner137b6a62009-02-04 06:25:26 +0000846 SourceManager &SM = PP.getSourceManager();
847 // If we are leaving the current presumed file, check to make sure the
848 // presumed include stack isn't empty!
849 FileID CurFileID =
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000850 SM.getDecomposedExpansionLoc(FlagTok.getLocation()).first;
Chris Lattner137b6a62009-02-04 06:25:26 +0000851 PresumedLoc PLoc = SM.getPresumedLoc(FlagTok.getLocation());
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000852 if (PLoc.isInvalid())
853 return true;
854
Chris Lattner137b6a62009-02-04 06:25:26 +0000855 // If there is no include loc (main file) or if the include loc is in a
856 // different physical file, then we aren't in a "1" line marker flag region.
857 SourceLocation IncLoc = PLoc.getIncludeLoc();
858 if (IncLoc.isInvalid() ||
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000859 SM.getDecomposedExpansionLoc(IncLoc).first != CurFileID) {
Chris Lattner137b6a62009-02-04 06:25:26 +0000860 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_pop);
861 PP.DiscardUntilEndOfDirective();
862 return true;
863 }
Mike Stump1eb44332009-09-09 15:08:12 +0000864
Chris Lattner478a18e2009-01-26 06:19:46 +0000865 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000866 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000867 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
868 return true;
869 }
870
871 // We must have 3 if there are still flags.
872 if (FlagVal != 3) {
873 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000874 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000875 return true;
876 }
Mike Stump1eb44332009-09-09 15:08:12 +0000877
Chris Lattner478a18e2009-01-26 06:19:46 +0000878 IsSystemHeader = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000879
Chris Lattner478a18e2009-01-26 06:19:46 +0000880 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000881 if (FlagTok.is(tok::eod)) return false;
Chris Lattner9d79eba2009-02-04 05:21:58 +0000882 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
Chris Lattner478a18e2009-01-26 06:19:46 +0000883 return true;
884
885 // We must have 4 if there is yet another flag.
886 if (FlagVal != 4) {
887 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000888 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000889 return true;
890 }
Mike Stump1eb44332009-09-09 15:08:12 +0000891
Chris Lattner478a18e2009-01-26 06:19:46 +0000892 IsExternCHeader = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000893
Chris Lattner478a18e2009-01-26 06:19:46 +0000894 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000895 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000896
897 // There are no more valid flags here.
898 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000899 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000900 return true;
901}
902
903/// HandleDigitDirective - Handle a GNU line marker directive, whose syntax is
904/// one of the following forms:
905///
906/// # 42
Mike Stump1eb44332009-09-09 15:08:12 +0000907/// # 42 "file" ('1' | '2')?
Chris Lattner478a18e2009-01-26 06:19:46 +0000908/// # 42 "file" ('1' | '2')? '3' '4'?
909///
910void Preprocessor::HandleDigitDirective(Token &DigitTok) {
911 // Validate the number and convert it to an unsigned. GNU does not have a
912 // line # limit other than it fit in 32-bits.
913 unsigned LineNo;
914 if (GetLineValue(DigitTok, LineNo, diag::err_pp_linemarker_requires_integer,
915 *this))
916 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000917
Chris Lattner478a18e2009-01-26 06:19:46 +0000918 Token StrTok;
919 Lex(StrTok);
Mike Stump1eb44332009-09-09 15:08:12 +0000920
Chris Lattner478a18e2009-01-26 06:19:46 +0000921 bool IsFileEntry = false, IsFileExit = false;
922 bool IsSystemHeader = false, IsExternCHeader = false;
Chris Lattner5b9a5042009-01-26 07:57:50 +0000923 int FilenameID = -1;
924
Peter Collingbourne84021552011-02-28 02:37:51 +0000925 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
926 // string followed by eod.
927 if (StrTok.is(tok::eod))
Chris Lattner478a18e2009-01-26 06:19:46 +0000928 ; // ok
929 else if (StrTok.isNot(tok::string_literal)) {
930 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000931 return DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000932 } else {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000933 // Parse and validate the string, converting it into a unique ID.
934 StringLiteralParser Literal(&StrTok, 1, *this);
Douglas Gregor5cee1192011-07-27 05:40:30 +0000935 assert(Literal.isAscii() && "Didn't allow wide strings in");
Chris Lattner5b9a5042009-01-26 07:57:50 +0000936 if (Literal.hadError)
937 return DiscardUntilEndOfDirective();
938 if (Literal.Pascal) {
939 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
940 return DiscardUntilEndOfDirective();
941 }
Jay Foad65aa6882011-06-21 15:13:30 +0000942 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
Mike Stump1eb44332009-09-09 15:08:12 +0000943
Chris Lattner478a18e2009-01-26 06:19:46 +0000944 // If a filename was present, read any flags that are present.
Mike Stump1eb44332009-09-09 15:08:12 +0000945 if (ReadLineMarkerFlags(IsFileEntry, IsFileExit,
Chris Lattner5b9a5042009-01-26 07:57:50 +0000946 IsSystemHeader, IsExternCHeader, *this))
Chris Lattner478a18e2009-01-26 06:19:46 +0000947 return;
Chris Lattner478a18e2009-01-26 06:19:46 +0000948 }
Mike Stump1eb44332009-09-09 15:08:12 +0000949
Chris Lattner9d79eba2009-02-04 05:21:58 +0000950 // Create a line note with this information.
951 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID,
Mike Stump1eb44332009-09-09 15:08:12 +0000952 IsFileEntry, IsFileExit,
Chris Lattner9d79eba2009-02-04 05:21:58 +0000953 IsSystemHeader, IsExternCHeader);
Mike Stump1eb44332009-09-09 15:08:12 +0000954
Chris Lattner16629382009-03-27 17:13:49 +0000955 // If the preprocessor has callbacks installed, notify them of the #line
956 // change. This is used so that the line marker comes out in -E mode for
957 // example.
958 if (Callbacks) {
959 PPCallbacks::FileChangeReason Reason = PPCallbacks::RenameFile;
960 if (IsFileEntry)
961 Reason = PPCallbacks::EnterFile;
962 else if (IsFileExit)
963 Reason = PPCallbacks::ExitFile;
964 SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
965 if (IsExternCHeader)
966 FileKind = SrcMgr::C_ExternCSystem;
967 else if (IsSystemHeader)
968 FileKind = SrcMgr::C_System;
Mike Stump1eb44332009-09-09 15:08:12 +0000969
Chris Lattner86d0ef72010-04-14 04:28:50 +0000970 Callbacks->FileChanged(CurPPLexer->getSourceLocation(), Reason, FileKind);
Chris Lattner16629382009-03-27 17:13:49 +0000971 }
Chris Lattner478a18e2009-01-26 06:19:46 +0000972}
973
974
Chris Lattner099dd052009-01-26 05:30:54 +0000975/// HandleUserDiagnosticDirective - Handle a #warning or #error directive.
976///
Mike Stump1eb44332009-09-09 15:08:12 +0000977void Preprocessor::HandleUserDiagnosticDirective(Token &Tok,
Chris Lattner141e71f2008-03-09 01:54:53 +0000978 bool isWarning) {
Chris Lattner099dd052009-01-26 05:30:54 +0000979 // PTH doesn't emit #warning or #error directives.
980 if (CurPTHLexer)
Chris Lattner359cc442009-01-26 05:29:08 +0000981 return CurPTHLexer->DiscardToEndOfLine();
982
Chris Lattner141e71f2008-03-09 01:54:53 +0000983 // Read the rest of the line raw. We do this because we don't want macros
984 // to be expanded and we don't require that the tokens be valid preprocessing
985 // tokens. For example, this is allowed: "#warning ` 'foo". GCC does
986 // collapse multiple consequtive white space between tokens, but this isn't
987 // specified by the standard.
Chris Lattner359cc442009-01-26 05:29:08 +0000988 std::string Message = CurLexer->ReadToEndOfLine();
989 if (isWarning)
990 Diag(Tok, diag::pp_hash_warning) << Message;
991 else
992 Diag(Tok, diag::err_pp_hash_error) << Message;
Chris Lattner141e71f2008-03-09 01:54:53 +0000993}
994
995/// HandleIdentSCCSDirective - Handle a #ident/#sccs directive.
996///
997void Preprocessor::HandleIdentSCCSDirective(Token &Tok) {
998 // Yes, this directive is an extension.
999 Diag(Tok, diag::ext_pp_ident_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001000
Chris Lattner141e71f2008-03-09 01:54:53 +00001001 // Read the string argument.
1002 Token StrTok;
1003 Lex(StrTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001004
Chris Lattner141e71f2008-03-09 01:54:53 +00001005 // If the token kind isn't a string, it's a malformed directive.
1006 if (StrTok.isNot(tok::string_literal) &&
Chris Lattner3692b092008-11-18 07:59:24 +00001007 StrTok.isNot(tok::wide_string_literal)) {
1008 Diag(StrTok, diag::err_pp_malformed_ident);
Peter Collingbourne84021552011-02-28 02:37:51 +00001009 if (StrTok.isNot(tok::eod))
Chris Lattner099dd052009-01-26 05:30:54 +00001010 DiscardUntilEndOfDirective();
Chris Lattner3692b092008-11-18 07:59:24 +00001011 return;
1012 }
Mike Stump1eb44332009-09-09 15:08:12 +00001013
Peter Collingbourne84021552011-02-28 02:37:51 +00001014 // Verify that there is nothing after the string, other than EOD.
Chris Lattner35410d52009-04-14 05:07:49 +00001015 CheckEndOfDirective("ident");
Chris Lattner141e71f2008-03-09 01:54:53 +00001016
Douglas Gregor453091c2010-03-16 22:30:13 +00001017 if (Callbacks) {
1018 bool Invalid = false;
1019 std::string Str = getSpelling(StrTok, &Invalid);
1020 if (!Invalid)
1021 Callbacks->Ident(Tok.getLocation(), Str);
1022 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001023}
1024
Douglas Gregor7143aab2011-09-01 17:04:32 +00001025/// \brief Handle a #__export_macro__ directive.
1026void Preprocessor::HandleMacroExportDirective(Token &Tok) {
1027 Token MacroNameTok;
1028 ReadMacroName(MacroNameTok, 2);
1029
1030 // Error reading macro name? If so, diagnostic already issued.
1031 if (MacroNameTok.is(tok::eod))
1032 return;
1033
1034 // Check to see if this is the last token on the #__export_macro__ line.
1035 CheckEndOfDirective("__export_macro__");
1036
1037 // Okay, we finally have a valid identifier to undef.
1038 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
1039
1040 // If the macro is not defined, this is an error.
1041 if (MI == 0) {
Douglas Gregoraa93a872011-10-17 15:32:29 +00001042 Diag(MacroNameTok, diag::err_pp_visibility_non_macro)
Douglas Gregor7143aab2011-09-01 17:04:32 +00001043 << MacroNameTok.getIdentifierInfo();
1044 return;
1045 }
1046
1047 // Note that this macro has now been exported.
Douglas Gregoraa93a872011-10-17 15:32:29 +00001048 MI->setVisibility(/*IsPublic=*/true, MacroNameTok.getLocation());
1049
1050 // If this macro definition came from a PCH file, mark it
1051 // as having changed since serialization.
1052 if (MI->isFromAST())
1053 MI->setChangedAfterLoad();
1054}
1055
1056/// \brief Handle a #__private_macro__ directive.
1057void Preprocessor::HandleMacroPrivateDirective(Token &Tok) {
1058 Token MacroNameTok;
1059 ReadMacroName(MacroNameTok, 2);
1060
1061 // Error reading macro name? If so, diagnostic already issued.
1062 if (MacroNameTok.is(tok::eod))
1063 return;
1064
1065 // Check to see if this is the last token on the #__private_macro__ line.
1066 CheckEndOfDirective("__private_macro__");
1067
1068 // Okay, we finally have a valid identifier to undef.
1069 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
1070
1071 // If the macro is not defined, this is an error.
1072 if (MI == 0) {
1073 Diag(MacroNameTok, diag::err_pp_visibility_non_macro)
1074 << MacroNameTok.getIdentifierInfo();
1075 return;
1076 }
1077
1078 // Note that this macro has now been marked private.
1079 MI->setVisibility(/*IsPublic=*/false, MacroNameTok.getLocation());
Douglas Gregor7143aab2011-09-01 17:04:32 +00001080
1081 // If this macro definition came from a PCH file, mark it
1082 // as having changed since serialization.
1083 if (MI->isFromAST())
1084 MI->setChangedAfterLoad();
1085}
1086
Chris Lattner141e71f2008-03-09 01:54:53 +00001087//===----------------------------------------------------------------------===//
1088// Preprocessor Include Directive Handling.
1089//===----------------------------------------------------------------------===//
1090
1091/// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully
1092/// checked and spelled filename, e.g. as an operand of #include. This returns
1093/// true if the input filename was in <>'s or false if it were in ""'s. The
1094/// caller is expected to provide a buffer that is large enough to hold the
1095/// spelling of the filename, but is also expected to handle the case when
1096/// this method decides to use a different buffer.
1097bool Preprocessor::GetIncludeFilenameSpelling(SourceLocation Loc,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001098 StringRef &Buffer) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001099 // Get the text form of the filename.
Chris Lattnera1394812010-01-10 01:35:12 +00001100 assert(!Buffer.empty() && "Can't have tokens with empty spellings!");
Mike Stump1eb44332009-09-09 15:08:12 +00001101
Chris Lattner141e71f2008-03-09 01:54:53 +00001102 // Make sure the filename is <x> or "x".
1103 bool isAngled;
Chris Lattnera1394812010-01-10 01:35:12 +00001104 if (Buffer[0] == '<') {
1105 if (Buffer.back() != '>') {
Chris Lattner141e71f2008-03-09 01:54:53 +00001106 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001107 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001108 return true;
1109 }
1110 isAngled = true;
Chris Lattnera1394812010-01-10 01:35:12 +00001111 } else if (Buffer[0] == '"') {
1112 if (Buffer.back() != '"') {
Chris Lattner141e71f2008-03-09 01:54:53 +00001113 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001114 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001115 return true;
1116 }
1117 isAngled = false;
1118 } else {
1119 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001120 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001121 return true;
1122 }
Mike Stump1eb44332009-09-09 15:08:12 +00001123
Chris Lattner141e71f2008-03-09 01:54:53 +00001124 // Diagnose #include "" as invalid.
Chris Lattnera1394812010-01-10 01:35:12 +00001125 if (Buffer.size() <= 2) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001126 Diag(Loc, diag::err_pp_empty_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001127 Buffer = StringRef();
Chris Lattnera1394812010-01-10 01:35:12 +00001128 return true;
Chris Lattner141e71f2008-03-09 01:54:53 +00001129 }
Mike Stump1eb44332009-09-09 15:08:12 +00001130
Chris Lattner141e71f2008-03-09 01:54:53 +00001131 // Skip the brackets.
Chris Lattnera1394812010-01-10 01:35:12 +00001132 Buffer = Buffer.substr(1, Buffer.size()-2);
Chris Lattner141e71f2008-03-09 01:54:53 +00001133 return isAngled;
1134}
1135
1136/// ConcatenateIncludeName - Handle cases where the #include name is expanded
1137/// from a macro as multiple tokens, which need to be glued together. This
1138/// occurs for code like:
1139/// #define FOO <a/b.h>
1140/// #include FOO
1141/// because in this case, "<a/b.h>" is returned as 7 tokens, not one.
1142///
1143/// This code concatenates and consumes tokens up to the '>' token. It returns
1144/// false if the > was found, otherwise it returns true if it finds and consumes
Peter Collingbourne84021552011-02-28 02:37:51 +00001145/// the EOD marker.
John Thompsona28cc092009-10-30 13:49:06 +00001146bool Preprocessor::ConcatenateIncludeName(
Douglas Gregorecdcb882010-10-20 22:00:55 +00001147 llvm::SmallString<128> &FilenameBuffer,
1148 SourceLocation &End) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001149 Token CurTok;
Mike Stump1eb44332009-09-09 15:08:12 +00001150
John Thompsona28cc092009-10-30 13:49:06 +00001151 Lex(CurTok);
Peter Collingbourne84021552011-02-28 02:37:51 +00001152 while (CurTok.isNot(tok::eod)) {
Douglas Gregorecdcb882010-10-20 22:00:55 +00001153 End = CurTok.getLocation();
1154
Douglas Gregor25bb03b2010-12-09 23:35:36 +00001155 // FIXME: Provide code completion for #includes.
1156 if (CurTok.is(tok::code_completion)) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001157 setCodeCompletionReached();
Douglas Gregor25bb03b2010-12-09 23:35:36 +00001158 Lex(CurTok);
1159 continue;
1160 }
1161
Chris Lattner141e71f2008-03-09 01:54:53 +00001162 // Append the spelling of this token to the buffer. If there was a space
1163 // before it, add it now.
1164 if (CurTok.hasLeadingSpace())
1165 FilenameBuffer.push_back(' ');
Mike Stump1eb44332009-09-09 15:08:12 +00001166
Chris Lattner141e71f2008-03-09 01:54:53 +00001167 // Get the spelling of the token, directly into FilenameBuffer if possible.
1168 unsigned PreAppendSize = FilenameBuffer.size();
1169 FilenameBuffer.resize(PreAppendSize+CurTok.getLength());
Mike Stump1eb44332009-09-09 15:08:12 +00001170
Chris Lattner141e71f2008-03-09 01:54:53 +00001171 const char *BufPtr = &FilenameBuffer[PreAppendSize];
John Thompsona28cc092009-10-30 13:49:06 +00001172 unsigned ActualLen = getSpelling(CurTok, BufPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00001173
Chris Lattner141e71f2008-03-09 01:54:53 +00001174 // If the token was spelled somewhere else, copy it into FilenameBuffer.
1175 if (BufPtr != &FilenameBuffer[PreAppendSize])
1176 memcpy(&FilenameBuffer[PreAppendSize], BufPtr, ActualLen);
Mike Stump1eb44332009-09-09 15:08:12 +00001177
Chris Lattner141e71f2008-03-09 01:54:53 +00001178 // Resize FilenameBuffer to the correct size.
1179 if (CurTok.getLength() != ActualLen)
1180 FilenameBuffer.resize(PreAppendSize+ActualLen);
Mike Stump1eb44332009-09-09 15:08:12 +00001181
Chris Lattner141e71f2008-03-09 01:54:53 +00001182 // If we found the '>' marker, return success.
1183 if (CurTok.is(tok::greater))
1184 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001185
John Thompsona28cc092009-10-30 13:49:06 +00001186 Lex(CurTok);
Chris Lattner141e71f2008-03-09 01:54:53 +00001187 }
1188
Peter Collingbourne84021552011-02-28 02:37:51 +00001189 // If we hit the eod marker, emit an error and return true so that the caller
1190 // knows the EOD has been read.
John Thompsona28cc092009-10-30 13:49:06 +00001191 Diag(CurTok.getLocation(), diag::err_pp_expects_filename);
Chris Lattner141e71f2008-03-09 01:54:53 +00001192 return true;
1193}
1194
1195/// HandleIncludeDirective - The "#include" tokens have just been read, read the
1196/// file to be included from the lexer, then include it! This is a common
1197/// routine with functionality shared between #include, #include_next and
Chris Lattner72181832008-09-26 20:12:23 +00001198/// #import. LookupFrom is set when this is a #include_next directive, it
Mike Stump1eb44332009-09-09 15:08:12 +00001199/// specifies the file to start searching from.
Douglas Gregorecdcb882010-10-20 22:00:55 +00001200void Preprocessor::HandleIncludeDirective(SourceLocation HashLoc,
1201 Token &IncludeTok,
Chris Lattner141e71f2008-03-09 01:54:53 +00001202 const DirectoryLookup *LookupFrom,
1203 bool isImport) {
1204
1205 Token FilenameTok;
Ted Kremenek60e45d42008-11-18 00:34:22 +00001206 CurPPLexer->LexIncludeFilename(FilenameTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001207
Chris Lattner141e71f2008-03-09 01:54:53 +00001208 // Reserve a buffer to get the spelling.
Chris Lattnera1394812010-01-10 01:35:12 +00001209 llvm::SmallString<128> FilenameBuffer;
Chris Lattner5f9e2722011-07-23 10:55:15 +00001210 StringRef Filename;
Douglas Gregorecdcb882010-10-20 22:00:55 +00001211 SourceLocation End;
Douglas Gregore3a82562011-11-30 18:02:36 +00001212 SourceLocation CharEnd; // the end of this directive, in characters
Douglas Gregorecdcb882010-10-20 22:00:55 +00001213
Chris Lattner141e71f2008-03-09 01:54:53 +00001214 switch (FilenameTok.getKind()) {
Peter Collingbourne84021552011-02-28 02:37:51 +00001215 case tok::eod:
1216 // If the token kind is EOD, the error has already been diagnosed.
Chris Lattner141e71f2008-03-09 01:54:53 +00001217 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001218
Chris Lattner141e71f2008-03-09 01:54:53 +00001219 case tok::angle_string_literal:
Benjamin Kramerddeea562010-02-27 13:44:12 +00001220 case tok::string_literal:
1221 Filename = getSpelling(FilenameTok, FilenameBuffer);
Douglas Gregorecdcb882010-10-20 22:00:55 +00001222 End = FilenameTok.getLocation();
Douglas Gregore3a82562011-11-30 18:02:36 +00001223 CharEnd = End.getLocWithOffset(Filename.size());
Chris Lattner141e71f2008-03-09 01:54:53 +00001224 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001225
Chris Lattner141e71f2008-03-09 01:54:53 +00001226 case tok::less:
1227 // This could be a <foo/bar.h> file coming from a macro expansion. In this
1228 // case, glue the tokens together into FilenameBuffer and interpret those.
1229 FilenameBuffer.push_back('<');
Douglas Gregorecdcb882010-10-20 22:00:55 +00001230 if (ConcatenateIncludeName(FilenameBuffer, End))
Peter Collingbourne84021552011-02-28 02:37:51 +00001231 return; // Found <eod> but no ">"? Diagnostic already emitted.
Chris Lattnera1394812010-01-10 01:35:12 +00001232 Filename = FilenameBuffer.str();
Douglas Gregore3a82562011-11-30 18:02:36 +00001233 CharEnd = getLocForEndOfToken(End);
Chris Lattner141e71f2008-03-09 01:54:53 +00001234 break;
1235 default:
1236 Diag(FilenameTok.getLocation(), diag::err_pp_expects_filename);
1237 DiscardUntilEndOfDirective();
1238 return;
1239 }
Mike Stump1eb44332009-09-09 15:08:12 +00001240
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001241 bool isAngled =
Chris Lattnera1394812010-01-10 01:35:12 +00001242 GetIncludeFilenameSpelling(FilenameTok.getLocation(), Filename);
Chris Lattner141e71f2008-03-09 01:54:53 +00001243 // If GetIncludeFilenameSpelling set the start ptr to null, there was an
1244 // error.
Chris Lattnera1394812010-01-10 01:35:12 +00001245 if (Filename.empty()) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001246 DiscardUntilEndOfDirective();
1247 return;
1248 }
Mike Stump1eb44332009-09-09 15:08:12 +00001249
Peter Collingbourne84021552011-02-28 02:37:51 +00001250 // Verify that there is nothing after the filename, other than EOD. Note that
Chris Lattner9cb51ce2009-04-17 23:56:52 +00001251 // we allow macros that expand to nothing after the filename, because this
1252 // falls into the category of "#include pp-tokens new-line" specified in
1253 // C99 6.10.2p4.
Daniel Dunbare013d682009-10-18 20:26:12 +00001254 CheckEndOfDirective(IncludeTok.getIdentifierInfo()->getNameStart(), true);
Chris Lattner141e71f2008-03-09 01:54:53 +00001255
1256 // Check that we don't have infinite #include recursion.
Chris Lattner3692b092008-11-18 07:59:24 +00001257 if (IncludeMacroStack.size() == MaxAllowedIncludeStackDepth-1) {
1258 Diag(FilenameTok, diag::err_pp_include_too_deep);
1259 return;
1260 }
Mike Stump1eb44332009-09-09 15:08:12 +00001261
John McCall8dfac0b2011-09-30 05:12:12 +00001262 // Complain about attempts to #include files in an audit pragma.
1263 if (PragmaARCCFCodeAuditedLoc.isValid()) {
1264 Diag(HashLoc, diag::err_pp_include_in_arc_cf_code_audited);
1265 Diag(PragmaARCCFCodeAuditedLoc, diag::note_pragma_entered_here);
1266
1267 // Immediately leave the pragma.
1268 PragmaARCCFCodeAuditedLoc = SourceLocation();
1269 }
1270
Chris Lattner141e71f2008-03-09 01:54:53 +00001271 // Search include directories.
1272 const DirectoryLookup *CurDir;
Manuel Klimek74124942011-04-26 21:50:03 +00001273 llvm::SmallString<1024> SearchPath;
1274 llvm::SmallString<1024> RelativePath;
Chandler Carruthb5142bb2011-03-16 18:34:36 +00001275 // We get the raw path only if we have 'Callbacks' to which we later pass
1276 // the path.
Douglas Gregorc69c42e2011-11-17 22:44:56 +00001277 ModuleMap::Module *SuggestedModule = 0;
Chandler Carruthb5142bb2011-03-16 18:34:36 +00001278 const FileEntry *File = LookupFile(
Manuel Klimek74124942011-04-26 21:50:03 +00001279 Filename, isAngled, LookupFrom, CurDir,
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001280 Callbacks ? &SearchPath : NULL, Callbacks ? &RelativePath : NULL,
1281 AutoModuleImport? &SuggestedModule : 0);
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001282
Douglas Gregor8cfbe6a2011-11-30 18:12:06 +00001283 if (Callbacks) {
1284 if (!File) {
1285 // Give the clients a chance to recover.
1286 llvm::SmallString<128> RecoveryPath;
1287 if (Callbacks->FileNotFound(Filename, RecoveryPath)) {
1288 if (const DirectoryEntry *DE = FileMgr.getDirectory(RecoveryPath)) {
1289 // Add the recovery path to the list of search paths.
1290 DirectoryLookup DL(DE, SrcMgr::C_User, true, false);
1291 HeaderInfo.AddSearchPath(DL, isAngled);
1292
1293 // Try the lookup again, skipping the cache.
1294 File = LookupFile(Filename, isAngled, LookupFrom, CurDir, 0, 0,
1295 AutoModuleImport ? &SuggestedModule : 0,
1296 /*SkipCache*/true);
1297 }
1298 }
1299 }
1300
1301 // Notify the callback object that we've seen an inclusion directive.
1302 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled, File,
1303 End, SearchPath, RelativePath);
1304 }
1305
1306 if (File == 0) {
1307 if (!SuppressIncludeNotFoundError)
1308 Diag(FilenameTok, diag::err_pp_file_not_found) << Filename;
1309 return;
1310 }
1311
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001312 // If we are supposed to import a module rather than including the header,
1313 // do so now.
Douglas Gregorc69c42e2011-11-17 22:44:56 +00001314 if (SuggestedModule) {
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001315 // Compute the module access path corresponding to this module.
1316 // FIXME: Should we have a second loadModule() overload to avoid this
1317 // extra lookup step?
1318 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1319 for (ModuleMap::Module *Mod = SuggestedModule; Mod; Mod = Mod->Parent)
1320 Path.push_back(std::make_pair(getIdentifierInfo(Mod->Name),
1321 FilenameTok.getLocation()));
1322 std::reverse(Path.begin(), Path.end());
1323
Douglas Gregore3a82562011-11-30 18:02:36 +00001324 // Warn that we're replacing the include/import with a module import.
1325 llvm::SmallString<128> PathString;
1326 for (unsigned I = 0, N = Path.size(); I != N; ++I) {
1327 if (I)
1328 PathString += '.';
1329 PathString += Path[I].first->getName();
1330 }
1331 int IncludeKind = 0;
1332
1333 switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) {
1334 case tok::pp_include:
1335 IncludeKind = 0;
1336 break;
1337
1338 case tok::pp_import:
1339 IncludeKind = 1;
1340 break;
1341
Douglas Gregoredee9692011-11-30 18:03:26 +00001342 case tok::pp_include_next:
1343 IncludeKind = 2;
1344 break;
Douglas Gregore3a82562011-11-30 18:02:36 +00001345
1346 case tok::pp___include_macros:
1347 IncludeKind = 3;
1348 break;
1349
1350 default:
1351 llvm_unreachable("unknown include directive kind");
1352 break;
1353 }
1354
1355 CharSourceRange ReplaceRange(SourceRange(HashLoc, CharEnd),
1356 /*IsTokenRange=*/false);
1357 Diag(HashLoc, diag::warn_auto_module_import)
1358 << IncludeKind << PathString
1359 << FixItHint::CreateReplacement(ReplaceRange,
1360 "__import_module__ " + PathString.str().str() + ";");
1361
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001362 // Load the module.
Douglas Gregor4b7cac52011-11-30 19:39:08 +00001363 // FIXME: Deal with __include_macros here.
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001364 TheModuleLoader.loadModule(IncludeTok.getLocation(), Path);
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001365 return;
1366 }
1367
Chris Lattner72181832008-09-26 20:12:23 +00001368 // The #included file will be considered to be a system header if either it is
1369 // in a system include directory, or if the #includer is a system include
1370 // header.
Mike Stump1eb44332009-09-09 15:08:12 +00001371 SrcMgr::CharacteristicKind FileCharacter =
Chris Lattner0b9e7362008-09-26 21:18:42 +00001372 std::max(HeaderInfo.getFileDirFlavor(File),
Chris Lattner693faa62009-01-19 07:59:15 +00001373 SourceMgr.getFileCharacteristic(FilenameTok.getLocation()));
Mike Stump1eb44332009-09-09 15:08:12 +00001374
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001375 // Ask HeaderInfo if we should enter this #include file. If not, #including
1376 // this file will have no effect.
1377 if (!HeaderInfo.ShouldEnterIncludeFile(File, isImport)) {
Chris Lattnere127a0d2010-04-20 20:35:58 +00001378 if (Callbacks)
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001379 Callbacks->FileSkipped(*File, FilenameTok, FileCharacter);
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001380 return;
1381 }
1382
Chris Lattner141e71f2008-03-09 01:54:53 +00001383 // Look up the file, create a File ID for it.
Chris Lattner2b2453a2009-01-17 06:22:33 +00001384 FileID FID = SourceMgr.createFileID(File, FilenameTok.getLocation(),
1385 FileCharacter);
Peter Collingbourned57b7ff2011-06-30 16:41:03 +00001386 assert(!FID.isInvalid() && "Expected valid file ID");
Chris Lattner141e71f2008-03-09 01:54:53 +00001387
1388 // Finally, if all is good, enter the new file!
Chris Lattnere127a0d2010-04-20 20:35:58 +00001389 EnterSourceFile(FID, CurDir, FilenameTok.getLocation());
Chris Lattner141e71f2008-03-09 01:54:53 +00001390}
1391
1392/// HandleIncludeNextDirective - Implements #include_next.
1393///
Douglas Gregorecdcb882010-10-20 22:00:55 +00001394void Preprocessor::HandleIncludeNextDirective(SourceLocation HashLoc,
1395 Token &IncludeNextTok) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001396 Diag(IncludeNextTok, diag::ext_pp_include_next_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001397
Chris Lattner141e71f2008-03-09 01:54:53 +00001398 // #include_next is like #include, except that we start searching after
1399 // the current found directory. If we can't do this, issue a
1400 // diagnostic.
1401 const DirectoryLookup *Lookup = CurDirLookup;
1402 if (isInPrimaryFile()) {
1403 Lookup = 0;
1404 Diag(IncludeNextTok, diag::pp_include_next_in_primary);
1405 } else if (Lookup == 0) {
1406 Diag(IncludeNextTok, diag::pp_include_next_absolute_path);
1407 } else {
1408 // Start looking up in the next directory.
1409 ++Lookup;
1410 }
Mike Stump1eb44332009-09-09 15:08:12 +00001411
Douglas Gregorecdcb882010-10-20 22:00:55 +00001412 return HandleIncludeDirective(HashLoc, IncludeNextTok, Lookup);
Chris Lattner141e71f2008-03-09 01:54:53 +00001413}
1414
1415/// HandleImportDirective - Implements #import.
1416///
Douglas Gregorecdcb882010-10-20 22:00:55 +00001417void Preprocessor::HandleImportDirective(SourceLocation HashLoc,
1418 Token &ImportTok) {
Chris Lattnerb627c8d2009-03-06 04:28:03 +00001419 if (!Features.ObjC1) // #import is standard for ObjC.
1420 Diag(ImportTok, diag::ext_pp_import_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001421
Douglas Gregorecdcb882010-10-20 22:00:55 +00001422 return HandleIncludeDirective(HashLoc, ImportTok, 0, true);
Chris Lattner141e71f2008-03-09 01:54:53 +00001423}
1424
Chris Lattnerde076652009-04-08 18:46:40 +00001425/// HandleIncludeMacrosDirective - The -imacros command line option turns into a
1426/// pseudo directive in the predefines buffer. This handles it by sucking all
1427/// tokens through the preprocessor and discarding them (only keeping the side
1428/// effects on the preprocessor).
Douglas Gregorecdcb882010-10-20 22:00:55 +00001429void Preprocessor::HandleIncludeMacrosDirective(SourceLocation HashLoc,
1430 Token &IncludeMacrosTok) {
Chris Lattnerde076652009-04-08 18:46:40 +00001431 // This directive should only occur in the predefines buffer. If not, emit an
1432 // error and reject it.
1433 SourceLocation Loc = IncludeMacrosTok.getLocation();
1434 if (strcmp(SourceMgr.getBufferName(Loc), "<built-in>") != 0) {
1435 Diag(IncludeMacrosTok.getLocation(),
1436 diag::pp_include_macros_out_of_predefines);
1437 DiscardUntilEndOfDirective();
1438 return;
1439 }
Mike Stump1eb44332009-09-09 15:08:12 +00001440
Chris Lattnerfd105112009-04-08 20:53:24 +00001441 // Treat this as a normal #include for checking purposes. If this is
1442 // successful, it will push a new lexer onto the include stack.
Douglas Gregorecdcb882010-10-20 22:00:55 +00001443 HandleIncludeDirective(HashLoc, IncludeMacrosTok, 0, false);
Mike Stump1eb44332009-09-09 15:08:12 +00001444
Chris Lattnerfd105112009-04-08 20:53:24 +00001445 Token TmpTok;
1446 do {
1447 Lex(TmpTok);
1448 assert(TmpTok.isNot(tok::eof) && "Didn't find end of -imacros!");
1449 } while (TmpTok.isNot(tok::hashhash));
Chris Lattnerde076652009-04-08 18:46:40 +00001450}
1451
Chris Lattner141e71f2008-03-09 01:54:53 +00001452//===----------------------------------------------------------------------===//
1453// Preprocessor Macro Directive Handling.
1454//===----------------------------------------------------------------------===//
1455
1456/// ReadMacroDefinitionArgList - The ( starting an argument list of a macro
1457/// definition has just been read. Lex the rest of the arguments and the
1458/// closing ), updating MI with what we learn. Return true if an error occurs
1459/// parsing the arg list.
1460bool Preprocessor::ReadMacroDefinitionArgList(MacroInfo *MI) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001461 SmallVector<IdentifierInfo*, 32> Arguments;
Mike Stump1eb44332009-09-09 15:08:12 +00001462
Chris Lattner141e71f2008-03-09 01:54:53 +00001463 Token Tok;
1464 while (1) {
1465 LexUnexpandedToken(Tok);
1466 switch (Tok.getKind()) {
1467 case tok::r_paren:
1468 // Found the end of the argument list.
Chris Lattnercf29e072009-02-20 22:31:31 +00001469 if (Arguments.empty()) // #define FOO()
Chris Lattner141e71f2008-03-09 01:54:53 +00001470 return false;
Chris Lattner141e71f2008-03-09 01:54:53 +00001471 // Otherwise we have #define FOO(A,)
1472 Diag(Tok, diag::err_pp_expected_ident_in_arg_list);
1473 return true;
1474 case tok::ellipsis: // #define X(... -> C99 varargs
Richard Smith661a9962011-10-15 01:18:56 +00001475 if (!Features.C99)
1476 Diag(Tok, Features.CPlusPlus0x ?
1477 diag::warn_cxx98_compat_variadic_macro :
1478 diag::ext_variadic_macro);
Chris Lattner141e71f2008-03-09 01:54:53 +00001479
1480 // Lex the token after the identifier.
1481 LexUnexpandedToken(Tok);
1482 if (Tok.isNot(tok::r_paren)) {
1483 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1484 return true;
1485 }
1486 // Add the __VA_ARGS__ identifier as an argument.
1487 Arguments.push_back(Ident__VA_ARGS__);
1488 MI->setIsC99Varargs();
Chris Lattner685befe2009-02-20 22:46:43 +00001489 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001490 return false;
Peter Collingbourne84021552011-02-28 02:37:51 +00001491 case tok::eod: // #define X(
Chris Lattner141e71f2008-03-09 01:54:53 +00001492 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1493 return true;
1494 default:
1495 // Handle keywords and identifiers here to accept things like
1496 // #define Foo(for) for.
1497 IdentifierInfo *II = Tok.getIdentifierInfo();
1498 if (II == 0) {
1499 // #define X(1
1500 Diag(Tok, diag::err_pp_invalid_tok_in_arg_list);
1501 return true;
1502 }
1503
1504 // If this is already used as an argument, it is used multiple times (e.g.
1505 // #define X(A,A.
Mike Stump1eb44332009-09-09 15:08:12 +00001506 if (std::find(Arguments.begin(), Arguments.end(), II) !=
Chris Lattner141e71f2008-03-09 01:54:53 +00001507 Arguments.end()) { // C99 6.10.3p6
Chris Lattner6cf3ed72008-11-19 07:33:58 +00001508 Diag(Tok, diag::err_pp_duplicate_name_in_arg_list) << II;
Chris Lattner141e71f2008-03-09 01:54:53 +00001509 return true;
1510 }
Mike Stump1eb44332009-09-09 15:08:12 +00001511
Chris Lattner141e71f2008-03-09 01:54:53 +00001512 // Add the argument to the macro info.
1513 Arguments.push_back(II);
Mike Stump1eb44332009-09-09 15:08:12 +00001514
Chris Lattner141e71f2008-03-09 01:54:53 +00001515 // Lex the token after the identifier.
1516 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001517
Chris Lattner141e71f2008-03-09 01:54:53 +00001518 switch (Tok.getKind()) {
1519 default: // #define X(A B
1520 Diag(Tok, diag::err_pp_expected_comma_in_arg_list);
1521 return true;
1522 case tok::r_paren: // #define X(A)
Chris Lattner685befe2009-02-20 22:46:43 +00001523 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001524 return false;
1525 case tok::comma: // #define X(A,
1526 break;
1527 case tok::ellipsis: // #define X(A... -> GCC extension
1528 // Diagnose extension.
1529 Diag(Tok, diag::ext_named_variadic_macro);
Mike Stump1eb44332009-09-09 15:08:12 +00001530
Chris Lattner141e71f2008-03-09 01:54:53 +00001531 // Lex the token after the identifier.
1532 LexUnexpandedToken(Tok);
1533 if (Tok.isNot(tok::r_paren)) {
1534 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1535 return true;
1536 }
Mike Stump1eb44332009-09-09 15:08:12 +00001537
Chris Lattner141e71f2008-03-09 01:54:53 +00001538 MI->setIsGNUVarargs();
Chris Lattner685befe2009-02-20 22:46:43 +00001539 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001540 return false;
1541 }
1542 }
1543 }
1544}
1545
1546/// HandleDefineDirective - Implements #define. This consumes the entire macro
1547/// line then lets the caller lex the next real token.
1548void Preprocessor::HandleDefineDirective(Token &DefineTok) {
1549 ++NumDefined;
1550
1551 Token MacroNameTok;
1552 ReadMacroName(MacroNameTok, 1);
Mike Stump1eb44332009-09-09 15:08:12 +00001553
Chris Lattner141e71f2008-03-09 01:54:53 +00001554 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001555 if (MacroNameTok.is(tok::eod))
Chris Lattner141e71f2008-03-09 01:54:53 +00001556 return;
1557
Chris Lattner2451b522009-04-21 04:46:33 +00001558 Token LastTok = MacroNameTok;
1559
Chris Lattner141e71f2008-03-09 01:54:53 +00001560 // If we are supposed to keep comments in #defines, reenable comment saving
1561 // mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +00001562 if (CurLexer) CurLexer->SetCommentRetentionState(KeepMacroComments);
Mike Stump1eb44332009-09-09 15:08:12 +00001563
Chris Lattner141e71f2008-03-09 01:54:53 +00001564 // Create the new macro.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001565 MacroInfo *MI = AllocateMacroInfo(MacroNameTok.getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001566
Chris Lattner141e71f2008-03-09 01:54:53 +00001567 Token Tok;
1568 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001569
Chris Lattner141e71f2008-03-09 01:54:53 +00001570 // If this is a function-like macro definition, parse the argument list,
1571 // marking each of the identifiers as being used as macro arguments. Also,
1572 // check other constraints on the first token of the macro body.
Peter Collingbourne84021552011-02-28 02:37:51 +00001573 if (Tok.is(tok::eod)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001574 // If there is no body to this macro, we have no special handling here.
Chris Lattner6272bcf2009-04-18 02:23:25 +00001575 } else if (Tok.hasLeadingSpace()) {
1576 // This is a normal token with leading space. Clear the leading space
1577 // marker on the first token to get proper expansion.
1578 Tok.clearFlag(Token::LeadingSpace);
1579 } else if (Tok.is(tok::l_paren)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001580 // This is a function-like macro definition. Read the argument list.
1581 MI->setIsFunctionLike();
1582 if (ReadMacroDefinitionArgList(MI)) {
1583 // Forget about MI.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001584 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001585 // Throw away the rest of the line.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001586 if (CurPPLexer->ParsingPreprocessorDirective)
Chris Lattner141e71f2008-03-09 01:54:53 +00001587 DiscardUntilEndOfDirective();
1588 return;
1589 }
1590
Chris Lattner8fde5972009-04-19 18:26:34 +00001591 // If this is a definition of a variadic C99 function-like macro, not using
1592 // the GNU named varargs extension, enabled __VA_ARGS__.
Mike Stump1eb44332009-09-09 15:08:12 +00001593
Chris Lattner8fde5972009-04-19 18:26:34 +00001594 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
1595 // This gets unpoisoned where it is allowed.
1596 assert(Ident__VA_ARGS__->isPoisoned() && "__VA_ARGS__ should be poisoned!");
1597 if (MI->isC99Varargs())
1598 Ident__VA_ARGS__->setIsPoisoned(false);
Mike Stump1eb44332009-09-09 15:08:12 +00001599
Chris Lattner141e71f2008-03-09 01:54:53 +00001600 // Read the first token after the arg list for down below.
1601 LexUnexpandedToken(Tok);
Eli Friedman158ebfb2011-10-10 23:35:28 +00001602 } else if (Features.C99 || Features.CPlusPlus0x) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001603 // C99 requires whitespace between the macro definition and the body. Emit
1604 // a diagnostic for something like "#define X+".
Chris Lattner6272bcf2009-04-18 02:23:25 +00001605 Diag(Tok, diag::ext_c99_whitespace_required_after_macro_name);
Chris Lattner141e71f2008-03-09 01:54:53 +00001606 } else {
Chris Lattner6272bcf2009-04-18 02:23:25 +00001607 // C90 6.8 TC1 says: "In the definition of an object-like macro, if the
1608 // first character of a replacement list is not a character required by
1609 // subclause 5.2.1, then there shall be white-space separation between the
1610 // identifier and the replacement list.". 5.2.1 lists this set:
1611 // "A-Za-z0-9!"#%&'()*+,_./:;<=>?[\]^_{|}~" as well as whitespace, which
1612 // is irrelevant here.
1613 bool isInvalid = false;
1614 if (Tok.is(tok::at)) // @ is not in the list above.
1615 isInvalid = true;
1616 else if (Tok.is(tok::unknown)) {
1617 // If we have an unknown token, it is something strange like "`". Since
1618 // all of valid characters would have lexed into a single character
1619 // token of some sort, we know this is not a valid case.
1620 isInvalid = true;
1621 }
1622 if (isInvalid)
1623 Diag(Tok, diag::ext_missing_whitespace_after_macro_name);
1624 else
1625 Diag(Tok, diag::warn_missing_whitespace_after_macro_name);
Chris Lattner141e71f2008-03-09 01:54:53 +00001626 }
Chris Lattner2451b522009-04-21 04:46:33 +00001627
Peter Collingbourne84021552011-02-28 02:37:51 +00001628 if (!Tok.is(tok::eod))
Chris Lattner2451b522009-04-21 04:46:33 +00001629 LastTok = Tok;
1630
Chris Lattner141e71f2008-03-09 01:54:53 +00001631 // Read the rest of the macro body.
1632 if (MI->isObjectLike()) {
1633 // Object-like macros are very simple, just read their body.
Peter Collingbourne84021552011-02-28 02:37:51 +00001634 while (Tok.isNot(tok::eod)) {
Chris Lattner2451b522009-04-21 04:46:33 +00001635 LastTok = Tok;
Chris Lattner141e71f2008-03-09 01:54:53 +00001636 MI->AddTokenToBody(Tok);
1637 // Get the next token of the macro.
1638 LexUnexpandedToken(Tok);
1639 }
Mike Stump1eb44332009-09-09 15:08:12 +00001640
Chris Lattner141e71f2008-03-09 01:54:53 +00001641 } else {
Chris Lattner32404692009-05-25 17:16:10 +00001642 // Otherwise, read the body of a function-like macro. While we are at it,
1643 // check C99 6.10.3.2p1: ensure that # operators are followed by macro
1644 // parameters in function-like macro expansions.
Peter Collingbourne84021552011-02-28 02:37:51 +00001645 while (Tok.isNot(tok::eod)) {
Chris Lattner2451b522009-04-21 04:46:33 +00001646 LastTok = Tok;
Chris Lattner141e71f2008-03-09 01:54:53 +00001647
Chris Lattner141e71f2008-03-09 01:54:53 +00001648 if (Tok.isNot(tok::hash)) {
Chris Lattner32404692009-05-25 17:16:10 +00001649 MI->AddTokenToBody(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001650
Chris Lattner141e71f2008-03-09 01:54:53 +00001651 // Get the next token of the macro.
1652 LexUnexpandedToken(Tok);
1653 continue;
1654 }
Mike Stump1eb44332009-09-09 15:08:12 +00001655
Chris Lattner141e71f2008-03-09 01:54:53 +00001656 // Get the next token of the macro.
1657 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001658
Chris Lattner32404692009-05-25 17:16:10 +00001659 // Check for a valid macro arg identifier.
1660 if (Tok.getIdentifierInfo() == 0 ||
1661 MI->getArgumentNum(Tok.getIdentifierInfo()) == -1) {
1662
1663 // If this is assembler-with-cpp mode, we accept random gibberish after
1664 // the '#' because '#' is often a comment character. However, change
1665 // the kind of the token to tok::unknown so that the preprocessor isn't
1666 // confused.
Peter Collingbourne84021552011-02-28 02:37:51 +00001667 if (getLangOptions().AsmPreprocessor && Tok.isNot(tok::eod)) {
Chris Lattner32404692009-05-25 17:16:10 +00001668 LastTok.setKind(tok::unknown);
1669 } else {
1670 Diag(Tok, diag::err_pp_stringize_not_parameter);
1671 ReleaseMacroInfo(MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001672
Chris Lattner32404692009-05-25 17:16:10 +00001673 // Disable __VA_ARGS__ again.
1674 Ident__VA_ARGS__->setIsPoisoned(true);
1675 return;
1676 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001677 }
Mike Stump1eb44332009-09-09 15:08:12 +00001678
Chris Lattner32404692009-05-25 17:16:10 +00001679 // Things look ok, add the '#' and param name tokens to the macro.
1680 MI->AddTokenToBody(LastTok);
Chris Lattner141e71f2008-03-09 01:54:53 +00001681 MI->AddTokenToBody(Tok);
Chris Lattner32404692009-05-25 17:16:10 +00001682 LastTok = Tok;
Mike Stump1eb44332009-09-09 15:08:12 +00001683
Chris Lattner141e71f2008-03-09 01:54:53 +00001684 // Get the next token of the macro.
1685 LexUnexpandedToken(Tok);
1686 }
1687 }
Mike Stump1eb44332009-09-09 15:08:12 +00001688
1689
Chris Lattner141e71f2008-03-09 01:54:53 +00001690 // Disable __VA_ARGS__ again.
1691 Ident__VA_ARGS__->setIsPoisoned(true);
1692
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00001693 // Check that there is no paste (##) operator at the beginning or end of the
Chris Lattner141e71f2008-03-09 01:54:53 +00001694 // replacement list.
1695 unsigned NumTokens = MI->getNumTokens();
1696 if (NumTokens != 0) {
1697 if (MI->getReplacementToken(0).is(tok::hashhash)) {
1698 Diag(MI->getReplacementToken(0), diag::err_paste_at_start);
Ted Kremenek0ea76722008-12-15 19:56:42 +00001699 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001700 return;
1701 }
1702 if (MI->getReplacementToken(NumTokens-1).is(tok::hashhash)) {
1703 Diag(MI->getReplacementToken(NumTokens-1), diag::err_paste_at_end);
Ted Kremenek0ea76722008-12-15 19:56:42 +00001704 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001705 return;
1706 }
1707 }
Mike Stump1eb44332009-09-09 15:08:12 +00001708
Chris Lattner2451b522009-04-21 04:46:33 +00001709 MI->setDefinitionEndLoc(LastTok.getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001710
Chris Lattner141e71f2008-03-09 01:54:53 +00001711 // Finally, if this identifier already had a macro defined for it, verify that
1712 // the macro bodies are identical and free the old definition.
1713 if (MacroInfo *OtherMI = getMacroInfo(MacroNameTok.getIdentifierInfo())) {
Chris Lattner41c3ae12009-01-16 19:50:11 +00001714 // It is very common for system headers to have tons of macro redefinitions
1715 // and for warnings to be disabled in system headers. If this is the case,
1716 // then don't bother calling MacroInfo::isIdenticalTo.
Chris Lattner7f549df2009-03-13 21:17:23 +00001717 if (!getDiagnostics().getSuppressSystemWarnings() ||
Chris Lattner41c3ae12009-01-16 19:50:11 +00001718 !SourceMgr.isInSystemHeader(DefineTok.getLocation())) {
Argyrios Kyrtzidisa33e0502011-01-18 19:50:15 +00001719 if (!OtherMI->isUsed() && OtherMI->isWarnIfUnused())
Chris Lattner41c3ae12009-01-16 19:50:11 +00001720 Diag(OtherMI->getDefinitionLoc(), diag::pp_macro_not_used);
Chris Lattner141e71f2008-03-09 01:54:53 +00001721
Chris Lattnerf47724b2010-08-17 15:55:45 +00001722 // Macros must be identical. This means all tokens and whitespace
Chris Lattner41c3ae12009-01-16 19:50:11 +00001723 // separation must be the same. C99 6.10.3.2.
Chris Lattnerf47724b2010-08-17 15:55:45 +00001724 if (!OtherMI->isAllowRedefinitionsWithoutWarning() &&
Eli Friedmana7e68452010-08-22 01:00:03 +00001725 !MI->isIdenticalTo(*OtherMI, *this)) {
Chris Lattner41c3ae12009-01-16 19:50:11 +00001726 Diag(MI->getDefinitionLoc(), diag::ext_pp_macro_redef)
1727 << MacroNameTok.getIdentifierInfo();
1728 Diag(OtherMI->getDefinitionLoc(), diag::note_previous_definition);
1729 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001730 }
Argyrios Kyrtzidisa33e0502011-01-18 19:50:15 +00001731 if (OtherMI->isWarnIfUnused())
1732 WarnUnusedMacroLocs.erase(OtherMI->getDefinitionLoc());
Ted Kremenek0ea76722008-12-15 19:56:42 +00001733 ReleaseMacroInfo(OtherMI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001734 }
Mike Stump1eb44332009-09-09 15:08:12 +00001735
Chris Lattner141e71f2008-03-09 01:54:53 +00001736 setMacroInfo(MacroNameTok.getIdentifierInfo(), MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001737
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001738 assert(!MI->isUsed());
1739 // If we need warning for not using the macro, add its location in the
1740 // warn-because-unused-macro set. If it gets used it will be removed from set.
1741 if (isInPrimaryFile() && // don't warn for include'd macros.
1742 Diags->getDiagnosticLevel(diag::pp_macro_not_used,
David Blaikied6471f72011-09-25 23:23:43 +00001743 MI->getDefinitionLoc()) != DiagnosticsEngine::Ignored) {
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001744 MI->setIsWarnIfUnused(true);
1745 WarnUnusedMacroLocs.insert(MI->getDefinitionLoc());
1746 }
1747
Chris Lattnerf4a72b02009-04-12 01:39:54 +00001748 // If the callbacks want to know, tell them about the macro definition.
1749 if (Callbacks)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001750 Callbacks->MacroDefined(MacroNameTok, MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001751}
1752
1753/// HandleUndefDirective - Implements #undef.
1754///
1755void Preprocessor::HandleUndefDirective(Token &UndefTok) {
1756 ++NumUndefined;
1757
1758 Token MacroNameTok;
1759 ReadMacroName(MacroNameTok, 2);
Mike Stump1eb44332009-09-09 15:08:12 +00001760
Chris Lattner141e71f2008-03-09 01:54:53 +00001761 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001762 if (MacroNameTok.is(tok::eod))
Chris Lattner141e71f2008-03-09 01:54:53 +00001763 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001764
Chris Lattner141e71f2008-03-09 01:54:53 +00001765 // Check to see if this is the last token on the #undef line.
Chris Lattner35410d52009-04-14 05:07:49 +00001766 CheckEndOfDirective("undef");
Mike Stump1eb44332009-09-09 15:08:12 +00001767
Chris Lattner141e71f2008-03-09 01:54:53 +00001768 // Okay, we finally have a valid identifier to undef.
1769 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
Mike Stump1eb44332009-09-09 15:08:12 +00001770
Chris Lattner141e71f2008-03-09 01:54:53 +00001771 // If the macro is not defined, this is a noop undef, just return.
1772 if (MI == 0) return;
1773
Argyrios Kyrtzidis1f8dcfc2011-07-11 20:39:47 +00001774 if (!MI->isUsed() && MI->isWarnIfUnused())
Chris Lattner141e71f2008-03-09 01:54:53 +00001775 Diag(MI->getDefinitionLoc(), diag::pp_macro_not_used);
Chris Lattner41c17472009-04-21 03:42:09 +00001776
1777 // If the callbacks want to know, tell them about the macro #undef.
1778 if (Callbacks)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001779 Callbacks->MacroUndefined(MacroNameTok, MI);
Chris Lattner41c17472009-04-21 03:42:09 +00001780
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001781 if (MI->isWarnIfUnused())
1782 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc());
1783
Chris Lattner141e71f2008-03-09 01:54:53 +00001784 // Free macro definition.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001785 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001786 setMacroInfo(MacroNameTok.getIdentifierInfo(), 0);
1787}
1788
1789
1790//===----------------------------------------------------------------------===//
1791// Preprocessor Conditional Directive Handling.
1792//===----------------------------------------------------------------------===//
1793
1794/// HandleIfdefDirective - Implements the #ifdef/#ifndef directive. isIfndef is
1795/// true when this is a #ifndef directive. ReadAnyTokensBeforeDirective is true
1796/// if any tokens have been returned or pp-directives activated before this
1797/// #ifndef has been lexed.
1798///
1799void Preprocessor::HandleIfdefDirective(Token &Result, bool isIfndef,
1800 bool ReadAnyTokensBeforeDirective) {
1801 ++NumIf;
1802 Token DirectiveTok = Result;
1803
1804 Token MacroNameTok;
1805 ReadMacroName(MacroNameTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001806
Chris Lattner141e71f2008-03-09 01:54:53 +00001807 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001808 if (MacroNameTok.is(tok::eod)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001809 // Skip code until we get to #endif. This helps with recovery by not
1810 // emitting an error when the #endif is reached.
1811 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
1812 /*Foundnonskip*/false, /*FoundElse*/false);
1813 return;
1814 }
Mike Stump1eb44332009-09-09 15:08:12 +00001815
Chris Lattner141e71f2008-03-09 01:54:53 +00001816 // Check to see if this is the last token on the #if[n]def line.
Chris Lattner35410d52009-04-14 05:07:49 +00001817 CheckEndOfDirective(isIfndef ? "ifndef" : "ifdef");
Chris Lattner141e71f2008-03-09 01:54:53 +00001818
Chris Lattner13d283d2010-02-12 08:03:27 +00001819 IdentifierInfo *MII = MacroNameTok.getIdentifierInfo();
1820 MacroInfo *MI = getMacroInfo(MII);
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001821
Ted Kremenek60e45d42008-11-18 00:34:22 +00001822 if (CurPPLexer->getConditionalStackDepth() == 0) {
Chris Lattner13d283d2010-02-12 08:03:27 +00001823 // If the start of a top-level #ifdef and if the macro is not defined,
1824 // inform MIOpt that this might be the start of a proper include guard.
1825 // Otherwise it is some other form of unknown conditional which we can't
1826 // handle.
1827 if (!ReadAnyTokensBeforeDirective && MI == 0) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001828 assert(isIfndef && "#ifdef shouldn't reach here");
Chris Lattner13d283d2010-02-12 08:03:27 +00001829 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(MII);
Chris Lattner141e71f2008-03-09 01:54:53 +00001830 } else
Ted Kremenek60e45d42008-11-18 00:34:22 +00001831 CurPPLexer->MIOpt.EnterTopLevelConditional();
Chris Lattner141e71f2008-03-09 01:54:53 +00001832 }
1833
Chris Lattner141e71f2008-03-09 01:54:53 +00001834 // If there is a macro, process it.
1835 if (MI) // Mark it used.
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001836 markMacroAsUsed(MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001837
Chris Lattner141e71f2008-03-09 01:54:53 +00001838 // Should we include the stuff contained by this directive?
1839 if (!MI == isIfndef) {
1840 // Yes, remember that we are inside a conditional, then lex the next token.
Chris Lattner1d9c54d2009-12-14 04:54:40 +00001841 CurPPLexer->pushConditionalLevel(DirectiveTok.getLocation(),
1842 /*wasskip*/false, /*foundnonskip*/true,
1843 /*foundelse*/false);
Chris Lattner141e71f2008-03-09 01:54:53 +00001844 } else {
Craig Silverstein08985b92010-11-06 01:19:03 +00001845 // No, skip the contents of this block.
Chris Lattner141e71f2008-03-09 01:54:53 +00001846 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
Mike Stump1eb44332009-09-09 15:08:12 +00001847 /*Foundnonskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001848 /*FoundElse*/false);
1849 }
Craig Silverstein08985b92010-11-06 01:19:03 +00001850
1851 if (Callbacks) {
1852 if (isIfndef)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001853 Callbacks->Ifndef(MacroNameTok);
Craig Silverstein08985b92010-11-06 01:19:03 +00001854 else
Craig Silverstein2aa92672010-11-19 21:33:15 +00001855 Callbacks->Ifdef(MacroNameTok);
Craig Silverstein08985b92010-11-06 01:19:03 +00001856 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001857}
1858
1859/// HandleIfDirective - Implements the #if directive.
1860///
1861void Preprocessor::HandleIfDirective(Token &IfToken,
1862 bool ReadAnyTokensBeforeDirective) {
1863 ++NumIf;
Mike Stump1eb44332009-09-09 15:08:12 +00001864
Craig Silverstein08985b92010-11-06 01:19:03 +00001865 // Parse and evaluate the conditional expression.
Chris Lattner141e71f2008-03-09 01:54:53 +00001866 IdentifierInfo *IfNDefMacro = 0;
Craig Silverstein08985b92010-11-06 01:19:03 +00001867 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
1868 const bool ConditionalTrue = EvaluateDirectiveExpression(IfNDefMacro);
1869 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
Nuno Lopes0049db62008-06-01 18:31:24 +00001870
1871 // If this condition is equivalent to #ifndef X, and if this is the first
1872 // directive seen, handle it for the multiple-include optimization.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001873 if (CurPPLexer->getConditionalStackDepth() == 0) {
Chris Lattner13d283d2010-02-12 08:03:27 +00001874 if (!ReadAnyTokensBeforeDirective && IfNDefMacro && ConditionalTrue)
Ted Kremenek60e45d42008-11-18 00:34:22 +00001875 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(IfNDefMacro);
Nuno Lopes0049db62008-06-01 18:31:24 +00001876 else
Ted Kremenek60e45d42008-11-18 00:34:22 +00001877 CurPPLexer->MIOpt.EnterTopLevelConditional();
Nuno Lopes0049db62008-06-01 18:31:24 +00001878 }
1879
Chris Lattner141e71f2008-03-09 01:54:53 +00001880 // Should we include the stuff contained by this directive?
1881 if (ConditionalTrue) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001882 // Yes, remember that we are inside a conditional, then lex the next token.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001883 CurPPLexer->pushConditionalLevel(IfToken.getLocation(), /*wasskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001884 /*foundnonskip*/true, /*foundelse*/false);
1885 } else {
Craig Silverstein08985b92010-11-06 01:19:03 +00001886 // No, skip the contents of this block.
Mike Stump1eb44332009-09-09 15:08:12 +00001887 SkipExcludedConditionalBlock(IfToken.getLocation(), /*Foundnonskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001888 /*FoundElse*/false);
1889 }
Craig Silverstein08985b92010-11-06 01:19:03 +00001890
1891 if (Callbacks)
1892 Callbacks->If(SourceRange(ConditionalBegin, ConditionalEnd));
Chris Lattner141e71f2008-03-09 01:54:53 +00001893}
1894
1895/// HandleEndifDirective - Implements the #endif directive.
1896///
1897void Preprocessor::HandleEndifDirective(Token &EndifToken) {
1898 ++NumEndif;
Mike Stump1eb44332009-09-09 15:08:12 +00001899
Chris Lattner141e71f2008-03-09 01:54:53 +00001900 // Check that this is the whole directive.
Chris Lattner35410d52009-04-14 05:07:49 +00001901 CheckEndOfDirective("endif");
Mike Stump1eb44332009-09-09 15:08:12 +00001902
Chris Lattner141e71f2008-03-09 01:54:53 +00001903 PPConditionalInfo CondInfo;
Ted Kremenek60e45d42008-11-18 00:34:22 +00001904 if (CurPPLexer->popConditionalLevel(CondInfo)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001905 // No conditionals on the stack: this is an #endif without an #if.
Chris Lattner3692b092008-11-18 07:59:24 +00001906 Diag(EndifToken, diag::err_pp_endif_without_if);
1907 return;
Chris Lattner141e71f2008-03-09 01:54:53 +00001908 }
Mike Stump1eb44332009-09-09 15:08:12 +00001909
Chris Lattner141e71f2008-03-09 01:54:53 +00001910 // If this the end of a top-level #endif, inform MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001911 if (CurPPLexer->getConditionalStackDepth() == 0)
1912 CurPPLexer->MIOpt.ExitTopLevelConditional();
Mike Stump1eb44332009-09-09 15:08:12 +00001913
Ted Kremenek60e45d42008-11-18 00:34:22 +00001914 assert(!CondInfo.WasSkipping && !CurPPLexer->LexingRawMode &&
Chris Lattner141e71f2008-03-09 01:54:53 +00001915 "This code should only be reachable in the non-skipping case!");
Craig Silverstein08985b92010-11-06 01:19:03 +00001916
1917 if (Callbacks)
1918 Callbacks->Endif();
Chris Lattner141e71f2008-03-09 01:54:53 +00001919}
1920
Craig Silverstein08985b92010-11-06 01:19:03 +00001921/// HandleElseDirective - Implements the #else directive.
1922///
Chris Lattner141e71f2008-03-09 01:54:53 +00001923void Preprocessor::HandleElseDirective(Token &Result) {
1924 ++NumElse;
Mike Stump1eb44332009-09-09 15:08:12 +00001925
Chris Lattner141e71f2008-03-09 01:54:53 +00001926 // #else directive in a non-skipping conditional... start skipping.
Chris Lattner35410d52009-04-14 05:07:49 +00001927 CheckEndOfDirective("else");
Mike Stump1eb44332009-09-09 15:08:12 +00001928
Chris Lattner141e71f2008-03-09 01:54:53 +00001929 PPConditionalInfo CI;
Chris Lattner3692b092008-11-18 07:59:24 +00001930 if (CurPPLexer->popConditionalLevel(CI)) {
1931 Diag(Result, diag::pp_err_else_without_if);
1932 return;
1933 }
Mike Stump1eb44332009-09-09 15:08:12 +00001934
Chris Lattner141e71f2008-03-09 01:54:53 +00001935 // If this is a top-level #else, inform the MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001936 if (CurPPLexer->getConditionalStackDepth() == 0)
1937 CurPPLexer->MIOpt.EnterTopLevelConditional();
Chris Lattner141e71f2008-03-09 01:54:53 +00001938
1939 // If this is a #else with a #else before it, report the error.
1940 if (CI.FoundElse) Diag(Result, diag::pp_err_else_after_else);
Mike Stump1eb44332009-09-09 15:08:12 +00001941
Craig Silverstein08985b92010-11-06 01:19:03 +00001942 // Finally, skip the rest of the contents of this block.
1943 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +00001944 /*FoundElse*/true, Result.getLocation());
Craig Silverstein08985b92010-11-06 01:19:03 +00001945
1946 if (Callbacks)
1947 Callbacks->Else();
Chris Lattner141e71f2008-03-09 01:54:53 +00001948}
1949
Craig Silverstein08985b92010-11-06 01:19:03 +00001950/// HandleElifDirective - Implements the #elif directive.
1951///
Chris Lattner141e71f2008-03-09 01:54:53 +00001952void Preprocessor::HandleElifDirective(Token &ElifToken) {
1953 ++NumElse;
Mike Stump1eb44332009-09-09 15:08:12 +00001954
Chris Lattner141e71f2008-03-09 01:54:53 +00001955 // #elif directive in a non-skipping conditional... start skipping.
1956 // We don't care what the condition is, because we will always skip it (since
1957 // the block immediately before it was included).
Craig Silverstein08985b92010-11-06 01:19:03 +00001958 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
Chris Lattner141e71f2008-03-09 01:54:53 +00001959 DiscardUntilEndOfDirective();
Craig Silverstein08985b92010-11-06 01:19:03 +00001960 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
Chris Lattner141e71f2008-03-09 01:54:53 +00001961
1962 PPConditionalInfo CI;
Chris Lattner3692b092008-11-18 07:59:24 +00001963 if (CurPPLexer->popConditionalLevel(CI)) {
1964 Diag(ElifToken, diag::pp_err_elif_without_if);
1965 return;
1966 }
Mike Stump1eb44332009-09-09 15:08:12 +00001967
Chris Lattner141e71f2008-03-09 01:54:53 +00001968 // If this is a top-level #elif, inform the MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001969 if (CurPPLexer->getConditionalStackDepth() == 0)
1970 CurPPLexer->MIOpt.EnterTopLevelConditional();
Mike Stump1eb44332009-09-09 15:08:12 +00001971
Chris Lattner141e71f2008-03-09 01:54:53 +00001972 // If this is a #elif with a #else before it, report the error.
1973 if (CI.FoundElse) Diag(ElifToken, diag::pp_err_elif_after_else);
1974
Craig Silverstein08985b92010-11-06 01:19:03 +00001975 // Finally, skip the rest of the contents of this block.
1976 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +00001977 /*FoundElse*/CI.FoundElse,
1978 ElifToken.getLocation());
Craig Silverstein08985b92010-11-06 01:19:03 +00001979
1980 if (Callbacks)
1981 Callbacks->Elif(SourceRange(ConditionalBegin, ConditionalEnd));
Chris Lattner141e71f2008-03-09 01:54:53 +00001982}