blob: 748bc38054ddc8cbaaa8a61a64a628609d22571e [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 Gregor1a4761e2011-11-30 23:21:26 +0000490 Module **SuggestedModule,
Douglas Gregor1c2e9332011-11-20 17:46:46 +0000491 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)
Richard Smitha3ca4d62011-12-16 22:50:01 +0000580 // If so, the user is relying on undefined behavior, emit a diagnostic. Do
581 // not support this for #include-like directives, since that can result in
582 // terrible diagnostics, and does not work in GCC.
583 if (InMacroArgs) {
584 if (IdentifierInfo *II = Result.getIdentifierInfo()) {
585 switch (II->getPPKeywordID()) {
586 case tok::pp_include:
587 case tok::pp_import:
588 case tok::pp_include_next:
589 case tok::pp___include_macros:
590 Diag(Result, diag::err_embedded_include) << II->getName();
591 DiscardUntilEndOfDirective();
592 return;
593 default:
594 break;
595 }
596 }
Chris Lattner141e71f2008-03-09 01:54:53 +0000597 Diag(Result, diag::ext_embedded_directive);
Richard Smitha3ca4d62011-12-16 22:50:01 +0000598 }
Mike Stump1eb44332009-09-09 15:08:12 +0000599
Chris Lattner141e71f2008-03-09 01:54:53 +0000600TryAgain:
601 switch (Result.getKind()) {
Peter Collingbourne84021552011-02-28 02:37:51 +0000602 case tok::eod:
Chris Lattner141e71f2008-03-09 01:54:53 +0000603 return; // null directive.
604 case tok::comment:
605 // Handle stuff like "# /*foo*/ define X" in -E -C mode.
606 LexUnexpandedToken(Result);
607 goto TryAgain;
Douglas Gregorf44e8542010-08-24 19:08:16 +0000608 case tok::code_completion:
609 if (CodeComplete)
610 CodeComplete->CodeCompleteDirective(
611 CurPPLexer->getConditionalStackDepth() > 0);
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +0000612 setCodeCompletionReached();
Douglas Gregorf44e8542010-08-24 19:08:16 +0000613 return;
Chris Lattner478a18e2009-01-26 06:19:46 +0000614 case tok::numeric_constant: // # 7 GNU line marker directive.
Chris Lattner5f607c42009-03-18 20:41:10 +0000615 if (getLangOptions().AsmPreprocessor)
616 break; // # 4 is not a preprocessor directive in .S files.
Chris Lattner478a18e2009-01-26 06:19:46 +0000617 return HandleDigitDirective(Result);
Chris Lattner141e71f2008-03-09 01:54:53 +0000618 default:
619 IdentifierInfo *II = Result.getIdentifierInfo();
620 if (II == 0) break; // Not an identifier.
Mike Stump1eb44332009-09-09 15:08:12 +0000621
Chris Lattner141e71f2008-03-09 01:54:53 +0000622 // Ask what the preprocessor keyword ID is.
623 switch (II->getPPKeywordID()) {
624 default: break;
625 // C99 6.10.1 - Conditional Inclusion.
626 case tok::pp_if:
627 return HandleIfDirective(Result, ReadAnyTokensBeforeDirective);
628 case tok::pp_ifdef:
629 return HandleIfdefDirective(Result, false, true/*not valid for miopt*/);
630 case tok::pp_ifndef:
631 return HandleIfdefDirective(Result, true, ReadAnyTokensBeforeDirective);
632 case tok::pp_elif:
633 return HandleElifDirective(Result);
634 case tok::pp_else:
635 return HandleElseDirective(Result);
636 case tok::pp_endif:
637 return HandleEndifDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000638
Chris Lattner141e71f2008-03-09 01:54:53 +0000639 // C99 6.10.2 - Source File Inclusion.
640 case tok::pp_include:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000641 // Handle #include.
642 return HandleIncludeDirective(SavedHash.getLocation(), Result);
Chris Lattnerb8e240e2009-04-08 18:24:34 +0000643 case tok::pp___include_macros:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000644 // Handle -imacros.
645 return HandleIncludeMacrosDirective(SavedHash.getLocation(), Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000646
Chris Lattner141e71f2008-03-09 01:54:53 +0000647 // C99 6.10.3 - Macro Replacement.
648 case tok::pp_define:
649 return HandleDefineDirective(Result);
650 case tok::pp_undef:
651 return HandleUndefDirective(Result);
652
653 // C99 6.10.4 - Line Control.
654 case tok::pp_line:
Chris Lattner359cc442009-01-26 05:29:08 +0000655 return HandleLineDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000656
Chris Lattner141e71f2008-03-09 01:54:53 +0000657 // C99 6.10.5 - Error Directive.
658 case tok::pp_error:
659 return HandleUserDiagnosticDirective(Result, false);
Mike Stump1eb44332009-09-09 15:08:12 +0000660
Chris Lattner141e71f2008-03-09 01:54:53 +0000661 // C99 6.10.6 - Pragma Directive.
662 case tok::pp_pragma:
Douglas Gregor80c60f72010-09-09 22:45:38 +0000663 return HandlePragmaDirective(PIK_HashPragma);
Mike Stump1eb44332009-09-09 15:08:12 +0000664
Chris Lattner141e71f2008-03-09 01:54:53 +0000665 // GNU Extensions.
666 case tok::pp_import:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000667 return HandleImportDirective(SavedHash.getLocation(), Result);
Chris Lattner141e71f2008-03-09 01:54:53 +0000668 case tok::pp_include_next:
Douglas Gregorecdcb882010-10-20 22:00:55 +0000669 return HandleIncludeNextDirective(SavedHash.getLocation(), Result);
Mike Stump1eb44332009-09-09 15:08:12 +0000670
Chris Lattner141e71f2008-03-09 01:54:53 +0000671 case tok::pp_warning:
672 Diag(Result, diag::ext_pp_warning_directive);
673 return HandleUserDiagnosticDirective(Result, true);
674 case tok::pp_ident:
675 return HandleIdentSCCSDirective(Result);
676 case tok::pp_sccs:
677 return HandleIdentSCCSDirective(Result);
678 case tok::pp_assert:
679 //isExtension = true; // FIXME: implement #assert
680 break;
681 case tok::pp_unassert:
682 //isExtension = true; // FIXME: implement #unassert
683 break;
Douglas Gregor7143aab2011-09-01 17:04:32 +0000684
Douglas Gregor1ac13c32012-01-03 19:48:16 +0000685 case tok::pp___public_macro:
Douglas Gregor94ad28b2012-01-03 18:24:14 +0000686 if (getLangOptions().Modules)
687 return HandleMacroPublicDirective(Result);
688 break;
689
Douglas Gregor1ac13c32012-01-03 19:48:16 +0000690 case tok::pp___private_macro:
Douglas Gregor94ad28b2012-01-03 18:24:14 +0000691 if (getLangOptions().Modules)
692 return HandleMacroPrivateDirective(Result);
693 break;
Chris Lattner141e71f2008-03-09 01:54:53 +0000694 }
695 break;
696 }
Mike Stump1eb44332009-09-09 15:08:12 +0000697
Chris Lattner42aa16c2009-03-18 21:00:25 +0000698 // If this is a .S file, treat unknown # directives as non-preprocessor
699 // directives. This is important because # may be a comment or introduce
700 // various pseudo-ops. Just return the # token and push back the following
701 // token to be lexed next time.
702 if (getLangOptions().AsmPreprocessor) {
Daniel Dunbar3d399a02009-07-13 21:48:50 +0000703 Token *Toks = new Token[2];
Chris Lattner42aa16c2009-03-18 21:00:25 +0000704 // Return the # and the token after it.
Mike Stump1eb44332009-09-09 15:08:12 +0000705 Toks[0] = SavedHash;
Chris Lattner42aa16c2009-03-18 21:00:25 +0000706 Toks[1] = Result;
Chris Lattnerba3ca522011-01-06 05:01:51 +0000707
708 // If the second token is a hashhash token, then we need to translate it to
709 // unknown so the token lexer doesn't try to perform token pasting.
710 if (Result.is(tok::hashhash))
711 Toks[1].setKind(tok::unknown);
712
Chris Lattner42aa16c2009-03-18 21:00:25 +0000713 // Enter this token stream so that we re-lex the tokens. Make sure to
714 // enable macro expansion, in case the token after the # is an identifier
715 // that is expanded.
716 EnterTokenStream(Toks, 2, false, true);
717 return;
718 }
Mike Stump1eb44332009-09-09 15:08:12 +0000719
Chris Lattner141e71f2008-03-09 01:54:53 +0000720 // If we reached here, the preprocessing token is not valid!
721 Diag(Result, diag::err_pp_invalid_directive);
Mike Stump1eb44332009-09-09 15:08:12 +0000722
Chris Lattner141e71f2008-03-09 01:54:53 +0000723 // Read the rest of the PP line.
724 DiscardUntilEndOfDirective();
Mike Stump1eb44332009-09-09 15:08:12 +0000725
Chris Lattner141e71f2008-03-09 01:54:53 +0000726 // Okay, we're done parsing the directive.
727}
728
Chris Lattner478a18e2009-01-26 06:19:46 +0000729/// GetLineValue - Convert a numeric token into an unsigned value, emitting
730/// Diagnostic DiagID if it is invalid, and returning the value in Val.
731static bool GetLineValue(Token &DigitTok, unsigned &Val,
732 unsigned DiagID, Preprocessor &PP) {
733 if (DigitTok.isNot(tok::numeric_constant)) {
734 PP.Diag(DigitTok, DiagID);
Mike Stump1eb44332009-09-09 15:08:12 +0000735
Peter Collingbourne84021552011-02-28 02:37:51 +0000736 if (DigitTok.isNot(tok::eod))
Chris Lattner478a18e2009-01-26 06:19:46 +0000737 PP.DiscardUntilEndOfDirective();
738 return true;
739 }
Mike Stump1eb44332009-09-09 15:08:12 +0000740
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000741 SmallString<64> IntegerBuffer;
Chris Lattner478a18e2009-01-26 06:19:46 +0000742 IntegerBuffer.resize(DigitTok.getLength());
743 const char *DigitTokBegin = &IntegerBuffer[0];
Douglas Gregor453091c2010-03-16 22:30:13 +0000744 bool Invalid = false;
745 unsigned ActualLength = PP.getSpelling(DigitTok, DigitTokBegin, &Invalid);
746 if (Invalid)
747 return true;
748
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000749 // Verify that we have a simple digit-sequence, and compute the value. This
750 // is always a simple digit string computed in decimal, so we do this manually
751 // here.
752 Val = 0;
753 for (unsigned i = 0; i != ActualLength; ++i) {
754 if (!isdigit(DigitTokBegin[i])) {
755 PP.Diag(PP.AdvanceToTokenCharacter(DigitTok.getLocation(), i),
756 diag::err_pp_line_digit_sequence);
757 PP.DiscardUntilEndOfDirective();
758 return true;
759 }
Mike Stump1eb44332009-09-09 15:08:12 +0000760
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000761 unsigned NextVal = Val*10+(DigitTokBegin[i]-'0');
762 if (NextVal < Val) { // overflow.
763 PP.Diag(DigitTok, DiagID);
764 PP.DiscardUntilEndOfDirective();
765 return true;
766 }
767 Val = NextVal;
Chris Lattner478a18e2009-01-26 06:19:46 +0000768 }
Mike Stump1eb44332009-09-09 15:08:12 +0000769
770 // Reject 0, this is needed both by #line numbers and flags.
Chris Lattner478a18e2009-01-26 06:19:46 +0000771 if (Val == 0) {
772 PP.Diag(DigitTok, DiagID);
773 PP.DiscardUntilEndOfDirective();
774 return true;
775 }
Mike Stump1eb44332009-09-09 15:08:12 +0000776
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000777 if (DigitTokBegin[0] == '0')
778 PP.Diag(DigitTok.getLocation(), diag::warn_pp_line_decimal);
Mike Stump1eb44332009-09-09 15:08:12 +0000779
Chris Lattner478a18e2009-01-26 06:19:46 +0000780 return false;
781}
782
Mike Stump1eb44332009-09-09 15:08:12 +0000783/// HandleLineDirective - Handle #line directive: C99 6.10.4. The two
Chris Lattner359cc442009-01-26 05:29:08 +0000784/// acceptable forms are:
785/// # line digit-sequence
786/// # line digit-sequence "s-char-sequence"
787void Preprocessor::HandleLineDirective(Token &Tok) {
788 // Read the line # and string argument. Per C99 6.10.4p5, these tokens are
789 // expanded.
790 Token DigitTok;
791 Lex(DigitTok);
792
Chris Lattner359cc442009-01-26 05:29:08 +0000793 // Validate the number and convert it to an unsigned.
Chris Lattner478a18e2009-01-26 06:19:46 +0000794 unsigned LineNo;
Chris Lattnerdc8c90d2009-04-18 18:35:15 +0000795 if (GetLineValue(DigitTok, LineNo, diag::err_pp_line_requires_integer,*this))
Chris Lattner359cc442009-01-26 05:29:08 +0000796 return;
Chris Lattner359cc442009-01-26 05:29:08 +0000797
Chris Lattner478a18e2009-01-26 06:19:46 +0000798 // Enforce C99 6.10.4p3: "The digit sequence shall not specify ... a
799 // number greater than 2147483647". C90 requires that the line # be <= 32767.
Eli Friedman158ebfb2011-10-10 23:35:28 +0000800 unsigned LineLimit = 32768U;
801 if (Features.C99 || Features.CPlusPlus0x)
802 LineLimit = 2147483648U;
Chris Lattner359cc442009-01-26 05:29:08 +0000803 if (LineNo >= LineLimit)
804 Diag(DigitTok, diag::ext_pp_line_too_big) << LineLimit;
Richard Smith661a9962011-10-15 01:18:56 +0000805 else if (Features.CPlusPlus0x && LineNo >= 32768U)
806 Diag(DigitTok, diag::warn_cxx98_compat_pp_line_too_big);
Mike Stump1eb44332009-09-09 15:08:12 +0000807
Chris Lattner5b9a5042009-01-26 07:57:50 +0000808 int FilenameID = -1;
Chris Lattner359cc442009-01-26 05:29:08 +0000809 Token StrTok;
810 Lex(StrTok);
811
Peter Collingbourne84021552011-02-28 02:37:51 +0000812 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
813 // string followed by eod.
814 if (StrTok.is(tok::eod))
Chris Lattner359cc442009-01-26 05:29:08 +0000815 ; // ok
816 else if (StrTok.isNot(tok::string_literal)) {
817 Diag(StrTok, diag::err_pp_line_invalid_filename);
818 DiscardUntilEndOfDirective();
819 return;
820 } else {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000821 // Parse and validate the string, converting it into a unique ID.
822 StringLiteralParser Literal(&StrTok, 1, *this);
Douglas Gregor5cee1192011-07-27 05:40:30 +0000823 assert(Literal.isAscii() && "Didn't allow wide strings in");
Chris Lattner5b9a5042009-01-26 07:57:50 +0000824 if (Literal.hadError)
825 return DiscardUntilEndOfDirective();
826 if (Literal.Pascal) {
827 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
828 return DiscardUntilEndOfDirective();
829 }
Jay Foad65aa6882011-06-21 15:13:30 +0000830 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
Mike Stump1eb44332009-09-09 15:08:12 +0000831
Peter Collingbourne84021552011-02-28 02:37:51 +0000832 // Verify that there is nothing after the string, other than EOD. Because
Chris Lattnerab82f412009-04-17 23:30:53 +0000833 // of C99 6.10.4p5, macros that expand to empty tokens are ok.
834 CheckEndOfDirective("line", true);
Chris Lattner359cc442009-01-26 05:29:08 +0000835 }
Mike Stump1eb44332009-09-09 15:08:12 +0000836
Chris Lattner4c4ea172009-02-03 21:52:55 +0000837 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID);
Mike Stump1eb44332009-09-09 15:08:12 +0000838
Chris Lattner16629382009-03-27 17:13:49 +0000839 if (Callbacks)
Chris Lattner86d0ef72010-04-14 04:28:50 +0000840 Callbacks->FileChanged(CurPPLexer->getSourceLocation(),
841 PPCallbacks::RenameFile,
Chris Lattner16629382009-03-27 17:13:49 +0000842 SrcMgr::C_User);
Chris Lattner359cc442009-01-26 05:29:08 +0000843}
844
Chris Lattner478a18e2009-01-26 06:19:46 +0000845/// ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line
846/// marker directive.
847static bool ReadLineMarkerFlags(bool &IsFileEntry, bool &IsFileExit,
848 bool &IsSystemHeader, bool &IsExternCHeader,
849 Preprocessor &PP) {
850 unsigned FlagVal;
851 Token FlagTok;
852 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000853 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000854 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
855 return true;
856
857 if (FlagVal == 1) {
858 IsFileEntry = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000859
Chris Lattner478a18e2009-01-26 06:19:46 +0000860 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000861 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000862 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
863 return true;
864 } else if (FlagVal == 2) {
865 IsFileExit = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000866
Chris Lattner137b6a62009-02-04 06:25:26 +0000867 SourceManager &SM = PP.getSourceManager();
868 // If we are leaving the current presumed file, check to make sure the
869 // presumed include stack isn't empty!
870 FileID CurFileID =
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000871 SM.getDecomposedExpansionLoc(FlagTok.getLocation()).first;
Chris Lattner137b6a62009-02-04 06:25:26 +0000872 PresumedLoc PLoc = SM.getPresumedLoc(FlagTok.getLocation());
Douglas Gregorcb7b1e12010-11-12 07:15:47 +0000873 if (PLoc.isInvalid())
874 return true;
875
Chris Lattner137b6a62009-02-04 06:25:26 +0000876 // If there is no include loc (main file) or if the include loc is in a
877 // different physical file, then we aren't in a "1" line marker flag region.
878 SourceLocation IncLoc = PLoc.getIncludeLoc();
879 if (IncLoc.isInvalid() ||
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000880 SM.getDecomposedExpansionLoc(IncLoc).first != CurFileID) {
Chris Lattner137b6a62009-02-04 06:25:26 +0000881 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_pop);
882 PP.DiscardUntilEndOfDirective();
883 return true;
884 }
Mike Stump1eb44332009-09-09 15:08:12 +0000885
Chris Lattner478a18e2009-01-26 06:19:46 +0000886 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000887 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000888 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag,PP))
889 return true;
890 }
891
892 // We must have 3 if there are still flags.
893 if (FlagVal != 3) {
894 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000895 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000896 return true;
897 }
Mike Stump1eb44332009-09-09 15:08:12 +0000898
Chris Lattner478a18e2009-01-26 06:19:46 +0000899 IsSystemHeader = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000900
Chris Lattner478a18e2009-01-26 06:19:46 +0000901 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000902 if (FlagTok.is(tok::eod)) return false;
Chris Lattner9d79eba2009-02-04 05:21:58 +0000903 if (GetLineValue(FlagTok, FlagVal, diag::err_pp_linemarker_invalid_flag, PP))
Chris Lattner478a18e2009-01-26 06:19:46 +0000904 return true;
905
906 // We must have 4 if there is yet another flag.
907 if (FlagVal != 4) {
908 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000909 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000910 return true;
911 }
Mike Stump1eb44332009-09-09 15:08:12 +0000912
Chris Lattner478a18e2009-01-26 06:19:46 +0000913 IsExternCHeader = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000914
Chris Lattner478a18e2009-01-26 06:19:46 +0000915 PP.Lex(FlagTok);
Peter Collingbourne84021552011-02-28 02:37:51 +0000916 if (FlagTok.is(tok::eod)) return false;
Chris Lattner478a18e2009-01-26 06:19:46 +0000917
918 // There are no more valid flags here.
919 PP.Diag(FlagTok, diag::err_pp_linemarker_invalid_flag);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000920 PP.DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000921 return true;
922}
923
924/// HandleDigitDirective - Handle a GNU line marker directive, whose syntax is
925/// one of the following forms:
926///
927/// # 42
Mike Stump1eb44332009-09-09 15:08:12 +0000928/// # 42 "file" ('1' | '2')?
Chris Lattner478a18e2009-01-26 06:19:46 +0000929/// # 42 "file" ('1' | '2')? '3' '4'?
930///
931void Preprocessor::HandleDigitDirective(Token &DigitTok) {
932 // Validate the number and convert it to an unsigned. GNU does not have a
933 // line # limit other than it fit in 32-bits.
934 unsigned LineNo;
935 if (GetLineValue(DigitTok, LineNo, diag::err_pp_linemarker_requires_integer,
936 *this))
937 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000938
Chris Lattner478a18e2009-01-26 06:19:46 +0000939 Token StrTok;
940 Lex(StrTok);
Mike Stump1eb44332009-09-09 15:08:12 +0000941
Chris Lattner478a18e2009-01-26 06:19:46 +0000942 bool IsFileEntry = false, IsFileExit = false;
943 bool IsSystemHeader = false, IsExternCHeader = false;
Chris Lattner5b9a5042009-01-26 07:57:50 +0000944 int FilenameID = -1;
945
Peter Collingbourne84021552011-02-28 02:37:51 +0000946 // If the StrTok is "eod", then it wasn't present. Otherwise, it must be a
947 // string followed by eod.
948 if (StrTok.is(tok::eod))
Chris Lattner478a18e2009-01-26 06:19:46 +0000949 ; // ok
950 else if (StrTok.isNot(tok::string_literal)) {
951 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000952 return DiscardUntilEndOfDirective();
Chris Lattner478a18e2009-01-26 06:19:46 +0000953 } else {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000954 // Parse and validate the string, converting it into a unique ID.
955 StringLiteralParser Literal(&StrTok, 1, *this);
Douglas Gregor5cee1192011-07-27 05:40:30 +0000956 assert(Literal.isAscii() && "Didn't allow wide strings in");
Chris Lattner5b9a5042009-01-26 07:57:50 +0000957 if (Literal.hadError)
958 return DiscardUntilEndOfDirective();
959 if (Literal.Pascal) {
960 Diag(StrTok, diag::err_pp_linemarker_invalid_filename);
961 return DiscardUntilEndOfDirective();
962 }
Jay Foad65aa6882011-06-21 15:13:30 +0000963 FilenameID = SourceMgr.getLineTableFilenameID(Literal.GetString());
Mike Stump1eb44332009-09-09 15:08:12 +0000964
Chris Lattner478a18e2009-01-26 06:19:46 +0000965 // If a filename was present, read any flags that are present.
Mike Stump1eb44332009-09-09 15:08:12 +0000966 if (ReadLineMarkerFlags(IsFileEntry, IsFileExit,
Chris Lattner5b9a5042009-01-26 07:57:50 +0000967 IsSystemHeader, IsExternCHeader, *this))
Chris Lattner478a18e2009-01-26 06:19:46 +0000968 return;
Chris Lattner478a18e2009-01-26 06:19:46 +0000969 }
Mike Stump1eb44332009-09-09 15:08:12 +0000970
Chris Lattner9d79eba2009-02-04 05:21:58 +0000971 // Create a line note with this information.
972 SourceMgr.AddLineNote(DigitTok.getLocation(), LineNo, FilenameID,
Mike Stump1eb44332009-09-09 15:08:12 +0000973 IsFileEntry, IsFileExit,
Chris Lattner9d79eba2009-02-04 05:21:58 +0000974 IsSystemHeader, IsExternCHeader);
Mike Stump1eb44332009-09-09 15:08:12 +0000975
Chris Lattner16629382009-03-27 17:13:49 +0000976 // If the preprocessor has callbacks installed, notify them of the #line
977 // change. This is used so that the line marker comes out in -E mode for
978 // example.
979 if (Callbacks) {
980 PPCallbacks::FileChangeReason Reason = PPCallbacks::RenameFile;
981 if (IsFileEntry)
982 Reason = PPCallbacks::EnterFile;
983 else if (IsFileExit)
984 Reason = PPCallbacks::ExitFile;
985 SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
986 if (IsExternCHeader)
987 FileKind = SrcMgr::C_ExternCSystem;
988 else if (IsSystemHeader)
989 FileKind = SrcMgr::C_System;
Mike Stump1eb44332009-09-09 15:08:12 +0000990
Chris Lattner86d0ef72010-04-14 04:28:50 +0000991 Callbacks->FileChanged(CurPPLexer->getSourceLocation(), Reason, FileKind);
Chris Lattner16629382009-03-27 17:13:49 +0000992 }
Chris Lattner478a18e2009-01-26 06:19:46 +0000993}
994
995
Chris Lattner099dd052009-01-26 05:30:54 +0000996/// HandleUserDiagnosticDirective - Handle a #warning or #error directive.
997///
Mike Stump1eb44332009-09-09 15:08:12 +0000998void Preprocessor::HandleUserDiagnosticDirective(Token &Tok,
Chris Lattner141e71f2008-03-09 01:54:53 +0000999 bool isWarning) {
Chris Lattner099dd052009-01-26 05:30:54 +00001000 // PTH doesn't emit #warning or #error directives.
1001 if (CurPTHLexer)
Chris Lattner359cc442009-01-26 05:29:08 +00001002 return CurPTHLexer->DiscardToEndOfLine();
1003
Chris Lattner141e71f2008-03-09 01:54:53 +00001004 // Read the rest of the line raw. We do this because we don't want macros
1005 // to be expanded and we don't require that the tokens be valid preprocessing
1006 // tokens. For example, this is allowed: "#warning ` 'foo". GCC does
1007 // collapse multiple consequtive white space between tokens, but this isn't
1008 // specified by the standard.
Chris Lattner359cc442009-01-26 05:29:08 +00001009 std::string Message = CurLexer->ReadToEndOfLine();
Ted Kremenek34a2c422012-02-02 00:16:13 +00001010
1011 // Find the first non-whitespace character, so that we can make the
1012 // diagnostic more succinct.
1013 StringRef Msg(Message);
1014 size_t i = Msg.find_first_not_of(' ');
1015 if (i < Msg.size())
1016 Msg = Msg.substr(i);
1017
Chris Lattner359cc442009-01-26 05:29:08 +00001018 if (isWarning)
Ted Kremenek34a2c422012-02-02 00:16:13 +00001019 Diag(Tok, diag::pp_hash_warning) << Msg;
Chris Lattner359cc442009-01-26 05:29:08 +00001020 else
Ted Kremenek34a2c422012-02-02 00:16:13 +00001021 Diag(Tok, diag::err_pp_hash_error) << Msg;
Chris Lattner141e71f2008-03-09 01:54:53 +00001022}
1023
1024/// HandleIdentSCCSDirective - Handle a #ident/#sccs directive.
1025///
1026void Preprocessor::HandleIdentSCCSDirective(Token &Tok) {
1027 // Yes, this directive is an extension.
1028 Diag(Tok, diag::ext_pp_ident_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001029
Chris Lattner141e71f2008-03-09 01:54:53 +00001030 // Read the string argument.
1031 Token StrTok;
1032 Lex(StrTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001033
Chris Lattner141e71f2008-03-09 01:54:53 +00001034 // If the token kind isn't a string, it's a malformed directive.
1035 if (StrTok.isNot(tok::string_literal) &&
Chris Lattner3692b092008-11-18 07:59:24 +00001036 StrTok.isNot(tok::wide_string_literal)) {
1037 Diag(StrTok, diag::err_pp_malformed_ident);
Peter Collingbourne84021552011-02-28 02:37:51 +00001038 if (StrTok.isNot(tok::eod))
Chris Lattner099dd052009-01-26 05:30:54 +00001039 DiscardUntilEndOfDirective();
Chris Lattner3692b092008-11-18 07:59:24 +00001040 return;
1041 }
Mike Stump1eb44332009-09-09 15:08:12 +00001042
Peter Collingbourne84021552011-02-28 02:37:51 +00001043 // Verify that there is nothing after the string, other than EOD.
Chris Lattner35410d52009-04-14 05:07:49 +00001044 CheckEndOfDirective("ident");
Chris Lattner141e71f2008-03-09 01:54:53 +00001045
Douglas Gregor453091c2010-03-16 22:30:13 +00001046 if (Callbacks) {
1047 bool Invalid = false;
1048 std::string Str = getSpelling(StrTok, &Invalid);
1049 if (!Invalid)
1050 Callbacks->Ident(Tok.getLocation(), Str);
1051 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001052}
1053
Douglas Gregor94ad28b2012-01-03 18:24:14 +00001054/// \brief Handle a #public directive.
1055void Preprocessor::HandleMacroPublicDirective(Token &Tok) {
Douglas Gregor7143aab2011-09-01 17:04:32 +00001056 Token MacroNameTok;
1057 ReadMacroName(MacroNameTok, 2);
1058
1059 // Error reading macro name? If so, diagnostic already issued.
1060 if (MacroNameTok.is(tok::eod))
1061 return;
1062
Douglas Gregor1ac13c32012-01-03 19:48:16 +00001063 // Check to see if this is the last token on the #__public_macro line.
1064 CheckEndOfDirective("__public_macro");
Douglas Gregor7143aab2011-09-01 17:04:32 +00001065
1066 // Okay, we finally have a valid identifier to undef.
1067 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
1068
1069 // If the macro is not defined, this is an error.
1070 if (MI == 0) {
Douglas Gregoraa93a872011-10-17 15:32:29 +00001071 Diag(MacroNameTok, diag::err_pp_visibility_non_macro)
Douglas Gregor7143aab2011-09-01 17:04:32 +00001072 << MacroNameTok.getIdentifierInfo();
1073 return;
1074 }
1075
1076 // Note that this macro has now been exported.
Douglas Gregoraa93a872011-10-17 15:32:29 +00001077 MI->setVisibility(/*IsPublic=*/true, MacroNameTok.getLocation());
1078
1079 // If this macro definition came from a PCH file, mark it
1080 // as having changed since serialization.
1081 if (MI->isFromAST())
1082 MI->setChangedAfterLoad();
1083}
1084
Douglas Gregor94ad28b2012-01-03 18:24:14 +00001085/// \brief Handle a #private directive.
Douglas Gregoraa93a872011-10-17 15:32:29 +00001086void Preprocessor::HandleMacroPrivateDirective(Token &Tok) {
1087 Token MacroNameTok;
1088 ReadMacroName(MacroNameTok, 2);
1089
1090 // Error reading macro name? If so, diagnostic already issued.
1091 if (MacroNameTok.is(tok::eod))
1092 return;
1093
Douglas Gregor1ac13c32012-01-03 19:48:16 +00001094 // Check to see if this is the last token on the #__private_macro line.
1095 CheckEndOfDirective("__private_macro");
Douglas Gregoraa93a872011-10-17 15:32:29 +00001096
1097 // Okay, we finally have a valid identifier to undef.
1098 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
1099
1100 // If the macro is not defined, this is an error.
1101 if (MI == 0) {
1102 Diag(MacroNameTok, diag::err_pp_visibility_non_macro)
1103 << MacroNameTok.getIdentifierInfo();
1104 return;
1105 }
1106
1107 // Note that this macro has now been marked private.
1108 MI->setVisibility(/*IsPublic=*/false, MacroNameTok.getLocation());
Douglas Gregor7143aab2011-09-01 17:04:32 +00001109
1110 // If this macro definition came from a PCH file, mark it
1111 // as having changed since serialization.
1112 if (MI->isFromAST())
1113 MI->setChangedAfterLoad();
1114}
1115
Chris Lattner141e71f2008-03-09 01:54:53 +00001116//===----------------------------------------------------------------------===//
1117// Preprocessor Include Directive Handling.
1118//===----------------------------------------------------------------------===//
1119
1120/// GetIncludeFilenameSpelling - Turn the specified lexer token into a fully
1121/// checked and spelled filename, e.g. as an operand of #include. This returns
1122/// true if the input filename was in <>'s or false if it were in ""'s. The
1123/// caller is expected to provide a buffer that is large enough to hold the
1124/// spelling of the filename, but is also expected to handle the case when
1125/// this method decides to use a different buffer.
1126bool Preprocessor::GetIncludeFilenameSpelling(SourceLocation Loc,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001127 StringRef &Buffer) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001128 // Get the text form of the filename.
Chris Lattnera1394812010-01-10 01:35:12 +00001129 assert(!Buffer.empty() && "Can't have tokens with empty spellings!");
Mike Stump1eb44332009-09-09 15:08:12 +00001130
Chris Lattner141e71f2008-03-09 01:54:53 +00001131 // Make sure the filename is <x> or "x".
1132 bool isAngled;
Chris Lattnera1394812010-01-10 01:35:12 +00001133 if (Buffer[0] == '<') {
1134 if (Buffer.back() != '>') {
Chris Lattner141e71f2008-03-09 01:54:53 +00001135 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001136 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001137 return true;
1138 }
1139 isAngled = true;
Chris Lattnera1394812010-01-10 01:35:12 +00001140 } else if (Buffer[0] == '"') {
1141 if (Buffer.back() != '"') {
Chris Lattner141e71f2008-03-09 01:54:53 +00001142 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001143 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001144 return true;
1145 }
1146 isAngled = false;
1147 } else {
1148 Diag(Loc, diag::err_pp_expects_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001149 Buffer = StringRef();
Chris Lattner141e71f2008-03-09 01:54:53 +00001150 return true;
1151 }
Mike Stump1eb44332009-09-09 15:08:12 +00001152
Chris Lattner141e71f2008-03-09 01:54:53 +00001153 // Diagnose #include "" as invalid.
Chris Lattnera1394812010-01-10 01:35:12 +00001154 if (Buffer.size() <= 2) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001155 Diag(Loc, diag::err_pp_empty_filename);
Chris Lattner5f9e2722011-07-23 10:55:15 +00001156 Buffer = StringRef();
Chris Lattnera1394812010-01-10 01:35:12 +00001157 return true;
Chris Lattner141e71f2008-03-09 01:54:53 +00001158 }
Mike Stump1eb44332009-09-09 15:08:12 +00001159
Chris Lattner141e71f2008-03-09 01:54:53 +00001160 // Skip the brackets.
Chris Lattnera1394812010-01-10 01:35:12 +00001161 Buffer = Buffer.substr(1, Buffer.size()-2);
Chris Lattner141e71f2008-03-09 01:54:53 +00001162 return isAngled;
1163}
1164
1165/// ConcatenateIncludeName - Handle cases where the #include name is expanded
1166/// from a macro as multiple tokens, which need to be glued together. This
1167/// occurs for code like:
1168/// #define FOO <a/b.h>
1169/// #include FOO
1170/// because in this case, "<a/b.h>" is returned as 7 tokens, not one.
1171///
1172/// This code concatenates and consumes tokens up to the '>' token. It returns
1173/// false if the > was found, otherwise it returns true if it finds and consumes
Peter Collingbourne84021552011-02-28 02:37:51 +00001174/// the EOD marker.
John Thompsona28cc092009-10-30 13:49:06 +00001175bool Preprocessor::ConcatenateIncludeName(
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001176 SmallString<128> &FilenameBuffer,
Douglas Gregorecdcb882010-10-20 22:00:55 +00001177 SourceLocation &End) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001178 Token CurTok;
Mike Stump1eb44332009-09-09 15:08:12 +00001179
John Thompsona28cc092009-10-30 13:49:06 +00001180 Lex(CurTok);
Peter Collingbourne84021552011-02-28 02:37:51 +00001181 while (CurTok.isNot(tok::eod)) {
Douglas Gregorecdcb882010-10-20 22:00:55 +00001182 End = CurTok.getLocation();
1183
Douglas Gregor25bb03b2010-12-09 23:35:36 +00001184 // FIXME: Provide code completion for #includes.
1185 if (CurTok.is(tok::code_completion)) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001186 setCodeCompletionReached();
Douglas Gregor25bb03b2010-12-09 23:35:36 +00001187 Lex(CurTok);
1188 continue;
1189 }
1190
Chris Lattner141e71f2008-03-09 01:54:53 +00001191 // Append the spelling of this token to the buffer. If there was a space
1192 // before it, add it now.
1193 if (CurTok.hasLeadingSpace())
1194 FilenameBuffer.push_back(' ');
Mike Stump1eb44332009-09-09 15:08:12 +00001195
Chris Lattner141e71f2008-03-09 01:54:53 +00001196 // Get the spelling of the token, directly into FilenameBuffer if possible.
1197 unsigned PreAppendSize = FilenameBuffer.size();
1198 FilenameBuffer.resize(PreAppendSize+CurTok.getLength());
Mike Stump1eb44332009-09-09 15:08:12 +00001199
Chris Lattner141e71f2008-03-09 01:54:53 +00001200 const char *BufPtr = &FilenameBuffer[PreAppendSize];
John Thompsona28cc092009-10-30 13:49:06 +00001201 unsigned ActualLen = getSpelling(CurTok, BufPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00001202
Chris Lattner141e71f2008-03-09 01:54:53 +00001203 // If the token was spelled somewhere else, copy it into FilenameBuffer.
1204 if (BufPtr != &FilenameBuffer[PreAppendSize])
1205 memcpy(&FilenameBuffer[PreAppendSize], BufPtr, ActualLen);
Mike Stump1eb44332009-09-09 15:08:12 +00001206
Chris Lattner141e71f2008-03-09 01:54:53 +00001207 // Resize FilenameBuffer to the correct size.
1208 if (CurTok.getLength() != ActualLen)
1209 FilenameBuffer.resize(PreAppendSize+ActualLen);
Mike Stump1eb44332009-09-09 15:08:12 +00001210
Chris Lattner141e71f2008-03-09 01:54:53 +00001211 // If we found the '>' marker, return success.
1212 if (CurTok.is(tok::greater))
1213 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001214
John Thompsona28cc092009-10-30 13:49:06 +00001215 Lex(CurTok);
Chris Lattner141e71f2008-03-09 01:54:53 +00001216 }
1217
Peter Collingbourne84021552011-02-28 02:37:51 +00001218 // If we hit the eod marker, emit an error and return true so that the caller
1219 // knows the EOD has been read.
John Thompsona28cc092009-10-30 13:49:06 +00001220 Diag(CurTok.getLocation(), diag::err_pp_expects_filename);
Chris Lattner141e71f2008-03-09 01:54:53 +00001221 return true;
1222}
1223
1224/// HandleIncludeDirective - The "#include" tokens have just been read, read the
1225/// file to be included from the lexer, then include it! This is a common
1226/// routine with functionality shared between #include, #include_next and
Chris Lattner72181832008-09-26 20:12:23 +00001227/// #import. LookupFrom is set when this is a #include_next directive, it
Mike Stump1eb44332009-09-09 15:08:12 +00001228/// specifies the file to start searching from.
Douglas Gregorecdcb882010-10-20 22:00:55 +00001229void Preprocessor::HandleIncludeDirective(SourceLocation HashLoc,
1230 Token &IncludeTok,
Chris Lattner141e71f2008-03-09 01:54:53 +00001231 const DirectoryLookup *LookupFrom,
1232 bool isImport) {
1233
1234 Token FilenameTok;
Ted Kremenek60e45d42008-11-18 00:34:22 +00001235 CurPPLexer->LexIncludeFilename(FilenameTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001236
Chris Lattner141e71f2008-03-09 01:54:53 +00001237 // Reserve a buffer to get the spelling.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001238 SmallString<128> FilenameBuffer;
Chris Lattner5f9e2722011-07-23 10:55:15 +00001239 StringRef Filename;
Douglas Gregorecdcb882010-10-20 22:00:55 +00001240 SourceLocation End;
Douglas Gregore3a82562011-11-30 18:02:36 +00001241 SourceLocation CharEnd; // the end of this directive, in characters
Douglas Gregorecdcb882010-10-20 22:00:55 +00001242
Chris Lattner141e71f2008-03-09 01:54:53 +00001243 switch (FilenameTok.getKind()) {
Peter Collingbourne84021552011-02-28 02:37:51 +00001244 case tok::eod:
1245 // If the token kind is EOD, the error has already been diagnosed.
Chris Lattner141e71f2008-03-09 01:54:53 +00001246 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001247
Chris Lattner141e71f2008-03-09 01:54:53 +00001248 case tok::angle_string_literal:
Benjamin Kramerddeea562010-02-27 13:44:12 +00001249 case tok::string_literal:
1250 Filename = getSpelling(FilenameTok, FilenameBuffer);
Douglas Gregorecdcb882010-10-20 22:00:55 +00001251 End = FilenameTok.getLocation();
Douglas Gregore3a82562011-11-30 18:02:36 +00001252 CharEnd = End.getLocWithOffset(Filename.size());
Chris Lattner141e71f2008-03-09 01:54:53 +00001253 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001254
Chris Lattner141e71f2008-03-09 01:54:53 +00001255 case tok::less:
1256 // This could be a <foo/bar.h> file coming from a macro expansion. In this
1257 // case, glue the tokens together into FilenameBuffer and interpret those.
1258 FilenameBuffer.push_back('<');
Douglas Gregorecdcb882010-10-20 22:00:55 +00001259 if (ConcatenateIncludeName(FilenameBuffer, End))
Peter Collingbourne84021552011-02-28 02:37:51 +00001260 return; // Found <eod> but no ">"? Diagnostic already emitted.
Chris Lattnera1394812010-01-10 01:35:12 +00001261 Filename = FilenameBuffer.str();
Douglas Gregore3a82562011-11-30 18:02:36 +00001262 CharEnd = getLocForEndOfToken(End);
Chris Lattner141e71f2008-03-09 01:54:53 +00001263 break;
1264 default:
1265 Diag(FilenameTok.getLocation(), diag::err_pp_expects_filename);
1266 DiscardUntilEndOfDirective();
1267 return;
1268 }
Mike Stump1eb44332009-09-09 15:08:12 +00001269
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001270 bool isAngled =
Chris Lattnera1394812010-01-10 01:35:12 +00001271 GetIncludeFilenameSpelling(FilenameTok.getLocation(), Filename);
Chris Lattner141e71f2008-03-09 01:54:53 +00001272 // If GetIncludeFilenameSpelling set the start ptr to null, there was an
1273 // error.
Chris Lattnera1394812010-01-10 01:35:12 +00001274 if (Filename.empty()) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001275 DiscardUntilEndOfDirective();
1276 return;
1277 }
Mike Stump1eb44332009-09-09 15:08:12 +00001278
Peter Collingbourne84021552011-02-28 02:37:51 +00001279 // Verify that there is nothing after the filename, other than EOD. Note that
Chris Lattner9cb51ce2009-04-17 23:56:52 +00001280 // we allow macros that expand to nothing after the filename, because this
1281 // falls into the category of "#include pp-tokens new-line" specified in
1282 // C99 6.10.2p4.
Daniel Dunbare013d682009-10-18 20:26:12 +00001283 CheckEndOfDirective(IncludeTok.getIdentifierInfo()->getNameStart(), true);
Chris Lattner141e71f2008-03-09 01:54:53 +00001284
1285 // Check that we don't have infinite #include recursion.
Chris Lattner3692b092008-11-18 07:59:24 +00001286 if (IncludeMacroStack.size() == MaxAllowedIncludeStackDepth-1) {
1287 Diag(FilenameTok, diag::err_pp_include_too_deep);
1288 return;
1289 }
Mike Stump1eb44332009-09-09 15:08:12 +00001290
John McCall8dfac0b2011-09-30 05:12:12 +00001291 // Complain about attempts to #include files in an audit pragma.
1292 if (PragmaARCCFCodeAuditedLoc.isValid()) {
1293 Diag(HashLoc, diag::err_pp_include_in_arc_cf_code_audited);
1294 Diag(PragmaARCCFCodeAuditedLoc, diag::note_pragma_entered_here);
1295
1296 // Immediately leave the pragma.
1297 PragmaARCCFCodeAuditedLoc = SourceLocation();
1298 }
1299
Chris Lattner141e71f2008-03-09 01:54:53 +00001300 // Search include directories.
1301 const DirectoryLookup *CurDir;
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001302 SmallString<1024> SearchPath;
1303 SmallString<1024> RelativePath;
Chandler Carruthb5142bb2011-03-16 18:34:36 +00001304 // We get the raw path only if we have 'Callbacks' to which we later pass
1305 // the path.
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001306 Module *SuggestedModule = 0;
Chandler Carruthb5142bb2011-03-16 18:34:36 +00001307 const FileEntry *File = LookupFile(
Manuel Klimek74124942011-04-26 21:50:03 +00001308 Filename, isAngled, LookupFrom, CurDir,
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001309 Callbacks ? &SearchPath : NULL, Callbacks ? &RelativePath : NULL,
Douglas Gregor752c74d2012-01-03 17:07:34 +00001310 getLangOptions().Modules? &SuggestedModule : 0);
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001311
Douglas Gregor8cfbe6a2011-11-30 18:12:06 +00001312 if (Callbacks) {
1313 if (!File) {
1314 // Give the clients a chance to recover.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001315 SmallString<128> RecoveryPath;
Douglas Gregor8cfbe6a2011-11-30 18:12:06 +00001316 if (Callbacks->FileNotFound(Filename, RecoveryPath)) {
1317 if (const DirectoryEntry *DE = FileMgr.getDirectory(RecoveryPath)) {
1318 // Add the recovery path to the list of search paths.
1319 DirectoryLookup DL(DE, SrcMgr::C_User, true, false);
1320 HeaderInfo.AddSearchPath(DL, isAngled);
1321
1322 // Try the lookup again, skipping the cache.
1323 File = LookupFile(Filename, isAngled, LookupFrom, CurDir, 0, 0,
Douglas Gregor752c74d2012-01-03 17:07:34 +00001324 getLangOptions().Modules? &SuggestedModule : 0,
Douglas Gregor8cfbe6a2011-11-30 18:12:06 +00001325 /*SkipCache*/true);
1326 }
1327 }
1328 }
1329
1330 // Notify the callback object that we've seen an inclusion directive.
1331 Callbacks->InclusionDirective(HashLoc, IncludeTok, Filename, isAngled, File,
1332 End, SearchPath, RelativePath);
1333 }
1334
1335 if (File == 0) {
1336 if (!SuppressIncludeNotFoundError)
1337 Diag(FilenameTok, diag::err_pp_file_not_found) << Filename;
1338 return;
1339 }
1340
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001341 // If we are supposed to import a module rather than including the header,
1342 // do so now.
Douglas Gregorc69c42e2011-11-17 22:44:56 +00001343 if (SuggestedModule) {
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001344 // Compute the module access path corresponding to this module.
1345 // FIXME: Should we have a second loadModule() overload to avoid this
1346 // extra lookup step?
1347 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001348 for (Module *Mod = SuggestedModule; Mod; Mod = Mod->Parent)
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001349 Path.push_back(std::make_pair(getIdentifierInfo(Mod->Name),
1350 FilenameTok.getLocation()));
1351 std::reverse(Path.begin(), Path.end());
1352
Douglas Gregore3a82562011-11-30 18:02:36 +00001353 // Warn that we're replacing the include/import with a module import.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001354 SmallString<128> PathString;
Douglas Gregore3a82562011-11-30 18:02:36 +00001355 for (unsigned I = 0, N = Path.size(); I != N; ++I) {
1356 if (I)
1357 PathString += '.';
1358 PathString += Path[I].first->getName();
1359 }
1360 int IncludeKind = 0;
1361
1362 switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) {
1363 case tok::pp_include:
1364 IncludeKind = 0;
1365 break;
1366
1367 case tok::pp_import:
1368 IncludeKind = 1;
1369 break;
1370
Douglas Gregoredee9692011-11-30 18:03:26 +00001371 case tok::pp_include_next:
1372 IncludeKind = 2;
1373 break;
Douglas Gregore3a82562011-11-30 18:02:36 +00001374
1375 case tok::pp___include_macros:
1376 IncludeKind = 3;
1377 break;
1378
1379 default:
1380 llvm_unreachable("unknown include directive kind");
Douglas Gregore3a82562011-11-30 18:02:36 +00001381 }
1382
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001383 // Determine whether we are actually building the module that this
1384 // include directive maps to.
1385 bool BuildingImportedModule
1386 = Path[0].first->getName() == getLangOptions().CurrentModule;
1387
Douglas Gregorc13a34b2012-01-03 19:32:59 +00001388 if (!BuildingImportedModule && getLangOptions().ObjC2) {
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001389 // If we're not building the imported module, warn that we're going
1390 // to automatically turn this inclusion directive into a module import.
Douglas Gregorc13a34b2012-01-03 19:32:59 +00001391 // We only do this in Objective-C, where we have a module-import syntax.
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001392 CharSourceRange ReplaceRange(SourceRange(HashLoc, CharEnd),
1393 /*IsTokenRange=*/false);
1394 Diag(HashLoc, diag::warn_auto_module_import)
1395 << IncludeKind << PathString
1396 << FixItHint::CreateReplacement(ReplaceRange,
Douglas Gregorc13a34b2012-01-03 19:32:59 +00001397 "@import " + PathString.str().str() + ";");
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001398 }
Douglas Gregore3a82562011-11-30 18:02:36 +00001399
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001400 // Load the module.
Douglas Gregor5e356932011-12-01 17:11:21 +00001401 // If this was an #__include_macros directive, only make macros visible.
1402 Module::NameVisibilityKind Visibility
1403 = (IncludeKind == 3)? Module::MacrosVisible : Module::AllVisible;
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001404 Module *Imported
1405 = TheModuleLoader.loadModule(IncludeTok.getLocation(), Path, Visibility,
1406 /*IsIncludeDirective=*/true);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001407
1408 // If this header isn't part of the module we're building, we're done.
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001409 if (!BuildingImportedModule && Imported)
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001410 return;
Douglas Gregorfba18aa2011-09-15 22:00:41 +00001411 }
1412
Chris Lattner72181832008-09-26 20:12:23 +00001413 // The #included file will be considered to be a system header if either it is
1414 // in a system include directory, or if the #includer is a system include
1415 // header.
Mike Stump1eb44332009-09-09 15:08:12 +00001416 SrcMgr::CharacteristicKind FileCharacter =
Chris Lattner0b9e7362008-09-26 21:18:42 +00001417 std::max(HeaderInfo.getFileDirFlavor(File),
Chris Lattner693faa62009-01-19 07:59:15 +00001418 SourceMgr.getFileCharacteristic(FilenameTok.getLocation()));
Mike Stump1eb44332009-09-09 15:08:12 +00001419
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001420 // Ask HeaderInfo if we should enter this #include file. If not, #including
1421 // this file will have no effect.
1422 if (!HeaderInfo.ShouldEnterIncludeFile(File, isImport)) {
Chris Lattnere127a0d2010-04-20 20:35:58 +00001423 if (Callbacks)
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001424 Callbacks->FileSkipped(*File, FilenameTok, FileCharacter);
Chris Lattner6fbe3eb2010-04-19 20:44:31 +00001425 return;
1426 }
1427
Chris Lattner141e71f2008-03-09 01:54:53 +00001428 // Look up the file, create a File ID for it.
Chris Lattner2b2453a2009-01-17 06:22:33 +00001429 FileID FID = SourceMgr.createFileID(File, FilenameTok.getLocation(),
1430 FileCharacter);
Peter Collingbourned57b7ff2011-06-30 16:41:03 +00001431 assert(!FID.isInvalid() && "Expected valid file ID");
Chris Lattner141e71f2008-03-09 01:54:53 +00001432
1433 // Finally, if all is good, enter the new file!
Chris Lattnere127a0d2010-04-20 20:35:58 +00001434 EnterSourceFile(FID, CurDir, FilenameTok.getLocation());
Chris Lattner141e71f2008-03-09 01:54:53 +00001435}
1436
1437/// HandleIncludeNextDirective - Implements #include_next.
1438///
Douglas Gregorecdcb882010-10-20 22:00:55 +00001439void Preprocessor::HandleIncludeNextDirective(SourceLocation HashLoc,
1440 Token &IncludeNextTok) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001441 Diag(IncludeNextTok, diag::ext_pp_include_next_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001442
Chris Lattner141e71f2008-03-09 01:54:53 +00001443 // #include_next is like #include, except that we start searching after
1444 // the current found directory. If we can't do this, issue a
1445 // diagnostic.
1446 const DirectoryLookup *Lookup = CurDirLookup;
1447 if (isInPrimaryFile()) {
1448 Lookup = 0;
1449 Diag(IncludeNextTok, diag::pp_include_next_in_primary);
1450 } else if (Lookup == 0) {
1451 Diag(IncludeNextTok, diag::pp_include_next_absolute_path);
1452 } else {
1453 // Start looking up in the next directory.
1454 ++Lookup;
1455 }
Mike Stump1eb44332009-09-09 15:08:12 +00001456
Douglas Gregorecdcb882010-10-20 22:00:55 +00001457 return HandleIncludeDirective(HashLoc, IncludeNextTok, Lookup);
Chris Lattner141e71f2008-03-09 01:54:53 +00001458}
1459
1460/// HandleImportDirective - Implements #import.
1461///
Douglas Gregorecdcb882010-10-20 22:00:55 +00001462void Preprocessor::HandleImportDirective(SourceLocation HashLoc,
1463 Token &ImportTok) {
Chris Lattnerb627c8d2009-03-06 04:28:03 +00001464 if (!Features.ObjC1) // #import is standard for ObjC.
1465 Diag(ImportTok, diag::ext_pp_import_directive);
Mike Stump1eb44332009-09-09 15:08:12 +00001466
Douglas Gregorecdcb882010-10-20 22:00:55 +00001467 return HandleIncludeDirective(HashLoc, ImportTok, 0, true);
Chris Lattner141e71f2008-03-09 01:54:53 +00001468}
1469
Chris Lattnerde076652009-04-08 18:46:40 +00001470/// HandleIncludeMacrosDirective - The -imacros command line option turns into a
1471/// pseudo directive in the predefines buffer. This handles it by sucking all
1472/// tokens through the preprocessor and discarding them (only keeping the side
1473/// effects on the preprocessor).
Douglas Gregorecdcb882010-10-20 22:00:55 +00001474void Preprocessor::HandleIncludeMacrosDirective(SourceLocation HashLoc,
1475 Token &IncludeMacrosTok) {
Chris Lattnerde076652009-04-08 18:46:40 +00001476 // This directive should only occur in the predefines buffer. If not, emit an
1477 // error and reject it.
1478 SourceLocation Loc = IncludeMacrosTok.getLocation();
1479 if (strcmp(SourceMgr.getBufferName(Loc), "<built-in>") != 0) {
1480 Diag(IncludeMacrosTok.getLocation(),
1481 diag::pp_include_macros_out_of_predefines);
1482 DiscardUntilEndOfDirective();
1483 return;
1484 }
Mike Stump1eb44332009-09-09 15:08:12 +00001485
Chris Lattnerfd105112009-04-08 20:53:24 +00001486 // Treat this as a normal #include for checking purposes. If this is
1487 // successful, it will push a new lexer onto the include stack.
Douglas Gregorecdcb882010-10-20 22:00:55 +00001488 HandleIncludeDirective(HashLoc, IncludeMacrosTok, 0, false);
Mike Stump1eb44332009-09-09 15:08:12 +00001489
Chris Lattnerfd105112009-04-08 20:53:24 +00001490 Token TmpTok;
1491 do {
1492 Lex(TmpTok);
1493 assert(TmpTok.isNot(tok::eof) && "Didn't find end of -imacros!");
1494 } while (TmpTok.isNot(tok::hashhash));
Chris Lattnerde076652009-04-08 18:46:40 +00001495}
1496
Chris Lattner141e71f2008-03-09 01:54:53 +00001497//===----------------------------------------------------------------------===//
1498// Preprocessor Macro Directive Handling.
1499//===----------------------------------------------------------------------===//
1500
1501/// ReadMacroDefinitionArgList - The ( starting an argument list of a macro
1502/// definition has just been read. Lex the rest of the arguments and the
1503/// closing ), updating MI with what we learn. Return true if an error occurs
1504/// parsing the arg list.
1505bool Preprocessor::ReadMacroDefinitionArgList(MacroInfo *MI) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001506 SmallVector<IdentifierInfo*, 32> Arguments;
Mike Stump1eb44332009-09-09 15:08:12 +00001507
Chris Lattner141e71f2008-03-09 01:54:53 +00001508 Token Tok;
1509 while (1) {
1510 LexUnexpandedToken(Tok);
1511 switch (Tok.getKind()) {
1512 case tok::r_paren:
1513 // Found the end of the argument list.
Chris Lattnercf29e072009-02-20 22:31:31 +00001514 if (Arguments.empty()) // #define FOO()
Chris Lattner141e71f2008-03-09 01:54:53 +00001515 return false;
Chris Lattner141e71f2008-03-09 01:54:53 +00001516 // Otherwise we have #define FOO(A,)
1517 Diag(Tok, diag::err_pp_expected_ident_in_arg_list);
1518 return true;
1519 case tok::ellipsis: // #define X(... -> C99 varargs
Richard Smith661a9962011-10-15 01:18:56 +00001520 if (!Features.C99)
1521 Diag(Tok, Features.CPlusPlus0x ?
1522 diag::warn_cxx98_compat_variadic_macro :
1523 diag::ext_variadic_macro);
Chris Lattner141e71f2008-03-09 01:54:53 +00001524
1525 // Lex the token after the identifier.
1526 LexUnexpandedToken(Tok);
1527 if (Tok.isNot(tok::r_paren)) {
1528 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1529 return true;
1530 }
1531 // Add the __VA_ARGS__ identifier as an argument.
1532 Arguments.push_back(Ident__VA_ARGS__);
1533 MI->setIsC99Varargs();
Chris Lattner685befe2009-02-20 22:46:43 +00001534 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001535 return false;
Peter Collingbourne84021552011-02-28 02:37:51 +00001536 case tok::eod: // #define X(
Chris Lattner141e71f2008-03-09 01:54:53 +00001537 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1538 return true;
1539 default:
1540 // Handle keywords and identifiers here to accept things like
1541 // #define Foo(for) for.
1542 IdentifierInfo *II = Tok.getIdentifierInfo();
1543 if (II == 0) {
1544 // #define X(1
1545 Diag(Tok, diag::err_pp_invalid_tok_in_arg_list);
1546 return true;
1547 }
1548
1549 // If this is already used as an argument, it is used multiple times (e.g.
1550 // #define X(A,A.
Mike Stump1eb44332009-09-09 15:08:12 +00001551 if (std::find(Arguments.begin(), Arguments.end(), II) !=
Chris Lattner141e71f2008-03-09 01:54:53 +00001552 Arguments.end()) { // C99 6.10.3p6
Chris Lattner6cf3ed72008-11-19 07:33:58 +00001553 Diag(Tok, diag::err_pp_duplicate_name_in_arg_list) << II;
Chris Lattner141e71f2008-03-09 01:54:53 +00001554 return true;
1555 }
Mike Stump1eb44332009-09-09 15:08:12 +00001556
Chris Lattner141e71f2008-03-09 01:54:53 +00001557 // Add the argument to the macro info.
1558 Arguments.push_back(II);
Mike Stump1eb44332009-09-09 15:08:12 +00001559
Chris Lattner141e71f2008-03-09 01:54:53 +00001560 // Lex the token after the identifier.
1561 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001562
Chris Lattner141e71f2008-03-09 01:54:53 +00001563 switch (Tok.getKind()) {
1564 default: // #define X(A B
1565 Diag(Tok, diag::err_pp_expected_comma_in_arg_list);
1566 return true;
1567 case tok::r_paren: // #define X(A)
Chris Lattner685befe2009-02-20 22:46:43 +00001568 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001569 return false;
1570 case tok::comma: // #define X(A,
1571 break;
1572 case tok::ellipsis: // #define X(A... -> GCC extension
1573 // Diagnose extension.
1574 Diag(Tok, diag::ext_named_variadic_macro);
Mike Stump1eb44332009-09-09 15:08:12 +00001575
Chris Lattner141e71f2008-03-09 01:54:53 +00001576 // Lex the token after the identifier.
1577 LexUnexpandedToken(Tok);
1578 if (Tok.isNot(tok::r_paren)) {
1579 Diag(Tok, diag::err_pp_missing_rparen_in_macro_def);
1580 return true;
1581 }
Mike Stump1eb44332009-09-09 15:08:12 +00001582
Chris Lattner141e71f2008-03-09 01:54:53 +00001583 MI->setIsGNUVarargs();
Chris Lattner685befe2009-02-20 22:46:43 +00001584 MI->setArgumentList(&Arguments[0], Arguments.size(), BP);
Chris Lattner141e71f2008-03-09 01:54:53 +00001585 return false;
1586 }
1587 }
1588 }
1589}
1590
1591/// HandleDefineDirective - Implements #define. This consumes the entire macro
1592/// line then lets the caller lex the next real token.
1593void Preprocessor::HandleDefineDirective(Token &DefineTok) {
1594 ++NumDefined;
1595
1596 Token MacroNameTok;
1597 ReadMacroName(MacroNameTok, 1);
Mike Stump1eb44332009-09-09 15:08:12 +00001598
Chris Lattner141e71f2008-03-09 01:54:53 +00001599 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001600 if (MacroNameTok.is(tok::eod))
Chris Lattner141e71f2008-03-09 01:54:53 +00001601 return;
1602
Chris Lattner2451b522009-04-21 04:46:33 +00001603 Token LastTok = MacroNameTok;
1604
Chris Lattner141e71f2008-03-09 01:54:53 +00001605 // If we are supposed to keep comments in #defines, reenable comment saving
1606 // mode.
Ted Kremenekac6b06d2008-11-18 00:43:07 +00001607 if (CurLexer) CurLexer->SetCommentRetentionState(KeepMacroComments);
Mike Stump1eb44332009-09-09 15:08:12 +00001608
Chris Lattner141e71f2008-03-09 01:54:53 +00001609 // Create the new macro.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001610 MacroInfo *MI = AllocateMacroInfo(MacroNameTok.getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001611
Chris Lattner141e71f2008-03-09 01:54:53 +00001612 Token Tok;
1613 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001614
Chris Lattner141e71f2008-03-09 01:54:53 +00001615 // If this is a function-like macro definition, parse the argument list,
1616 // marking each of the identifiers as being used as macro arguments. Also,
1617 // check other constraints on the first token of the macro body.
Peter Collingbourne84021552011-02-28 02:37:51 +00001618 if (Tok.is(tok::eod)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001619 // If there is no body to this macro, we have no special handling here.
Chris Lattner6272bcf2009-04-18 02:23:25 +00001620 } else if (Tok.hasLeadingSpace()) {
1621 // This is a normal token with leading space. Clear the leading space
1622 // marker on the first token to get proper expansion.
1623 Tok.clearFlag(Token::LeadingSpace);
1624 } else if (Tok.is(tok::l_paren)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001625 // This is a function-like macro definition. Read the argument list.
1626 MI->setIsFunctionLike();
1627 if (ReadMacroDefinitionArgList(MI)) {
1628 // Forget about MI.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001629 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001630 // Throw away the rest of the line.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001631 if (CurPPLexer->ParsingPreprocessorDirective)
Chris Lattner141e71f2008-03-09 01:54:53 +00001632 DiscardUntilEndOfDirective();
1633 return;
1634 }
1635
Chris Lattner8fde5972009-04-19 18:26:34 +00001636 // If this is a definition of a variadic C99 function-like macro, not using
1637 // the GNU named varargs extension, enabled __VA_ARGS__.
Mike Stump1eb44332009-09-09 15:08:12 +00001638
Chris Lattner8fde5972009-04-19 18:26:34 +00001639 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
1640 // This gets unpoisoned where it is allowed.
1641 assert(Ident__VA_ARGS__->isPoisoned() && "__VA_ARGS__ should be poisoned!");
1642 if (MI->isC99Varargs())
1643 Ident__VA_ARGS__->setIsPoisoned(false);
Mike Stump1eb44332009-09-09 15:08:12 +00001644
Chris Lattner141e71f2008-03-09 01:54:53 +00001645 // Read the first token after the arg list for down below.
1646 LexUnexpandedToken(Tok);
Eli Friedman158ebfb2011-10-10 23:35:28 +00001647 } else if (Features.C99 || Features.CPlusPlus0x) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001648 // C99 requires whitespace between the macro definition and the body. Emit
1649 // a diagnostic for something like "#define X+".
Chris Lattner6272bcf2009-04-18 02:23:25 +00001650 Diag(Tok, diag::ext_c99_whitespace_required_after_macro_name);
Chris Lattner141e71f2008-03-09 01:54:53 +00001651 } else {
Chris Lattner6272bcf2009-04-18 02:23:25 +00001652 // C90 6.8 TC1 says: "In the definition of an object-like macro, if the
1653 // first character of a replacement list is not a character required by
1654 // subclause 5.2.1, then there shall be white-space separation between the
1655 // identifier and the replacement list.". 5.2.1 lists this set:
1656 // "A-Za-z0-9!"#%&'()*+,_./:;<=>?[\]^_{|}~" as well as whitespace, which
1657 // is irrelevant here.
1658 bool isInvalid = false;
1659 if (Tok.is(tok::at)) // @ is not in the list above.
1660 isInvalid = true;
1661 else if (Tok.is(tok::unknown)) {
1662 // If we have an unknown token, it is something strange like "`". Since
1663 // all of valid characters would have lexed into a single character
1664 // token of some sort, we know this is not a valid case.
1665 isInvalid = true;
1666 }
1667 if (isInvalid)
1668 Diag(Tok, diag::ext_missing_whitespace_after_macro_name);
1669 else
1670 Diag(Tok, diag::warn_missing_whitespace_after_macro_name);
Chris Lattner141e71f2008-03-09 01:54:53 +00001671 }
Chris Lattner2451b522009-04-21 04:46:33 +00001672
Peter Collingbourne84021552011-02-28 02:37:51 +00001673 if (!Tok.is(tok::eod))
Chris Lattner2451b522009-04-21 04:46:33 +00001674 LastTok = Tok;
1675
Chris Lattner141e71f2008-03-09 01:54:53 +00001676 // Read the rest of the macro body.
1677 if (MI->isObjectLike()) {
1678 // Object-like macros are very simple, just read their body.
Peter Collingbourne84021552011-02-28 02:37:51 +00001679 while (Tok.isNot(tok::eod)) {
Chris Lattner2451b522009-04-21 04:46:33 +00001680 LastTok = Tok;
Chris Lattner141e71f2008-03-09 01:54:53 +00001681 MI->AddTokenToBody(Tok);
1682 // Get the next token of the macro.
1683 LexUnexpandedToken(Tok);
1684 }
Mike Stump1eb44332009-09-09 15:08:12 +00001685
Chris Lattner141e71f2008-03-09 01:54:53 +00001686 } else {
Chris Lattner32404692009-05-25 17:16:10 +00001687 // Otherwise, read the body of a function-like macro. While we are at it,
1688 // check C99 6.10.3.2p1: ensure that # operators are followed by macro
1689 // parameters in function-like macro expansions.
Peter Collingbourne84021552011-02-28 02:37:51 +00001690 while (Tok.isNot(tok::eod)) {
Chris Lattner2451b522009-04-21 04:46:33 +00001691 LastTok = Tok;
Chris Lattner141e71f2008-03-09 01:54:53 +00001692
Chris Lattner141e71f2008-03-09 01:54:53 +00001693 if (Tok.isNot(tok::hash)) {
Chris Lattner32404692009-05-25 17:16:10 +00001694 MI->AddTokenToBody(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001695
Chris Lattner141e71f2008-03-09 01:54:53 +00001696 // Get the next token of the macro.
1697 LexUnexpandedToken(Tok);
1698 continue;
1699 }
Mike Stump1eb44332009-09-09 15:08:12 +00001700
Chris Lattner141e71f2008-03-09 01:54:53 +00001701 // Get the next token of the macro.
1702 LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00001703
Chris Lattner32404692009-05-25 17:16:10 +00001704 // Check for a valid macro arg identifier.
1705 if (Tok.getIdentifierInfo() == 0 ||
1706 MI->getArgumentNum(Tok.getIdentifierInfo()) == -1) {
1707
1708 // If this is assembler-with-cpp mode, we accept random gibberish after
1709 // the '#' because '#' is often a comment character. However, change
1710 // the kind of the token to tok::unknown so that the preprocessor isn't
1711 // confused.
Peter Collingbourne84021552011-02-28 02:37:51 +00001712 if (getLangOptions().AsmPreprocessor && Tok.isNot(tok::eod)) {
Chris Lattner32404692009-05-25 17:16:10 +00001713 LastTok.setKind(tok::unknown);
1714 } else {
1715 Diag(Tok, diag::err_pp_stringize_not_parameter);
1716 ReleaseMacroInfo(MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001717
Chris Lattner32404692009-05-25 17:16:10 +00001718 // Disable __VA_ARGS__ again.
1719 Ident__VA_ARGS__->setIsPoisoned(true);
1720 return;
1721 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001722 }
Mike Stump1eb44332009-09-09 15:08:12 +00001723
Chris Lattner32404692009-05-25 17:16:10 +00001724 // Things look ok, add the '#' and param name tokens to the macro.
1725 MI->AddTokenToBody(LastTok);
Chris Lattner141e71f2008-03-09 01:54:53 +00001726 MI->AddTokenToBody(Tok);
Chris Lattner32404692009-05-25 17:16:10 +00001727 LastTok = Tok;
Mike Stump1eb44332009-09-09 15:08:12 +00001728
Chris Lattner141e71f2008-03-09 01:54:53 +00001729 // Get the next token of the macro.
1730 LexUnexpandedToken(Tok);
1731 }
1732 }
Mike Stump1eb44332009-09-09 15:08:12 +00001733
1734
Chris Lattner141e71f2008-03-09 01:54:53 +00001735 // Disable __VA_ARGS__ again.
1736 Ident__VA_ARGS__->setIsPoisoned(true);
1737
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00001738 // Check that there is no paste (##) operator at the beginning or end of the
Chris Lattner141e71f2008-03-09 01:54:53 +00001739 // replacement list.
1740 unsigned NumTokens = MI->getNumTokens();
1741 if (NumTokens != 0) {
1742 if (MI->getReplacementToken(0).is(tok::hashhash)) {
1743 Diag(MI->getReplacementToken(0), diag::err_paste_at_start);
Ted Kremenek0ea76722008-12-15 19:56:42 +00001744 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001745 return;
1746 }
1747 if (MI->getReplacementToken(NumTokens-1).is(tok::hashhash)) {
1748 Diag(MI->getReplacementToken(NumTokens-1), diag::err_paste_at_end);
Ted Kremenek0ea76722008-12-15 19:56:42 +00001749 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001750 return;
1751 }
1752 }
Mike Stump1eb44332009-09-09 15:08:12 +00001753
Chris Lattner2451b522009-04-21 04:46:33 +00001754 MI->setDefinitionEndLoc(LastTok.getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001755
Chris Lattner141e71f2008-03-09 01:54:53 +00001756 // Finally, if this identifier already had a macro defined for it, verify that
1757 // the macro bodies are identical and free the old definition.
1758 if (MacroInfo *OtherMI = getMacroInfo(MacroNameTok.getIdentifierInfo())) {
Chris Lattner41c3ae12009-01-16 19:50:11 +00001759 // It is very common for system headers to have tons of macro redefinitions
1760 // and for warnings to be disabled in system headers. If this is the case,
1761 // then don't bother calling MacroInfo::isIdenticalTo.
Chris Lattner7f549df2009-03-13 21:17:23 +00001762 if (!getDiagnostics().getSuppressSystemWarnings() ||
Chris Lattner41c3ae12009-01-16 19:50:11 +00001763 !SourceMgr.isInSystemHeader(DefineTok.getLocation())) {
Argyrios Kyrtzidisa33e0502011-01-18 19:50:15 +00001764 if (!OtherMI->isUsed() && OtherMI->isWarnIfUnused())
Chris Lattner41c3ae12009-01-16 19:50:11 +00001765 Diag(OtherMI->getDefinitionLoc(), diag::pp_macro_not_used);
Chris Lattner141e71f2008-03-09 01:54:53 +00001766
Chris Lattnerf47724b2010-08-17 15:55:45 +00001767 // Macros must be identical. This means all tokens and whitespace
Chris Lattner41c3ae12009-01-16 19:50:11 +00001768 // separation must be the same. C99 6.10.3.2.
Chris Lattnerf47724b2010-08-17 15:55:45 +00001769 if (!OtherMI->isAllowRedefinitionsWithoutWarning() &&
Eli Friedmana7e68452010-08-22 01:00:03 +00001770 !MI->isIdenticalTo(*OtherMI, *this)) {
Chris Lattner41c3ae12009-01-16 19:50:11 +00001771 Diag(MI->getDefinitionLoc(), diag::ext_pp_macro_redef)
1772 << MacroNameTok.getIdentifierInfo();
1773 Diag(OtherMI->getDefinitionLoc(), diag::note_previous_definition);
1774 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001775 }
Argyrios Kyrtzidisa33e0502011-01-18 19:50:15 +00001776 if (OtherMI->isWarnIfUnused())
1777 WarnUnusedMacroLocs.erase(OtherMI->getDefinitionLoc());
Ted Kremenek0ea76722008-12-15 19:56:42 +00001778 ReleaseMacroInfo(OtherMI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001779 }
Mike Stump1eb44332009-09-09 15:08:12 +00001780
Chris Lattner141e71f2008-03-09 01:54:53 +00001781 setMacroInfo(MacroNameTok.getIdentifierInfo(), MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001782
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001783 assert(!MI->isUsed());
1784 // If we need warning for not using the macro, add its location in the
1785 // warn-because-unused-macro set. If it gets used it will be removed from set.
1786 if (isInPrimaryFile() && // don't warn for include'd macros.
1787 Diags->getDiagnosticLevel(diag::pp_macro_not_used,
David Blaikied6471f72011-09-25 23:23:43 +00001788 MI->getDefinitionLoc()) != DiagnosticsEngine::Ignored) {
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001789 MI->setIsWarnIfUnused(true);
1790 WarnUnusedMacroLocs.insert(MI->getDefinitionLoc());
1791 }
1792
Chris Lattnerf4a72b02009-04-12 01:39:54 +00001793 // If the callbacks want to know, tell them about the macro definition.
1794 if (Callbacks)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001795 Callbacks->MacroDefined(MacroNameTok, MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001796}
1797
1798/// HandleUndefDirective - Implements #undef.
1799///
1800void Preprocessor::HandleUndefDirective(Token &UndefTok) {
1801 ++NumUndefined;
1802
1803 Token MacroNameTok;
1804 ReadMacroName(MacroNameTok, 2);
Mike Stump1eb44332009-09-09 15:08:12 +00001805
Chris Lattner141e71f2008-03-09 01:54:53 +00001806 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001807 if (MacroNameTok.is(tok::eod))
Chris Lattner141e71f2008-03-09 01:54:53 +00001808 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001809
Chris Lattner141e71f2008-03-09 01:54:53 +00001810 // Check to see if this is the last token on the #undef line.
Chris Lattner35410d52009-04-14 05:07:49 +00001811 CheckEndOfDirective("undef");
Mike Stump1eb44332009-09-09 15:08:12 +00001812
Chris Lattner141e71f2008-03-09 01:54:53 +00001813 // Okay, we finally have a valid identifier to undef.
1814 MacroInfo *MI = getMacroInfo(MacroNameTok.getIdentifierInfo());
Mike Stump1eb44332009-09-09 15:08:12 +00001815
Chris Lattner141e71f2008-03-09 01:54:53 +00001816 // If the macro is not defined, this is a noop undef, just return.
1817 if (MI == 0) return;
1818
Argyrios Kyrtzidis1f8dcfc2011-07-11 20:39:47 +00001819 if (!MI->isUsed() && MI->isWarnIfUnused())
Chris Lattner141e71f2008-03-09 01:54:53 +00001820 Diag(MI->getDefinitionLoc(), diag::pp_macro_not_used);
Chris Lattner41c17472009-04-21 03:42:09 +00001821
1822 // If the callbacks want to know, tell them about the macro #undef.
1823 if (Callbacks)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001824 Callbacks->MacroUndefined(MacroNameTok, MI);
Chris Lattner41c17472009-04-21 03:42:09 +00001825
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001826 if (MI->isWarnIfUnused())
1827 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc());
1828
Chris Lattner141e71f2008-03-09 01:54:53 +00001829 // Free macro definition.
Ted Kremenek0ea76722008-12-15 19:56:42 +00001830 ReleaseMacroInfo(MI);
Chris Lattner141e71f2008-03-09 01:54:53 +00001831 setMacroInfo(MacroNameTok.getIdentifierInfo(), 0);
1832}
1833
1834
1835//===----------------------------------------------------------------------===//
1836// Preprocessor Conditional Directive Handling.
1837//===----------------------------------------------------------------------===//
1838
1839/// HandleIfdefDirective - Implements the #ifdef/#ifndef directive. isIfndef is
1840/// true when this is a #ifndef directive. ReadAnyTokensBeforeDirective is true
1841/// if any tokens have been returned or pp-directives activated before this
1842/// #ifndef has been lexed.
1843///
1844void Preprocessor::HandleIfdefDirective(Token &Result, bool isIfndef,
1845 bool ReadAnyTokensBeforeDirective) {
1846 ++NumIf;
1847 Token DirectiveTok = Result;
1848
1849 Token MacroNameTok;
1850 ReadMacroName(MacroNameTok);
Mike Stump1eb44332009-09-09 15:08:12 +00001851
Chris Lattner141e71f2008-03-09 01:54:53 +00001852 // Error reading macro name? If so, diagnostic already issued.
Peter Collingbourne84021552011-02-28 02:37:51 +00001853 if (MacroNameTok.is(tok::eod)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001854 // Skip code until we get to #endif. This helps with recovery by not
1855 // emitting an error when the #endif is reached.
1856 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
1857 /*Foundnonskip*/false, /*FoundElse*/false);
1858 return;
1859 }
Mike Stump1eb44332009-09-09 15:08:12 +00001860
Chris Lattner141e71f2008-03-09 01:54:53 +00001861 // Check to see if this is the last token on the #if[n]def line.
Chris Lattner35410d52009-04-14 05:07:49 +00001862 CheckEndOfDirective(isIfndef ? "ifndef" : "ifdef");
Chris Lattner141e71f2008-03-09 01:54:53 +00001863
Chris Lattner13d283d2010-02-12 08:03:27 +00001864 IdentifierInfo *MII = MacroNameTok.getIdentifierInfo();
1865 MacroInfo *MI = getMacroInfo(MII);
Kovarththanan Rajaratnam19357542010-03-13 10:17:05 +00001866
Ted Kremenek60e45d42008-11-18 00:34:22 +00001867 if (CurPPLexer->getConditionalStackDepth() == 0) {
Chris Lattner13d283d2010-02-12 08:03:27 +00001868 // If the start of a top-level #ifdef and if the macro is not defined,
1869 // inform MIOpt that this might be the start of a proper include guard.
1870 // Otherwise it is some other form of unknown conditional which we can't
1871 // handle.
1872 if (!ReadAnyTokensBeforeDirective && MI == 0) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001873 assert(isIfndef && "#ifdef shouldn't reach here");
Chris Lattner13d283d2010-02-12 08:03:27 +00001874 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(MII);
Chris Lattner141e71f2008-03-09 01:54:53 +00001875 } else
Ted Kremenek60e45d42008-11-18 00:34:22 +00001876 CurPPLexer->MIOpt.EnterTopLevelConditional();
Chris Lattner141e71f2008-03-09 01:54:53 +00001877 }
1878
Chris Lattner141e71f2008-03-09 01:54:53 +00001879 // If there is a macro, process it.
1880 if (MI) // Mark it used.
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +00001881 markMacroAsUsed(MI);
Mike Stump1eb44332009-09-09 15:08:12 +00001882
Chris Lattner141e71f2008-03-09 01:54:53 +00001883 // Should we include the stuff contained by this directive?
1884 if (!MI == isIfndef) {
1885 // Yes, remember that we are inside a conditional, then lex the next token.
Chris Lattner1d9c54d2009-12-14 04:54:40 +00001886 CurPPLexer->pushConditionalLevel(DirectiveTok.getLocation(),
1887 /*wasskip*/false, /*foundnonskip*/true,
1888 /*foundelse*/false);
Chris Lattner141e71f2008-03-09 01:54:53 +00001889 } else {
Craig Silverstein08985b92010-11-06 01:19:03 +00001890 // No, skip the contents of this block.
Chris Lattner141e71f2008-03-09 01:54:53 +00001891 SkipExcludedConditionalBlock(DirectiveTok.getLocation(),
Mike Stump1eb44332009-09-09 15:08:12 +00001892 /*Foundnonskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001893 /*FoundElse*/false);
1894 }
Craig Silverstein08985b92010-11-06 01:19:03 +00001895
1896 if (Callbacks) {
1897 if (isIfndef)
Craig Silverstein2aa92672010-11-19 21:33:15 +00001898 Callbacks->Ifndef(MacroNameTok);
Craig Silverstein08985b92010-11-06 01:19:03 +00001899 else
Craig Silverstein2aa92672010-11-19 21:33:15 +00001900 Callbacks->Ifdef(MacroNameTok);
Craig Silverstein08985b92010-11-06 01:19:03 +00001901 }
Chris Lattner141e71f2008-03-09 01:54:53 +00001902}
1903
1904/// HandleIfDirective - Implements the #if directive.
1905///
1906void Preprocessor::HandleIfDirective(Token &IfToken,
1907 bool ReadAnyTokensBeforeDirective) {
1908 ++NumIf;
Mike Stump1eb44332009-09-09 15:08:12 +00001909
Craig Silverstein08985b92010-11-06 01:19:03 +00001910 // Parse and evaluate the conditional expression.
Chris Lattner141e71f2008-03-09 01:54:53 +00001911 IdentifierInfo *IfNDefMacro = 0;
Craig Silverstein08985b92010-11-06 01:19:03 +00001912 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
1913 const bool ConditionalTrue = EvaluateDirectiveExpression(IfNDefMacro);
1914 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
Nuno Lopes0049db62008-06-01 18:31:24 +00001915
1916 // If this condition is equivalent to #ifndef X, and if this is the first
1917 // directive seen, handle it for the multiple-include optimization.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001918 if (CurPPLexer->getConditionalStackDepth() == 0) {
Chris Lattner13d283d2010-02-12 08:03:27 +00001919 if (!ReadAnyTokensBeforeDirective && IfNDefMacro && ConditionalTrue)
Ted Kremenek60e45d42008-11-18 00:34:22 +00001920 CurPPLexer->MIOpt.EnterTopLevelIFNDEF(IfNDefMacro);
Nuno Lopes0049db62008-06-01 18:31:24 +00001921 else
Ted Kremenek60e45d42008-11-18 00:34:22 +00001922 CurPPLexer->MIOpt.EnterTopLevelConditional();
Nuno Lopes0049db62008-06-01 18:31:24 +00001923 }
1924
Chris Lattner141e71f2008-03-09 01:54:53 +00001925 // Should we include the stuff contained by this directive?
1926 if (ConditionalTrue) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001927 // Yes, remember that we are inside a conditional, then lex the next token.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001928 CurPPLexer->pushConditionalLevel(IfToken.getLocation(), /*wasskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001929 /*foundnonskip*/true, /*foundelse*/false);
1930 } else {
Craig Silverstein08985b92010-11-06 01:19:03 +00001931 // No, skip the contents of this block.
Mike Stump1eb44332009-09-09 15:08:12 +00001932 SkipExcludedConditionalBlock(IfToken.getLocation(), /*Foundnonskip*/false,
Chris Lattner141e71f2008-03-09 01:54:53 +00001933 /*FoundElse*/false);
1934 }
Craig Silverstein08985b92010-11-06 01:19:03 +00001935
1936 if (Callbacks)
1937 Callbacks->If(SourceRange(ConditionalBegin, ConditionalEnd));
Chris Lattner141e71f2008-03-09 01:54:53 +00001938}
1939
1940/// HandleEndifDirective - Implements the #endif directive.
1941///
1942void Preprocessor::HandleEndifDirective(Token &EndifToken) {
1943 ++NumEndif;
Mike Stump1eb44332009-09-09 15:08:12 +00001944
Chris Lattner141e71f2008-03-09 01:54:53 +00001945 // Check that this is the whole directive.
Chris Lattner35410d52009-04-14 05:07:49 +00001946 CheckEndOfDirective("endif");
Mike Stump1eb44332009-09-09 15:08:12 +00001947
Chris Lattner141e71f2008-03-09 01:54:53 +00001948 PPConditionalInfo CondInfo;
Ted Kremenek60e45d42008-11-18 00:34:22 +00001949 if (CurPPLexer->popConditionalLevel(CondInfo)) {
Chris Lattner141e71f2008-03-09 01:54:53 +00001950 // No conditionals on the stack: this is an #endif without an #if.
Chris Lattner3692b092008-11-18 07:59:24 +00001951 Diag(EndifToken, diag::err_pp_endif_without_if);
1952 return;
Chris Lattner141e71f2008-03-09 01:54:53 +00001953 }
Mike Stump1eb44332009-09-09 15:08:12 +00001954
Chris Lattner141e71f2008-03-09 01:54:53 +00001955 // If this the end of a top-level #endif, inform MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001956 if (CurPPLexer->getConditionalStackDepth() == 0)
1957 CurPPLexer->MIOpt.ExitTopLevelConditional();
Mike Stump1eb44332009-09-09 15:08:12 +00001958
Ted Kremenek60e45d42008-11-18 00:34:22 +00001959 assert(!CondInfo.WasSkipping && !CurPPLexer->LexingRawMode &&
Chris Lattner141e71f2008-03-09 01:54:53 +00001960 "This code should only be reachable in the non-skipping case!");
Craig Silverstein08985b92010-11-06 01:19:03 +00001961
1962 if (Callbacks)
1963 Callbacks->Endif();
Chris Lattner141e71f2008-03-09 01:54:53 +00001964}
1965
Craig Silverstein08985b92010-11-06 01:19:03 +00001966/// HandleElseDirective - Implements the #else directive.
1967///
Chris Lattner141e71f2008-03-09 01:54:53 +00001968void Preprocessor::HandleElseDirective(Token &Result) {
1969 ++NumElse;
Mike Stump1eb44332009-09-09 15:08:12 +00001970
Chris Lattner141e71f2008-03-09 01:54:53 +00001971 // #else directive in a non-skipping conditional... start skipping.
Chris Lattner35410d52009-04-14 05:07:49 +00001972 CheckEndOfDirective("else");
Mike Stump1eb44332009-09-09 15:08:12 +00001973
Chris Lattner141e71f2008-03-09 01:54:53 +00001974 PPConditionalInfo CI;
Chris Lattner3692b092008-11-18 07:59:24 +00001975 if (CurPPLexer->popConditionalLevel(CI)) {
1976 Diag(Result, diag::pp_err_else_without_if);
1977 return;
1978 }
Mike Stump1eb44332009-09-09 15:08:12 +00001979
Chris Lattner141e71f2008-03-09 01:54:53 +00001980 // If this is a top-level #else, inform the MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00001981 if (CurPPLexer->getConditionalStackDepth() == 0)
1982 CurPPLexer->MIOpt.EnterTopLevelConditional();
Chris Lattner141e71f2008-03-09 01:54:53 +00001983
1984 // If this is a #else with a #else before it, report the error.
1985 if (CI.FoundElse) Diag(Result, diag::pp_err_else_after_else);
Mike Stump1eb44332009-09-09 15:08:12 +00001986
Craig Silverstein08985b92010-11-06 01:19:03 +00001987 // Finally, skip the rest of the contents of this block.
1988 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +00001989 /*FoundElse*/true, Result.getLocation());
Craig Silverstein08985b92010-11-06 01:19:03 +00001990
1991 if (Callbacks)
1992 Callbacks->Else();
Chris Lattner141e71f2008-03-09 01:54:53 +00001993}
1994
Craig Silverstein08985b92010-11-06 01:19:03 +00001995/// HandleElifDirective - Implements the #elif directive.
1996///
Chris Lattner141e71f2008-03-09 01:54:53 +00001997void Preprocessor::HandleElifDirective(Token &ElifToken) {
1998 ++NumElse;
Mike Stump1eb44332009-09-09 15:08:12 +00001999
Chris Lattner141e71f2008-03-09 01:54:53 +00002000 // #elif directive in a non-skipping conditional... start skipping.
2001 // We don't care what the condition is, because we will always skip it (since
2002 // the block immediately before it was included).
Craig Silverstein08985b92010-11-06 01:19:03 +00002003 const SourceLocation ConditionalBegin = CurPPLexer->getSourceLocation();
Chris Lattner141e71f2008-03-09 01:54:53 +00002004 DiscardUntilEndOfDirective();
Craig Silverstein08985b92010-11-06 01:19:03 +00002005 const SourceLocation ConditionalEnd = CurPPLexer->getSourceLocation();
Chris Lattner141e71f2008-03-09 01:54:53 +00002006
2007 PPConditionalInfo CI;
Chris Lattner3692b092008-11-18 07:59:24 +00002008 if (CurPPLexer->popConditionalLevel(CI)) {
2009 Diag(ElifToken, diag::pp_err_elif_without_if);
2010 return;
2011 }
Mike Stump1eb44332009-09-09 15:08:12 +00002012
Chris Lattner141e71f2008-03-09 01:54:53 +00002013 // If this is a top-level #elif, inform the MIOpt.
Ted Kremenek60e45d42008-11-18 00:34:22 +00002014 if (CurPPLexer->getConditionalStackDepth() == 0)
2015 CurPPLexer->MIOpt.EnterTopLevelConditional();
Mike Stump1eb44332009-09-09 15:08:12 +00002016
Chris Lattner141e71f2008-03-09 01:54:53 +00002017 // If this is a #elif with a #else before it, report the error.
2018 if (CI.FoundElse) Diag(ElifToken, diag::pp_err_elif_after_else);
2019
Craig Silverstein08985b92010-11-06 01:19:03 +00002020 // Finally, skip the rest of the contents of this block.
2021 SkipExcludedConditionalBlock(CI.IfLoc, /*Foundnonskip*/true,
Argyrios Kyrtzidis6b4ff042011-09-27 17:32:05 +00002022 /*FoundElse*/CI.FoundElse,
2023 ElifToken.getLocation());
Craig Silverstein08985b92010-11-06 01:19:03 +00002024
2025 if (Callbacks)
2026 Callbacks->Elif(SourceRange(ConditionalBegin, ConditionalEnd));
Chris Lattner141e71f2008-03-09 01:54:53 +00002027}