1 //===- Pragma.cpp - Pragma registration and handling ----------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the PragmaHandler/PragmaTable interfaces and implements
10 // pragma related methods of the Preprocessor class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "clang/Lex/Pragma.h"
15 #include "clang/Basic/Diagnostic.h"
16 #include "clang/Basic/DiagnosticLex.h"
17 #include "clang/Basic/FileManager.h"
18 #include "clang/Basic/IdentifierTable.h"
19 #include "clang/Basic/LLVM.h"
20 #include "clang/Basic/LangOptions.h"
21 #include "clang/Basic/Module.h"
22 #include "clang/Basic/SourceLocation.h"
23 #include "clang/Basic/SourceManager.h"
24 #include "clang/Basic/TokenKinds.h"
25 #include "clang/Lex/HeaderSearch.h"
26 #include "clang/Lex/LexDiagnostic.h"
27 #include "clang/Lex/Lexer.h"
28 #include "clang/Lex/LiteralSupport.h"
29 #include "clang/Lex/MacroInfo.h"
30 #include "clang/Lex/ModuleLoader.h"
31 #include "clang/Lex/PPCallbacks.h"
32 #include "clang/Lex/Preprocessor.h"
33 #include "clang/Lex/PreprocessorLexer.h"
34 #include "clang/Lex/PreprocessorOptions.h"
35 #include "clang/Lex/Token.h"
36 #include "clang/Lex/TokenLexer.h"
37 #include "llvm/ADT/ArrayRef.h"
38 #include "llvm/ADT/DenseMap.h"
39 #include "llvm/ADT/Optional.h"
40 #include "llvm/ADT/STLExtras.h"
41 #include "llvm/ADT/SmallString.h"
42 #include "llvm/ADT/SmallVector.h"
43 #include "llvm/ADT/StringRef.h"
44 #include "llvm/ADT/StringSwitch.h"
45 #include "llvm/Support/Compiler.h"
46 #include "llvm/Support/ErrorHandling.h"
47 #include "llvm/Support/Timer.h"
48 #include <algorithm>
49 #include <cassert>
50 #include <cstddef>
51 #include <cstdint>
52 #include <limits>
53 #include <string>
54 #include <utility>
55 #include <vector>
56
57 using namespace clang;
58
59 // Out-of-line destructor to provide a home for the class.
60 PragmaHandler::~PragmaHandler() = default;
61
62 //===----------------------------------------------------------------------===//
63 // EmptyPragmaHandler Implementation.
64 //===----------------------------------------------------------------------===//
65
EmptyPragmaHandler(StringRef Name)66 EmptyPragmaHandler::EmptyPragmaHandler(StringRef Name) : PragmaHandler(Name) {}
67
HandlePragma(Preprocessor & PP,PragmaIntroducer Introducer,Token & FirstToken)68 void EmptyPragmaHandler::HandlePragma(Preprocessor &PP,
69 PragmaIntroducer Introducer,
70 Token &FirstToken) {}
71
72 //===----------------------------------------------------------------------===//
73 // PragmaNamespace Implementation.
74 //===----------------------------------------------------------------------===//
75
76 /// FindHandler - Check to see if there is already a handler for the
77 /// specified name. If not, return the handler for the null identifier if it
78 /// exists, otherwise return null. If IgnoreNull is true (the default) then
79 /// the null handler isn't returned on failure to match.
FindHandler(StringRef Name,bool IgnoreNull) const80 PragmaHandler *PragmaNamespace::FindHandler(StringRef Name,
81 bool IgnoreNull) const {
82 auto I = Handlers.find(Name);
83 if (I != Handlers.end())
84 return I->getValue().get();
85 if (IgnoreNull)
86 return nullptr;
87 I = Handlers.find(StringRef());
88 if (I != Handlers.end())
89 return I->getValue().get();
90 return nullptr;
91 }
92
AddPragma(PragmaHandler * Handler)93 void PragmaNamespace::AddPragma(PragmaHandler *Handler) {
94 assert(!Handlers.count(Handler->getName()) &&
95 "A handler with this name is already registered in this namespace");
96 Handlers[Handler->getName()].reset(Handler);
97 }
98
RemovePragmaHandler(PragmaHandler * Handler)99 void PragmaNamespace::RemovePragmaHandler(PragmaHandler *Handler) {
100 auto I = Handlers.find(Handler->getName());
101 assert(I != Handlers.end() &&
102 "Handler not registered in this namespace");
103 // Release ownership back to the caller.
104 I->getValue().release();
105 Handlers.erase(I);
106 }
107
HandlePragma(Preprocessor & PP,PragmaIntroducer Introducer,Token & Tok)108 void PragmaNamespace::HandlePragma(Preprocessor &PP,
109 PragmaIntroducer Introducer, Token &Tok) {
110 // Read the 'namespace' that the directive is in, e.g. STDC. Do not macro
111 // expand it, the user can have a STDC #define, that should not affect this.
112 PP.LexUnexpandedToken(Tok);
113
114 // Get the handler for this token. If there is no handler, ignore the pragma.
115 PragmaHandler *Handler
116 = FindHandler(Tok.getIdentifierInfo() ? Tok.getIdentifierInfo()->getName()
117 : StringRef(),
118 /*IgnoreNull=*/false);
119 if (!Handler) {
120 PP.Diag(Tok, diag::warn_pragma_ignored);
121 return;
122 }
123
124 // Otherwise, pass it down.
125 Handler->HandlePragma(PP, Introducer, Tok);
126 }
127
128 //===----------------------------------------------------------------------===//
129 // Preprocessor Pragma Directive Handling.
130 //===----------------------------------------------------------------------===//
131
132 namespace {
133 // TokenCollector provides the option to collect tokens that were "read"
134 // and return them to the stream to be read later.
135 // Currently used when reading _Pragma/__pragma directives.
136 struct TokenCollector {
137 Preprocessor &Self;
138 bool Collect;
139 SmallVector<Token, 3> Tokens;
140 Token &Tok;
141
lex__anon339268100111::TokenCollector142 void lex() {
143 if (Collect)
144 Tokens.push_back(Tok);
145 Self.Lex(Tok);
146 }
147
revert__anon339268100111::TokenCollector148 void revert() {
149 assert(Collect && "did not collect tokens");
150 assert(!Tokens.empty() && "collected unexpected number of tokens");
151
152 // Push the ( "string" ) tokens into the token stream.
153 auto Toks = std::make_unique<Token[]>(Tokens.size());
154 std::copy(Tokens.begin() + 1, Tokens.end(), Toks.get());
155 Toks[Tokens.size() - 1] = Tok;
156 Self.EnterTokenStream(std::move(Toks), Tokens.size(),
157 /*DisableMacroExpansion*/ true,
158 /*IsReinject*/ true);
159
160 // ... and return the pragma token unchanged.
161 Tok = *Tokens.begin();
162 }
163 };
164 } // namespace
165
166 /// HandlePragmaDirective - The "\#pragma" directive has been parsed. Lex the
167 /// rest of the pragma, passing it to the registered pragma handlers.
HandlePragmaDirective(PragmaIntroducer Introducer)168 void Preprocessor::HandlePragmaDirective(PragmaIntroducer Introducer) {
169 if (Callbacks)
170 Callbacks->PragmaDirective(Introducer.Loc, Introducer.Kind);
171
172 if (!PragmasEnabled)
173 return;
174
175 ++NumPragma;
176
177 // Invoke the first level of pragma handlers which reads the namespace id.
178 Token Tok;
179 PragmaHandlers->HandlePragma(*this, Introducer, Tok);
180
181 // If the pragma handler didn't read the rest of the line, consume it now.
182 if ((CurTokenLexer && CurTokenLexer->isParsingPreprocessorDirective())
183 || (CurPPLexer && CurPPLexer->ParsingPreprocessorDirective))
184 DiscardUntilEndOfDirective();
185 }
186
187 /// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then
188 /// return the first token after the directive. The _Pragma token has just
189 /// been read into 'Tok'.
Handle_Pragma(Token & Tok)190 void Preprocessor::Handle_Pragma(Token &Tok) {
191 // C11 6.10.3.4/3:
192 // all pragma unary operator expressions within [a completely
193 // macro-replaced preprocessing token sequence] are [...] processed [after
194 // rescanning is complete]
195 //
196 // This means that we execute _Pragma operators in two cases:
197 //
198 // 1) on token sequences that would otherwise be produced as the output of
199 // phase 4 of preprocessing, and
200 // 2) on token sequences formed as the macro-replaced token sequence of a
201 // macro argument
202 //
203 // Case #2 appears to be a wording bug: only _Pragmas that would survive to
204 // the end of phase 4 should actually be executed. Discussion on the WG14
205 // mailing list suggests that a _Pragma operator is notionally checked early,
206 // but only pragmas that survive to the end of phase 4 should be executed.
207 //
208 // In Case #2, we check the syntax now, but then put the tokens back into the
209 // token stream for later consumption.
210
211 TokenCollector Toks = {*this, InMacroArgPreExpansion, {}, Tok};
212
213 // Remember the pragma token location.
214 SourceLocation PragmaLoc = Tok.getLocation();
215
216 // Read the '('.
217 Toks.lex();
218 if (Tok.isNot(tok::l_paren)) {
219 Diag(PragmaLoc, diag::err__Pragma_malformed);
220 return;
221 }
222
223 // Read the '"..."'.
224 Toks.lex();
225 if (!tok::isStringLiteral(Tok.getKind())) {
226 Diag(PragmaLoc, diag::err__Pragma_malformed);
227 // Skip bad tokens, and the ')', if present.
228 if (Tok.isNot(tok::r_paren) && Tok.isNot(tok::eof))
229 Lex(Tok);
230 while (Tok.isNot(tok::r_paren) &&
231 !Tok.isAtStartOfLine() &&
232 Tok.isNot(tok::eof))
233 Lex(Tok);
234 if (Tok.is(tok::r_paren))
235 Lex(Tok);
236 return;
237 }
238
239 if (Tok.hasUDSuffix()) {
240 Diag(Tok, diag::err_invalid_string_udl);
241 // Skip this token, and the ')', if present.
242 Lex(Tok);
243 if (Tok.is(tok::r_paren))
244 Lex(Tok);
245 return;
246 }
247
248 // Remember the string.
249 Token StrTok = Tok;
250
251 // Read the ')'.
252 Toks.lex();
253 if (Tok.isNot(tok::r_paren)) {
254 Diag(PragmaLoc, diag::err__Pragma_malformed);
255 return;
256 }
257
258 // If we're expanding a macro argument, put the tokens back.
259 if (InMacroArgPreExpansion) {
260 Toks.revert();
261 return;
262 }
263
264 SourceLocation RParenLoc = Tok.getLocation();
265 std::string StrVal = getSpelling(StrTok);
266
267 // The _Pragma is lexically sound. Destringize according to C11 6.10.9.1:
268 // "The string literal is destringized by deleting any encoding prefix,
269 // deleting the leading and trailing double-quotes, replacing each escape
270 // sequence \" by a double-quote, and replacing each escape sequence \\ by a
271 // single backslash."
272 if (StrVal[0] == 'L' || StrVal[0] == 'U' ||
273 (StrVal[0] == 'u' && StrVal[1] != '8'))
274 StrVal.erase(StrVal.begin());
275 else if (StrVal[0] == 'u')
276 StrVal.erase(StrVal.begin(), StrVal.begin() + 2);
277
278 if (StrVal[0] == 'R') {
279 // FIXME: C++11 does not specify how to handle raw-string-literals here.
280 // We strip off the 'R', the quotes, the d-char-sequences, and the parens.
281 assert(StrVal[1] == '"' && StrVal[StrVal.size() - 1] == '"' &&
282 "Invalid raw string token!");
283
284 // Measure the length of the d-char-sequence.
285 unsigned NumDChars = 0;
286 while (StrVal[2 + NumDChars] != '(') {
287 assert(NumDChars < (StrVal.size() - 5) / 2 &&
288 "Invalid raw string token!");
289 ++NumDChars;
290 }
291 assert(StrVal[StrVal.size() - 2 - NumDChars] == ')');
292
293 // Remove 'R " d-char-sequence' and 'd-char-sequence "'. We'll replace the
294 // parens below.
295 StrVal.erase(0, 2 + NumDChars);
296 StrVal.erase(StrVal.size() - 1 - NumDChars);
297 } else {
298 assert(StrVal[0] == '"' && StrVal[StrVal.size()-1] == '"' &&
299 "Invalid string token!");
300
301 // Remove escaped quotes and escapes.
302 unsigned ResultPos = 1;
303 for (size_t i = 1, e = StrVal.size() - 1; i != e; ++i) {
304 // Skip escapes. \\ -> '\' and \" -> '"'.
305 if (StrVal[i] == '\\' && i + 1 < e &&
306 (StrVal[i + 1] == '\\' || StrVal[i + 1] == '"'))
307 ++i;
308 StrVal[ResultPos++] = StrVal[i];
309 }
310 StrVal.erase(StrVal.begin() + ResultPos, StrVal.end() - 1);
311 }
312
313 // Remove the front quote, replacing it with a space, so that the pragma
314 // contents appear to have a space before them.
315 StrVal[0] = ' ';
316
317 // Replace the terminating quote with a \n.
318 StrVal[StrVal.size()-1] = '\n';
319
320 // Plop the string (including the newline and trailing null) into a buffer
321 // where we can lex it.
322 Token TmpTok;
323 TmpTok.startToken();
324 CreateString(StrVal, TmpTok);
325 SourceLocation TokLoc = TmpTok.getLocation();
326
327 // Make and enter a lexer object so that we lex and expand the tokens just
328 // like any others.
329 Lexer *TL = Lexer::Create_PragmaLexer(TokLoc, PragmaLoc, RParenLoc,
330 StrVal.size(), *this);
331
332 EnterSourceFileWithLexer(TL, nullptr);
333
334 // With everything set up, lex this as a #pragma directive.
335 HandlePragmaDirective({PIK__Pragma, PragmaLoc});
336
337 // Finally, return whatever came after the pragma directive.
338 return Lex(Tok);
339 }
340
341 /// HandleMicrosoft__pragma - Like Handle_Pragma except the pragma text
342 /// is not enclosed within a string literal.
HandleMicrosoft__pragma(Token & Tok)343 void Preprocessor::HandleMicrosoft__pragma(Token &Tok) {
344 // During macro pre-expansion, check the syntax now but put the tokens back
345 // into the token stream for later consumption. Same as Handle_Pragma.
346 TokenCollector Toks = {*this, InMacroArgPreExpansion, {}, Tok};
347
348 // Remember the pragma token location.
349 SourceLocation PragmaLoc = Tok.getLocation();
350
351 // Read the '('.
352 Toks.lex();
353 if (Tok.isNot(tok::l_paren)) {
354 Diag(PragmaLoc, diag::err__Pragma_malformed);
355 return;
356 }
357
358 // Get the tokens enclosed within the __pragma(), as well as the final ')'.
359 SmallVector<Token, 32> PragmaToks;
360 int NumParens = 0;
361 Toks.lex();
362 while (Tok.isNot(tok::eof)) {
363 PragmaToks.push_back(Tok);
364 if (Tok.is(tok::l_paren))
365 NumParens++;
366 else if (Tok.is(tok::r_paren) && NumParens-- == 0)
367 break;
368 Toks.lex();
369 }
370
371 if (Tok.is(tok::eof)) {
372 Diag(PragmaLoc, diag::err_unterminated___pragma);
373 return;
374 }
375
376 // If we're expanding a macro argument, put the tokens back.
377 if (InMacroArgPreExpansion) {
378 Toks.revert();
379 return;
380 }
381
382 PragmaToks.front().setFlag(Token::LeadingSpace);
383
384 // Replace the ')' with an EOD to mark the end of the pragma.
385 PragmaToks.back().setKind(tok::eod);
386
387 Token *TokArray = new Token[PragmaToks.size()];
388 std::copy(PragmaToks.begin(), PragmaToks.end(), TokArray);
389
390 // Push the tokens onto the stack.
391 EnterTokenStream(TokArray, PragmaToks.size(), true, true,
392 /*IsReinject*/ false);
393
394 // With everything set up, lex this as a #pragma directive.
395 HandlePragmaDirective({PIK___pragma, PragmaLoc});
396
397 // Finally, return whatever came after the pragma directive.
398 return Lex(Tok);
399 }
400
401 /// HandlePragmaOnce - Handle \#pragma once. OnceTok is the 'once'.
HandlePragmaOnce(Token & OnceTok)402 void Preprocessor::HandlePragmaOnce(Token &OnceTok) {
403 // Don't honor the 'once' when handling the primary source file, unless
404 // this is a prefix to a TU, which indicates we're generating a PCH file, or
405 // when the main file is a header (e.g. when -xc-header is provided on the
406 // commandline).
407 if (isInPrimaryFile() && TUKind != TU_Prefix && !getLangOpts().IsHeaderFile) {
408 Diag(OnceTok, diag::pp_pragma_once_in_main_file);
409 return;
410 }
411
412 // Get the current file lexer we're looking at. Ignore _Pragma 'files' etc.
413 // Mark the file as a once-only file now.
414 HeaderInfo.MarkFileIncludeOnce(getCurrentFileLexer()->getFileEntry());
415 }
416
HandlePragmaMark(Token & MarkTok)417 void Preprocessor::HandlePragmaMark(Token &MarkTok) {
418 assert(CurPPLexer && "No current lexer?");
419
420 SmallString<64> Buffer;
421 CurLexer->ReadToEndOfLine(&Buffer);
422 if (Callbacks)
423 Callbacks->PragmaMark(MarkTok.getLocation(), Buffer);
424 }
425
426 /// HandlePragmaPoison - Handle \#pragma GCC poison. PoisonTok is the 'poison'.
HandlePragmaPoison()427 void Preprocessor::HandlePragmaPoison() {
428 Token Tok;
429
430 while (true) {
431 // Read the next token to poison. While doing this, pretend that we are
432 // skipping while reading the identifier to poison.
433 // This avoids errors on code like:
434 // #pragma GCC poison X
435 // #pragma GCC poison X
436 if (CurPPLexer) CurPPLexer->LexingRawMode = true;
437 LexUnexpandedToken(Tok);
438 if (CurPPLexer) CurPPLexer->LexingRawMode = false;
439
440 // If we reached the end of line, we're done.
441 if (Tok.is(tok::eod)) return;
442
443 // Can only poison identifiers.
444 if (Tok.isNot(tok::raw_identifier)) {
445 Diag(Tok, diag::err_pp_invalid_poison);
446 return;
447 }
448
449 // Look up the identifier info for the token. We disabled identifier lookup
450 // by saying we're skipping contents, so we need to do this manually.
451 IdentifierInfo *II = LookUpIdentifierInfo(Tok);
452
453 // Already poisoned.
454 if (II->isPoisoned()) continue;
455
456 // If this is a macro identifier, emit a warning.
457 if (isMacroDefined(II))
458 Diag(Tok, diag::pp_poisoning_existing_macro);
459
460 // Finally, poison it!
461 II->setIsPoisoned();
462 if (II->isFromAST())
463 II->setChangedSinceDeserialization();
464 }
465 }
466
467 /// HandlePragmaSystemHeader - Implement \#pragma GCC system_header. We know
468 /// that the whole directive has been parsed.
HandlePragmaSystemHeader(Token & SysHeaderTok)469 void Preprocessor::HandlePragmaSystemHeader(Token &SysHeaderTok) {
470 if (isInPrimaryFile()) {
471 Diag(SysHeaderTok, diag::pp_pragma_sysheader_in_main_file);
472 return;
473 }
474
475 // Get the current file lexer we're looking at. Ignore _Pragma 'files' etc.
476 PreprocessorLexer *TheLexer = getCurrentFileLexer();
477
478 // Mark the file as a system header.
479 HeaderInfo.MarkFileSystemHeader(TheLexer->getFileEntry());
480
481 PresumedLoc PLoc = SourceMgr.getPresumedLoc(SysHeaderTok.getLocation());
482 if (PLoc.isInvalid())
483 return;
484
485 unsigned FilenameID = SourceMgr.getLineTableFilenameID(PLoc.getFilename());
486
487 // Notify the client, if desired, that we are in a new source file.
488 if (Callbacks)
489 Callbacks->FileChanged(SysHeaderTok.getLocation(),
490 PPCallbacks::SystemHeaderPragma, SrcMgr::C_System);
491
492 // Emit a line marker. This will change any source locations from this point
493 // forward to realize they are in a system header.
494 // Create a line note with this information.
495 SourceMgr.AddLineNote(SysHeaderTok.getLocation(), PLoc.getLine() + 1,
496 FilenameID, /*IsEntry=*/false, /*IsExit=*/false,
497 SrcMgr::C_System);
498 }
499
LexHeader(Preprocessor & PP,Optional<FileEntryRef> & File,bool SuppressIncludeNotFoundError)500 static llvm::Optional<Token> LexHeader(Preprocessor &PP,
501 Optional<FileEntryRef> &File,
502 bool SuppressIncludeNotFoundError) {
503 Token FilenameTok;
504 if (PP.LexHeaderName(FilenameTok, /*AllowConcatenation*/ false))
505 return llvm::None;
506
507 // If the next token wasn't a header-name, diagnose the error.
508 if (FilenameTok.isNot(tok::header_name)) {
509 PP.Diag(FilenameTok.getLocation(), diag::err_pp_expects_filename);
510 return llvm::None;
511 }
512
513 // Reserve a buffer to get the spelling.
514 SmallString<128> FilenameBuffer;
515 bool Invalid = false;
516 StringRef Filename = PP.getSpelling(FilenameTok, FilenameBuffer, &Invalid);
517 if (Invalid)
518 return llvm::None;
519
520 bool isAngled =
521 PP.GetIncludeFilenameSpelling(FilenameTok.getLocation(), Filename);
522 // If GetIncludeFilenameSpelling set the start ptr to null, there was an
523 // error.
524 if (Filename.empty())
525 return llvm::None;
526
527 // Search include directories for this file.
528 const DirectoryLookup *CurDir;
529 File = PP.LookupFile(FilenameTok.getLocation(), Filename, isAngled, nullptr,
530 nullptr, CurDir, nullptr, nullptr, nullptr, nullptr,
531 nullptr);
532 if (!File) {
533 if (!SuppressIncludeNotFoundError)
534 PP.Diag(FilenameTok, diag::err_pp_file_not_found) << Filename;
535 return llvm::None;
536 }
537
538 return FilenameTok;
539 }
540
541 /// HandlePragmaIncludeInstead - Handle \#pragma clang include_instead(header).
HandlePragmaIncludeInstead(Token & Tok)542 void Preprocessor::HandlePragmaIncludeInstead(Token &Tok) {
543 // Get the current file lexer we're looking at. Ignore _Pragma 'files' etc.
544 PreprocessorLexer *TheLexer = getCurrentFileLexer();
545
546 if (!SourceMgr.isInSystemHeader(Tok.getLocation())) {
547 Diag(Tok, diag::err_pragma_include_instead_not_sysheader);
548 return;
549 }
550
551 Lex(Tok);
552 if (Tok.isNot(tok::l_paren)) {
553 Diag(Tok, diag::err_expected) << "(";
554 return;
555 }
556
557 Optional<FileEntryRef> File;
558 llvm::Optional<Token> FilenameTok =
559 LexHeader(*this, File, SuppressIncludeNotFoundError);
560 if (!FilenameTok)
561 return;
562
563 Lex(Tok);
564 if (Tok.isNot(tok::r_paren)) {
565 Diag(Tok, diag::err_expected) << ")";
566 return;
567 }
568
569 SmallString<128> FilenameBuffer;
570 StringRef Filename = getSpelling(*FilenameTok, FilenameBuffer);
571 HeaderInfo.AddFileAlias(TheLexer->getFileEntry(), Filename);
572 }
573
574 /// HandlePragmaDependency - Handle \#pragma GCC dependency "foo" blah.
HandlePragmaDependency(Token & DependencyTok)575 void Preprocessor::HandlePragmaDependency(Token &DependencyTok) {
576 Optional<FileEntryRef> File;
577 llvm::Optional<Token> FilenameTok =
578 LexHeader(*this, File, SuppressIncludeNotFoundError);
579 if (!FilenameTok)
580 return;
581
582 const FileEntry *CurFile = getCurrentFileLexer()->getFileEntry();
583
584 // If this file is older than the file it depends on, emit a diagnostic.
585 if (CurFile && CurFile->getModificationTime() < File->getModificationTime()) {
586 // Lex tokens at the end of the message and include them in the message.
587 std::string Message;
588 Lex(DependencyTok);
589 while (DependencyTok.isNot(tok::eod)) {
590 Message += getSpelling(DependencyTok) + " ";
591 Lex(DependencyTok);
592 }
593
594 // Remove the trailing ' ' if present.
595 if (!Message.empty())
596 Message.erase(Message.end()-1);
597 Diag(*FilenameTok, diag::pp_out_of_date_dependency) << Message;
598 }
599 }
600
601 /// ParsePragmaPushOrPopMacro - Handle parsing of pragma push_macro/pop_macro.
602 /// Return the IdentifierInfo* associated with the macro to push or pop.
ParsePragmaPushOrPopMacro(Token & Tok)603 IdentifierInfo *Preprocessor::ParsePragmaPushOrPopMacro(Token &Tok) {
604 // Remember the pragma token location.
605 Token PragmaTok = Tok;
606
607 // Read the '('.
608 Lex(Tok);
609 if (Tok.isNot(tok::l_paren)) {
610 Diag(PragmaTok.getLocation(), diag::err_pragma_push_pop_macro_malformed)
611 << getSpelling(PragmaTok);
612 return nullptr;
613 }
614
615 // Read the macro name string.
616 Lex(Tok);
617 if (Tok.isNot(tok::string_literal)) {
618 Diag(PragmaTok.getLocation(), diag::err_pragma_push_pop_macro_malformed)
619 << getSpelling(PragmaTok);
620 return nullptr;
621 }
622
623 if (Tok.hasUDSuffix()) {
624 Diag(Tok, diag::err_invalid_string_udl);
625 return nullptr;
626 }
627
628 // Remember the macro string.
629 std::string StrVal = getSpelling(Tok);
630
631 // Read the ')'.
632 Lex(Tok);
633 if (Tok.isNot(tok::r_paren)) {
634 Diag(PragmaTok.getLocation(), diag::err_pragma_push_pop_macro_malformed)
635 << getSpelling(PragmaTok);
636 return nullptr;
637 }
638
639 assert(StrVal[0] == '"' && StrVal[StrVal.size()-1] == '"' &&
640 "Invalid string token!");
641
642 // Create a Token from the string.
643 Token MacroTok;
644 MacroTok.startToken();
645 MacroTok.setKind(tok::raw_identifier);
646 CreateString(StringRef(&StrVal[1], StrVal.size() - 2), MacroTok);
647
648 // Get the IdentifierInfo of MacroToPushTok.
649 return LookUpIdentifierInfo(MacroTok);
650 }
651
652 /// Handle \#pragma push_macro.
653 ///
654 /// The syntax is:
655 /// \code
656 /// #pragma push_macro("macro")
657 /// \endcode
HandlePragmaPushMacro(Token & PushMacroTok)658 void Preprocessor::HandlePragmaPushMacro(Token &PushMacroTok) {
659 // Parse the pragma directive and get the macro IdentifierInfo*.
660 IdentifierInfo *IdentInfo = ParsePragmaPushOrPopMacro(PushMacroTok);
661 if (!IdentInfo) return;
662
663 // Get the MacroInfo associated with IdentInfo.
664 MacroInfo *MI = getMacroInfo(IdentInfo);
665
666 if (MI) {
667 // Allow the original MacroInfo to be redefined later.
668 MI->setIsAllowRedefinitionsWithoutWarning(true);
669 }
670
671 // Push the cloned MacroInfo so we can retrieve it later.
672 PragmaPushMacroInfo[IdentInfo].push_back(MI);
673 }
674
675 /// Handle \#pragma pop_macro.
676 ///
677 /// The syntax is:
678 /// \code
679 /// #pragma pop_macro("macro")
680 /// \endcode
HandlePragmaPopMacro(Token & PopMacroTok)681 void Preprocessor::HandlePragmaPopMacro(Token &PopMacroTok) {
682 SourceLocation MessageLoc = PopMacroTok.getLocation();
683
684 // Parse the pragma directive and get the macro IdentifierInfo*.
685 IdentifierInfo *IdentInfo = ParsePragmaPushOrPopMacro(PopMacroTok);
686 if (!IdentInfo) return;
687
688 // Find the vector<MacroInfo*> associated with the macro.
689 llvm::DenseMap<IdentifierInfo *, std::vector<MacroInfo *>>::iterator iter =
690 PragmaPushMacroInfo.find(IdentInfo);
691 if (iter != PragmaPushMacroInfo.end()) {
692 // Forget the MacroInfo currently associated with IdentInfo.
693 if (MacroInfo *MI = getMacroInfo(IdentInfo)) {
694 if (MI->isWarnIfUnused())
695 WarnUnusedMacroLocs.erase(MI->getDefinitionLoc());
696 appendMacroDirective(IdentInfo, AllocateUndefMacroDirective(MessageLoc));
697 }
698
699 // Get the MacroInfo we want to reinstall.
700 MacroInfo *MacroToReInstall = iter->second.back();
701
702 if (MacroToReInstall)
703 // Reinstall the previously pushed macro.
704 appendDefMacroDirective(IdentInfo, MacroToReInstall, MessageLoc);
705
706 // Pop PragmaPushMacroInfo stack.
707 iter->second.pop_back();
708 if (iter->second.empty())
709 PragmaPushMacroInfo.erase(iter);
710 } else {
711 Diag(MessageLoc, diag::warn_pragma_pop_macro_no_push)
712 << IdentInfo->getName();
713 }
714 }
715
HandlePragmaIncludeAlias(Token & Tok)716 void Preprocessor::HandlePragmaIncludeAlias(Token &Tok) {
717 // We will either get a quoted filename or a bracketed filename, and we
718 // have to track which we got. The first filename is the source name,
719 // and the second name is the mapped filename. If the first is quoted,
720 // the second must be as well (cannot mix and match quotes and brackets).
721
722 // Get the open paren
723 Lex(Tok);
724 if (Tok.isNot(tok::l_paren)) {
725 Diag(Tok, diag::warn_pragma_include_alias_expected) << "(";
726 return;
727 }
728
729 // We expect either a quoted string literal, or a bracketed name
730 Token SourceFilenameTok;
731 if (LexHeaderName(SourceFilenameTok))
732 return;
733
734 StringRef SourceFileName;
735 SmallString<128> FileNameBuffer;
736 if (SourceFilenameTok.is(tok::header_name)) {
737 SourceFileName = getSpelling(SourceFilenameTok, FileNameBuffer);
738 } else {
739 Diag(Tok, diag::warn_pragma_include_alias_expected_filename);
740 return;
741 }
742 FileNameBuffer.clear();
743
744 // Now we expect a comma, followed by another include name
745 Lex(Tok);
746 if (Tok.isNot(tok::comma)) {
747 Diag(Tok, diag::warn_pragma_include_alias_expected) << ",";
748 return;
749 }
750
751 Token ReplaceFilenameTok;
752 if (LexHeaderName(ReplaceFilenameTok))
753 return;
754
755 StringRef ReplaceFileName;
756 if (ReplaceFilenameTok.is(tok::header_name)) {
757 ReplaceFileName = getSpelling(ReplaceFilenameTok, FileNameBuffer);
758 } else {
759 Diag(Tok, diag::warn_pragma_include_alias_expected_filename);
760 return;
761 }
762
763 // Finally, we expect the closing paren
764 Lex(Tok);
765 if (Tok.isNot(tok::r_paren)) {
766 Diag(Tok, diag::warn_pragma_include_alias_expected) << ")";
767 return;
768 }
769
770 // Now that we have the source and target filenames, we need to make sure
771 // they're both of the same type (angled vs non-angled)
772 StringRef OriginalSource = SourceFileName;
773
774 bool SourceIsAngled =
775 GetIncludeFilenameSpelling(SourceFilenameTok.getLocation(),
776 SourceFileName);
777 bool ReplaceIsAngled =
778 GetIncludeFilenameSpelling(ReplaceFilenameTok.getLocation(),
779 ReplaceFileName);
780 if (!SourceFileName.empty() && !ReplaceFileName.empty() &&
781 (SourceIsAngled != ReplaceIsAngled)) {
782 unsigned int DiagID;
783 if (SourceIsAngled)
784 DiagID = diag::warn_pragma_include_alias_mismatch_angle;
785 else
786 DiagID = diag::warn_pragma_include_alias_mismatch_quote;
787
788 Diag(SourceFilenameTok.getLocation(), DiagID)
789 << SourceFileName
790 << ReplaceFileName;
791
792 return;
793 }
794
795 // Now we can let the include handler know about this mapping
796 getHeaderSearchInfo().AddIncludeAlias(OriginalSource, ReplaceFileName);
797 }
798
799 // Lex a component of a module name: either an identifier or a string literal;
800 // for components that can be expressed both ways, the two forms are equivalent.
LexModuleNameComponent(Preprocessor & PP,Token & Tok,std::pair<IdentifierInfo *,SourceLocation> & ModuleNameComponent,bool First)801 static bool LexModuleNameComponent(
802 Preprocessor &PP, Token &Tok,
803 std::pair<IdentifierInfo *, SourceLocation> &ModuleNameComponent,
804 bool First) {
805 PP.LexUnexpandedToken(Tok);
806 if (Tok.is(tok::string_literal) && !Tok.hasUDSuffix()) {
807 StringLiteralParser Literal(Tok, PP);
808 if (Literal.hadError)
809 return true;
810 ModuleNameComponent = std::make_pair(
811 PP.getIdentifierInfo(Literal.GetString()), Tok.getLocation());
812 } else if (!Tok.isAnnotation() && Tok.getIdentifierInfo()) {
813 ModuleNameComponent =
814 std::make_pair(Tok.getIdentifierInfo(), Tok.getLocation());
815 } else {
816 PP.Diag(Tok.getLocation(), diag::err_pp_expected_module_name) << First;
817 return true;
818 }
819 return false;
820 }
821
LexModuleName(Preprocessor & PP,Token & Tok,llvm::SmallVectorImpl<std::pair<IdentifierInfo *,SourceLocation>> & ModuleName)822 static bool LexModuleName(
823 Preprocessor &PP, Token &Tok,
824 llvm::SmallVectorImpl<std::pair<IdentifierInfo *, SourceLocation>>
825 &ModuleName) {
826 while (true) {
827 std::pair<IdentifierInfo*, SourceLocation> NameComponent;
828 if (LexModuleNameComponent(PP, Tok, NameComponent, ModuleName.empty()))
829 return true;
830 ModuleName.push_back(NameComponent);
831
832 PP.LexUnexpandedToken(Tok);
833 if (Tok.isNot(tok::period))
834 return false;
835 }
836 }
837
HandlePragmaModuleBuild(Token & Tok)838 void Preprocessor::HandlePragmaModuleBuild(Token &Tok) {
839 SourceLocation Loc = Tok.getLocation();
840
841 std::pair<IdentifierInfo *, SourceLocation> ModuleNameLoc;
842 if (LexModuleNameComponent(*this, Tok, ModuleNameLoc, true))
843 return;
844 IdentifierInfo *ModuleName = ModuleNameLoc.first;
845
846 LexUnexpandedToken(Tok);
847 if (Tok.isNot(tok::eod)) {
848 Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
849 DiscardUntilEndOfDirective();
850 }
851
852 CurLexer->LexingRawMode = true;
853
854 auto TryConsumeIdentifier = [&](StringRef Ident) -> bool {
855 if (Tok.getKind() != tok::raw_identifier ||
856 Tok.getRawIdentifier() != Ident)
857 return false;
858 CurLexer->Lex(Tok);
859 return true;
860 };
861
862 // Scan forward looking for the end of the module.
863 const char *Start = CurLexer->getBufferLocation();
864 const char *End = nullptr;
865 unsigned NestingLevel = 1;
866 while (true) {
867 End = CurLexer->getBufferLocation();
868 CurLexer->Lex(Tok);
869
870 if (Tok.is(tok::eof)) {
871 Diag(Loc, diag::err_pp_module_build_missing_end);
872 break;
873 }
874
875 if (Tok.isNot(tok::hash) || !Tok.isAtStartOfLine()) {
876 // Token was part of module; keep going.
877 continue;
878 }
879
880 // We hit something directive-shaped; check to see if this is the end
881 // of the module build.
882 CurLexer->ParsingPreprocessorDirective = true;
883 CurLexer->Lex(Tok);
884 if (TryConsumeIdentifier("pragma") && TryConsumeIdentifier("clang") &&
885 TryConsumeIdentifier("module")) {
886 if (TryConsumeIdentifier("build"))
887 // #pragma clang module build -> entering a nested module build.
888 ++NestingLevel;
889 else if (TryConsumeIdentifier("endbuild")) {
890 // #pragma clang module endbuild -> leaving a module build.
891 if (--NestingLevel == 0)
892 break;
893 }
894 // We should either be looking at the EOD or more of the current directive
895 // preceding the EOD. Either way we can ignore this token and keep going.
896 assert(Tok.getKind() != tok::eof && "missing EOD before EOF");
897 }
898 }
899
900 CurLexer->LexingRawMode = false;
901
902 // Load the extracted text as a preprocessed module.
903 assert(CurLexer->getBuffer().begin() <= Start &&
904 Start <= CurLexer->getBuffer().end() &&
905 CurLexer->getBuffer().begin() <= End &&
906 End <= CurLexer->getBuffer().end() &&
907 "module source range not contained within same file buffer");
908 TheModuleLoader.createModuleFromSource(Loc, ModuleName->getName(),
909 StringRef(Start, End - Start));
910 }
911
HandlePragmaHdrstop(Token & Tok)912 void Preprocessor::HandlePragmaHdrstop(Token &Tok) {
913 Lex(Tok);
914 if (Tok.is(tok::l_paren)) {
915 Diag(Tok.getLocation(), diag::warn_pp_hdrstop_filename_ignored);
916
917 std::string FileName;
918 if (!LexStringLiteral(Tok, FileName, "pragma hdrstop", false))
919 return;
920
921 if (Tok.isNot(tok::r_paren)) {
922 Diag(Tok, diag::err_expected) << tok::r_paren;
923 return;
924 }
925 Lex(Tok);
926 }
927 if (Tok.isNot(tok::eod))
928 Diag(Tok.getLocation(), diag::ext_pp_extra_tokens_at_eol)
929 << "pragma hdrstop";
930
931 if (creatingPCHWithPragmaHdrStop() &&
932 SourceMgr.isInMainFile(Tok.getLocation())) {
933 assert(CurLexer && "no lexer for #pragma hdrstop processing");
934 Token &Result = Tok;
935 Result.startToken();
936 CurLexer->FormTokenWithChars(Result, CurLexer->BufferEnd, tok::eof);
937 CurLexer->cutOffLexing();
938 }
939 if (usingPCHWithPragmaHdrStop())
940 SkippingUntilPragmaHdrStop = false;
941 }
942
943 /// AddPragmaHandler - Add the specified pragma handler to the preprocessor.
944 /// If 'Namespace' is non-null, then it is a token required to exist on the
945 /// pragma line before the pragma string starts, e.g. "STDC" or "GCC".
AddPragmaHandler(StringRef Namespace,PragmaHandler * Handler)946 void Preprocessor::AddPragmaHandler(StringRef Namespace,
947 PragmaHandler *Handler) {
948 PragmaNamespace *InsertNS = PragmaHandlers.get();
949
950 // If this is specified to be in a namespace, step down into it.
951 if (!Namespace.empty()) {
952 // If there is already a pragma handler with the name of this namespace,
953 // we either have an error (directive with the same name as a namespace) or
954 // we already have the namespace to insert into.
955 if (PragmaHandler *Existing = PragmaHandlers->FindHandler(Namespace)) {
956 InsertNS = Existing->getIfNamespace();
957 assert(InsertNS != nullptr && "Cannot have a pragma namespace and pragma"
958 " handler with the same name!");
959 } else {
960 // Otherwise, this namespace doesn't exist yet, create and insert the
961 // handler for it.
962 InsertNS = new PragmaNamespace(Namespace);
963 PragmaHandlers->AddPragma(InsertNS);
964 }
965 }
966
967 // Check to make sure we don't already have a pragma for this identifier.
968 assert(!InsertNS->FindHandler(Handler->getName()) &&
969 "Pragma handler already exists for this identifier!");
970 InsertNS->AddPragma(Handler);
971 }
972
973 /// RemovePragmaHandler - Remove the specific pragma handler from the
974 /// preprocessor. If \arg Namespace is non-null, then it should be the
975 /// namespace that \arg Handler was added to. It is an error to remove
976 /// a handler that has not been registered.
RemovePragmaHandler(StringRef Namespace,PragmaHandler * Handler)977 void Preprocessor::RemovePragmaHandler(StringRef Namespace,
978 PragmaHandler *Handler) {
979 PragmaNamespace *NS = PragmaHandlers.get();
980
981 // If this is specified to be in a namespace, step down into it.
982 if (!Namespace.empty()) {
983 PragmaHandler *Existing = PragmaHandlers->FindHandler(Namespace);
984 assert(Existing && "Namespace containing handler does not exist!");
985
986 NS = Existing->getIfNamespace();
987 assert(NS && "Invalid namespace, registered as a regular pragma handler!");
988 }
989
990 NS->RemovePragmaHandler(Handler);
991
992 // If this is a non-default namespace and it is now empty, remove it.
993 if (NS != PragmaHandlers.get() && NS->IsEmpty()) {
994 PragmaHandlers->RemovePragmaHandler(NS);
995 delete NS;
996 }
997 }
998
LexOnOffSwitch(tok::OnOffSwitch & Result)999 bool Preprocessor::LexOnOffSwitch(tok::OnOffSwitch &Result) {
1000 Token Tok;
1001 LexUnexpandedToken(Tok);
1002
1003 if (Tok.isNot(tok::identifier)) {
1004 Diag(Tok, diag::ext_on_off_switch_syntax);
1005 return true;
1006 }
1007 IdentifierInfo *II = Tok.getIdentifierInfo();
1008 if (II->isStr("ON"))
1009 Result = tok::OOS_ON;
1010 else if (II->isStr("OFF"))
1011 Result = tok::OOS_OFF;
1012 else if (II->isStr("DEFAULT"))
1013 Result = tok::OOS_DEFAULT;
1014 else {
1015 Diag(Tok, diag::ext_on_off_switch_syntax);
1016 return true;
1017 }
1018
1019 // Verify that this is followed by EOD.
1020 LexUnexpandedToken(Tok);
1021 if (Tok.isNot(tok::eod))
1022 Diag(Tok, diag::ext_pragma_syntax_eod);
1023 return false;
1024 }
1025
1026 namespace {
1027
1028 /// PragmaOnceHandler - "\#pragma once" marks the file as atomically included.
1029 struct PragmaOnceHandler : public PragmaHandler {
PragmaOnceHandler__anon339268100311::PragmaOnceHandler1030 PragmaOnceHandler() : PragmaHandler("once") {}
1031
HandlePragma__anon339268100311::PragmaOnceHandler1032 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1033 Token &OnceTok) override {
1034 PP.CheckEndOfDirective("pragma once");
1035 PP.HandlePragmaOnce(OnceTok);
1036 }
1037 };
1038
1039 /// PragmaMarkHandler - "\#pragma mark ..." is ignored by the compiler, and the
1040 /// rest of the line is not lexed.
1041 struct PragmaMarkHandler : public PragmaHandler {
PragmaMarkHandler__anon339268100311::PragmaMarkHandler1042 PragmaMarkHandler() : PragmaHandler("mark") {}
1043
HandlePragma__anon339268100311::PragmaMarkHandler1044 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1045 Token &MarkTok) override {
1046 PP.HandlePragmaMark(MarkTok);
1047 }
1048 };
1049
1050 /// PragmaPoisonHandler - "\#pragma poison x" marks x as not usable.
1051 struct PragmaPoisonHandler : public PragmaHandler {
PragmaPoisonHandler__anon339268100311::PragmaPoisonHandler1052 PragmaPoisonHandler() : PragmaHandler("poison") {}
1053
HandlePragma__anon339268100311::PragmaPoisonHandler1054 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1055 Token &PoisonTok) override {
1056 PP.HandlePragmaPoison();
1057 }
1058 };
1059
1060 /// PragmaSystemHeaderHandler - "\#pragma system_header" marks the current file
1061 /// as a system header, which silences warnings in it.
1062 struct PragmaSystemHeaderHandler : public PragmaHandler {
PragmaSystemHeaderHandler__anon339268100311::PragmaSystemHeaderHandler1063 PragmaSystemHeaderHandler() : PragmaHandler("system_header") {}
1064
HandlePragma__anon339268100311::PragmaSystemHeaderHandler1065 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1066 Token &SHToken) override {
1067 PP.HandlePragmaSystemHeader(SHToken);
1068 PP.CheckEndOfDirective("pragma");
1069 }
1070 };
1071
1072 /// PragmaIncludeInsteadHandler - "\#pragma clang include_instead(header)" marks
1073 /// the current file as non-includable if the including header is not a system
1074 /// header.
1075 struct PragmaIncludeInsteadHandler : public PragmaHandler {
PragmaIncludeInsteadHandler__anon339268100311::PragmaIncludeInsteadHandler1076 PragmaIncludeInsteadHandler() : PragmaHandler("include_instead") {}
1077
HandlePragma__anon339268100311::PragmaIncludeInsteadHandler1078 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1079 Token &IIToken) override {
1080 PP.HandlePragmaIncludeInstead(IIToken);
1081 }
1082 };
1083
1084 struct PragmaDependencyHandler : public PragmaHandler {
PragmaDependencyHandler__anon339268100311::PragmaDependencyHandler1085 PragmaDependencyHandler() : PragmaHandler("dependency") {}
1086
HandlePragma__anon339268100311::PragmaDependencyHandler1087 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1088 Token &DepToken) override {
1089 PP.HandlePragmaDependency(DepToken);
1090 }
1091 };
1092
1093 struct PragmaDebugHandler : public PragmaHandler {
PragmaDebugHandler__anon339268100311::PragmaDebugHandler1094 PragmaDebugHandler() : PragmaHandler("__debug") {}
1095
HandlePragma__anon339268100311::PragmaDebugHandler1096 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1097 Token &DebugToken) override {
1098 Token Tok;
1099 PP.LexUnexpandedToken(Tok);
1100 if (Tok.isNot(tok::identifier)) {
1101 PP.Diag(Tok, diag::warn_pragma_diagnostic_invalid);
1102 return;
1103 }
1104 IdentifierInfo *II = Tok.getIdentifierInfo();
1105
1106 if (II->isStr("assert")) {
1107 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash)
1108 llvm_unreachable("This is an assertion!");
1109 } else if (II->isStr("crash")) {
1110 llvm::Timer T("crash", "pragma crash");
1111 llvm::TimeRegion R(&T);
1112 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash)
1113 LLVM_BUILTIN_TRAP;
1114 } else if (II->isStr("parser_crash")) {
1115 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash) {
1116 Token Crasher;
1117 Crasher.startToken();
1118 Crasher.setKind(tok::annot_pragma_parser_crash);
1119 Crasher.setAnnotationRange(SourceRange(Tok.getLocation()));
1120 PP.EnterToken(Crasher, /*IsReinject*/ false);
1121 }
1122 } else if (II->isStr("dump")) {
1123 Token Identifier;
1124 PP.LexUnexpandedToken(Identifier);
1125 if (auto *DumpII = Identifier.getIdentifierInfo()) {
1126 Token DumpAnnot;
1127 DumpAnnot.startToken();
1128 DumpAnnot.setKind(tok::annot_pragma_dump);
1129 DumpAnnot.setAnnotationRange(
1130 SourceRange(Tok.getLocation(), Identifier.getLocation()));
1131 DumpAnnot.setAnnotationValue(DumpII);
1132 PP.DiscardUntilEndOfDirective();
1133 PP.EnterToken(DumpAnnot, /*IsReinject*/false);
1134 } else {
1135 PP.Diag(Identifier, diag::warn_pragma_debug_missing_argument)
1136 << II->getName();
1137 }
1138 } else if (II->isStr("diag_mapping")) {
1139 Token DiagName;
1140 PP.LexUnexpandedToken(DiagName);
1141 if (DiagName.is(tok::eod))
1142 PP.getDiagnostics().dump();
1143 else if (DiagName.is(tok::string_literal) && !DiagName.hasUDSuffix()) {
1144 StringLiteralParser Literal(DiagName, PP);
1145 if (Literal.hadError)
1146 return;
1147 PP.getDiagnostics().dump(Literal.GetString());
1148 } else {
1149 PP.Diag(DiagName, diag::warn_pragma_debug_missing_argument)
1150 << II->getName();
1151 }
1152 } else if (II->isStr("llvm_fatal_error")) {
1153 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash)
1154 llvm::report_fatal_error("#pragma clang __debug llvm_fatal_error");
1155 } else if (II->isStr("llvm_unreachable")) {
1156 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash)
1157 llvm_unreachable("#pragma clang __debug llvm_unreachable");
1158 } else if (II->isStr("macro")) {
1159 Token MacroName;
1160 PP.LexUnexpandedToken(MacroName);
1161 auto *MacroII = MacroName.getIdentifierInfo();
1162 if (MacroII)
1163 PP.dumpMacroInfo(MacroII);
1164 else
1165 PP.Diag(MacroName, diag::warn_pragma_debug_missing_argument)
1166 << II->getName();
1167 } else if (II->isStr("module_map")) {
1168 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 8>
1169 ModuleName;
1170 if (LexModuleName(PP, Tok, ModuleName))
1171 return;
1172 ModuleMap &MM = PP.getHeaderSearchInfo().getModuleMap();
1173 Module *M = nullptr;
1174 for (auto IIAndLoc : ModuleName) {
1175 M = MM.lookupModuleQualified(IIAndLoc.first->getName(), M);
1176 if (!M) {
1177 PP.Diag(IIAndLoc.second, diag::warn_pragma_debug_unknown_module)
1178 << IIAndLoc.first;
1179 return;
1180 }
1181 }
1182 M->dump();
1183 } else if (II->isStr("overflow_stack")) {
1184 if (!PP.getPreprocessorOpts().DisablePragmaDebugCrash)
1185 DebugOverflowStack();
1186 } else if (II->isStr("captured")) {
1187 HandleCaptured(PP);
1188 } else if (II->isStr("modules")) {
1189 struct ModuleVisitor {
1190 Preprocessor &PP;
1191 void visit(Module *M, bool VisibleOnly) {
1192 SourceLocation ImportLoc = PP.getModuleImportLoc(M);
1193 if (!VisibleOnly || ImportLoc.isValid()) {
1194 llvm::errs() << M->getFullModuleName() << " ";
1195 if (ImportLoc.isValid()) {
1196 llvm::errs() << M << " visible ";
1197 ImportLoc.print(llvm::errs(), PP.getSourceManager());
1198 }
1199 llvm::errs() << "\n";
1200 }
1201 for (Module *Sub : M->submodules()) {
1202 if (!VisibleOnly || ImportLoc.isInvalid() || Sub->IsExplicit)
1203 visit(Sub, VisibleOnly);
1204 }
1205 }
1206 void visitAll(bool VisibleOnly) {
1207 for (auto &NameAndMod :
1208 PP.getHeaderSearchInfo().getModuleMap().modules())
1209 visit(NameAndMod.second, VisibleOnly);
1210 }
1211 } Visitor{PP};
1212
1213 Token Kind;
1214 PP.LexUnexpandedToken(Kind);
1215 auto *DumpII = Kind.getIdentifierInfo();
1216 if (!DumpII) {
1217 PP.Diag(Kind, diag::warn_pragma_debug_missing_argument)
1218 << II->getName();
1219 } else if (DumpII->isStr("all")) {
1220 Visitor.visitAll(false);
1221 } else if (DumpII->isStr("visible")) {
1222 Visitor.visitAll(true);
1223 } else if (DumpII->isStr("building")) {
1224 for (auto &Building : PP.getBuildingSubmodules()) {
1225 llvm::errs() << "in " << Building.M->getFullModuleName();
1226 if (Building.ImportLoc.isValid()) {
1227 llvm::errs() << " imported ";
1228 if (Building.IsPragma)
1229 llvm::errs() << "via pragma ";
1230 llvm::errs() << "at ";
1231 Building.ImportLoc.print(llvm::errs(), PP.getSourceManager());
1232 llvm::errs() << "\n";
1233 }
1234 }
1235 } else {
1236 PP.Diag(Tok, diag::warn_pragma_debug_unexpected_command)
1237 << DumpII->getName();
1238 }
1239 } else {
1240 PP.Diag(Tok, diag::warn_pragma_debug_unexpected_command)
1241 << II->getName();
1242 }
1243
1244 PPCallbacks *Callbacks = PP.getPPCallbacks();
1245 if (Callbacks)
1246 Callbacks->PragmaDebug(Tok.getLocation(), II->getName());
1247 }
1248
HandleCaptured__anon339268100311::PragmaDebugHandler1249 void HandleCaptured(Preprocessor &PP) {
1250 Token Tok;
1251 PP.LexUnexpandedToken(Tok);
1252
1253 if (Tok.isNot(tok::eod)) {
1254 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol)
1255 << "pragma clang __debug captured";
1256 return;
1257 }
1258
1259 SourceLocation NameLoc = Tok.getLocation();
1260 MutableArrayRef<Token> Toks(
1261 PP.getPreprocessorAllocator().Allocate<Token>(1), 1);
1262 Toks[0].startToken();
1263 Toks[0].setKind(tok::annot_pragma_captured);
1264 Toks[0].setLocation(NameLoc);
1265
1266 PP.EnterTokenStream(Toks, /*DisableMacroExpansion=*/true,
1267 /*IsReinject=*/false);
1268 }
1269
1270 // Disable MSVC warning about runtime stack overflow.
1271 #ifdef _MSC_VER
1272 #pragma warning(disable : 4717)
1273 #endif
DebugOverflowStack__anon339268100311::PragmaDebugHandler1274 static void DebugOverflowStack(void (*P)() = nullptr) {
1275 void (*volatile Self)(void(*P)()) = DebugOverflowStack;
1276 Self(reinterpret_cast<void(*)()>(Self));
1277 }
1278 #ifdef _MSC_VER
1279 #pragma warning(default : 4717)
1280 #endif
1281 };
1282
1283 /// PragmaDiagnosticHandler - e.g. '\#pragma GCC diagnostic ignored "-Wformat"'
1284 struct PragmaDiagnosticHandler : public PragmaHandler {
1285 private:
1286 const char *Namespace;
1287
1288 public:
PragmaDiagnosticHandler__anon339268100311::PragmaDiagnosticHandler1289 explicit PragmaDiagnosticHandler(const char *NS)
1290 : PragmaHandler("diagnostic"), Namespace(NS) {}
1291
HandlePragma__anon339268100311::PragmaDiagnosticHandler1292 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1293 Token &DiagToken) override {
1294 SourceLocation DiagLoc = DiagToken.getLocation();
1295 Token Tok;
1296 PP.LexUnexpandedToken(Tok);
1297 if (Tok.isNot(tok::identifier)) {
1298 PP.Diag(Tok, diag::warn_pragma_diagnostic_invalid);
1299 return;
1300 }
1301 IdentifierInfo *II = Tok.getIdentifierInfo();
1302 PPCallbacks *Callbacks = PP.getPPCallbacks();
1303
1304 if (II->isStr("pop")) {
1305 if (!PP.getDiagnostics().popMappings(DiagLoc))
1306 PP.Diag(Tok, diag::warn_pragma_diagnostic_cannot_pop);
1307 else if (Callbacks)
1308 Callbacks->PragmaDiagnosticPop(DiagLoc, Namespace);
1309 return;
1310 } else if (II->isStr("push")) {
1311 PP.getDiagnostics().pushMappings(DiagLoc);
1312 if (Callbacks)
1313 Callbacks->PragmaDiagnosticPush(DiagLoc, Namespace);
1314 return;
1315 }
1316
1317 diag::Severity SV = llvm::StringSwitch<diag::Severity>(II->getName())
1318 .Case("ignored", diag::Severity::Ignored)
1319 .Case("warning", diag::Severity::Warning)
1320 .Case("error", diag::Severity::Error)
1321 .Case("fatal", diag::Severity::Fatal)
1322 .Default(diag::Severity());
1323
1324 if (SV == diag::Severity()) {
1325 PP.Diag(Tok, diag::warn_pragma_diagnostic_invalid);
1326 return;
1327 }
1328
1329 PP.LexUnexpandedToken(Tok);
1330 SourceLocation StringLoc = Tok.getLocation();
1331
1332 std::string WarningName;
1333 if (!PP.FinishLexStringLiteral(Tok, WarningName, "pragma diagnostic",
1334 /*AllowMacroExpansion=*/false))
1335 return;
1336
1337 if (Tok.isNot(tok::eod)) {
1338 PP.Diag(Tok.getLocation(), diag::warn_pragma_diagnostic_invalid_token);
1339 return;
1340 }
1341
1342 if (WarningName.size() < 3 || WarningName[0] != '-' ||
1343 (WarningName[1] != 'W' && WarningName[1] != 'R')) {
1344 PP.Diag(StringLoc, diag::warn_pragma_diagnostic_invalid_option);
1345 return;
1346 }
1347
1348 diag::Flavor Flavor = WarningName[1] == 'W' ? diag::Flavor::WarningOrError
1349 : diag::Flavor::Remark;
1350 StringRef Group = StringRef(WarningName).substr(2);
1351 bool unknownDiag = false;
1352 if (Group == "everything") {
1353 // Special handling for pragma clang diagnostic ... "-Weverything".
1354 // There is no formal group named "everything", so there has to be a
1355 // special case for it.
1356 PP.getDiagnostics().setSeverityForAll(Flavor, SV, DiagLoc);
1357 } else
1358 unknownDiag = PP.getDiagnostics().setSeverityForGroup(Flavor, Group, SV,
1359 DiagLoc);
1360 if (unknownDiag)
1361 PP.Diag(StringLoc, diag::warn_pragma_diagnostic_unknown_warning)
1362 << WarningName;
1363 else if (Callbacks)
1364 Callbacks->PragmaDiagnostic(DiagLoc, Namespace, SV, WarningName);
1365 }
1366 };
1367
1368 /// "\#pragma hdrstop [<header-name-string>]"
1369 struct PragmaHdrstopHandler : public PragmaHandler {
PragmaHdrstopHandler__anon339268100311::PragmaHdrstopHandler1370 PragmaHdrstopHandler() : PragmaHandler("hdrstop") {}
HandlePragma__anon339268100311::PragmaHdrstopHandler1371 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1372 Token &DepToken) override {
1373 PP.HandlePragmaHdrstop(DepToken);
1374 }
1375 };
1376
1377 /// "\#pragma warning(...)". MSVC's diagnostics do not map cleanly to clang's
1378 /// diagnostics, so we don't really implement this pragma. We parse it and
1379 /// ignore it to avoid -Wunknown-pragma warnings.
1380 struct PragmaWarningHandler : public PragmaHandler {
PragmaWarningHandler__anon339268100311::PragmaWarningHandler1381 PragmaWarningHandler() : PragmaHandler("warning") {}
1382
HandlePragma__anon339268100311::PragmaWarningHandler1383 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1384 Token &Tok) override {
1385 // Parse things like:
1386 // warning(push, 1)
1387 // warning(pop)
1388 // warning(disable : 1 2 3 ; error : 4 5 6 ; suppress : 7 8 9)
1389 SourceLocation DiagLoc = Tok.getLocation();
1390 PPCallbacks *Callbacks = PP.getPPCallbacks();
1391
1392 PP.Lex(Tok);
1393 if (Tok.isNot(tok::l_paren)) {
1394 PP.Diag(Tok, diag::warn_pragma_warning_expected) << "(";
1395 return;
1396 }
1397
1398 PP.Lex(Tok);
1399 IdentifierInfo *II = Tok.getIdentifierInfo();
1400
1401 if (II && II->isStr("push")) {
1402 // #pragma warning( push[ ,n ] )
1403 int Level = -1;
1404 PP.Lex(Tok);
1405 if (Tok.is(tok::comma)) {
1406 PP.Lex(Tok);
1407 uint64_t Value;
1408 if (Tok.is(tok::numeric_constant) &&
1409 PP.parseSimpleIntegerLiteral(Tok, Value))
1410 Level = int(Value);
1411 if (Level < 0 || Level > 4) {
1412 PP.Diag(Tok, diag::warn_pragma_warning_push_level);
1413 return;
1414 }
1415 }
1416 if (Callbacks)
1417 Callbacks->PragmaWarningPush(DiagLoc, Level);
1418 } else if (II && II->isStr("pop")) {
1419 // #pragma warning( pop )
1420 PP.Lex(Tok);
1421 if (Callbacks)
1422 Callbacks->PragmaWarningPop(DiagLoc);
1423 } else {
1424 // #pragma warning( warning-specifier : warning-number-list
1425 // [; warning-specifier : warning-number-list...] )
1426 while (true) {
1427 II = Tok.getIdentifierInfo();
1428 if (!II && !Tok.is(tok::numeric_constant)) {
1429 PP.Diag(Tok, diag::warn_pragma_warning_spec_invalid);
1430 return;
1431 }
1432
1433 // Figure out which warning specifier this is.
1434 bool SpecifierValid;
1435 StringRef Specifier;
1436 llvm::SmallString<1> SpecifierBuf;
1437 if (II) {
1438 Specifier = II->getName();
1439 SpecifierValid = llvm::StringSwitch<bool>(Specifier)
1440 .Cases("default", "disable", "error", "once",
1441 "suppress", true)
1442 .Default(false);
1443 // If we read a correct specifier, snatch next token (that should be
1444 // ":", checked later).
1445 if (SpecifierValid)
1446 PP.Lex(Tok);
1447 } else {
1448 // Token is a numeric constant. It should be either 1, 2, 3 or 4.
1449 uint64_t Value;
1450 Specifier = PP.getSpelling(Tok, SpecifierBuf);
1451 if (PP.parseSimpleIntegerLiteral(Tok, Value)) {
1452 SpecifierValid = (Value >= 1) && (Value <= 4);
1453 } else
1454 SpecifierValid = false;
1455 // Next token already snatched by parseSimpleIntegerLiteral.
1456 }
1457
1458 if (!SpecifierValid) {
1459 PP.Diag(Tok, diag::warn_pragma_warning_spec_invalid);
1460 return;
1461 }
1462 if (Tok.isNot(tok::colon)) {
1463 PP.Diag(Tok, diag::warn_pragma_warning_expected) << ":";
1464 return;
1465 }
1466
1467 // Collect the warning ids.
1468 SmallVector<int, 4> Ids;
1469 PP.Lex(Tok);
1470 while (Tok.is(tok::numeric_constant)) {
1471 uint64_t Value;
1472 if (!PP.parseSimpleIntegerLiteral(Tok, Value) || Value == 0 ||
1473 Value > INT_MAX) {
1474 PP.Diag(Tok, diag::warn_pragma_warning_expected_number);
1475 return;
1476 }
1477 Ids.push_back(int(Value));
1478 }
1479 if (Callbacks)
1480 Callbacks->PragmaWarning(DiagLoc, Specifier, Ids);
1481
1482 // Parse the next specifier if there is a semicolon.
1483 if (Tok.isNot(tok::semi))
1484 break;
1485 PP.Lex(Tok);
1486 }
1487 }
1488
1489 if (Tok.isNot(tok::r_paren)) {
1490 PP.Diag(Tok, diag::warn_pragma_warning_expected) << ")";
1491 return;
1492 }
1493
1494 PP.Lex(Tok);
1495 if (Tok.isNot(tok::eod))
1496 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma warning";
1497 }
1498 };
1499
1500 /// "\#pragma execution_character_set(...)". MSVC supports this pragma only
1501 /// for "UTF-8". We parse it and ignore it if UTF-8 is provided and warn
1502 /// otherwise to avoid -Wunknown-pragma warnings.
1503 struct PragmaExecCharsetHandler : public PragmaHandler {
PragmaExecCharsetHandler__anon339268100311::PragmaExecCharsetHandler1504 PragmaExecCharsetHandler() : PragmaHandler("execution_character_set") {}
1505
HandlePragma__anon339268100311::PragmaExecCharsetHandler1506 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1507 Token &Tok) override {
1508 // Parse things like:
1509 // execution_character_set(push, "UTF-8")
1510 // execution_character_set(pop)
1511 SourceLocation DiagLoc = Tok.getLocation();
1512 PPCallbacks *Callbacks = PP.getPPCallbacks();
1513
1514 PP.Lex(Tok);
1515 if (Tok.isNot(tok::l_paren)) {
1516 PP.Diag(Tok, diag::warn_pragma_exec_charset_expected) << "(";
1517 return;
1518 }
1519
1520 PP.Lex(Tok);
1521 IdentifierInfo *II = Tok.getIdentifierInfo();
1522
1523 if (II && II->isStr("push")) {
1524 // #pragma execution_character_set( push[ , string ] )
1525 PP.Lex(Tok);
1526 if (Tok.is(tok::comma)) {
1527 PP.Lex(Tok);
1528
1529 std::string ExecCharset;
1530 if (!PP.FinishLexStringLiteral(Tok, ExecCharset,
1531 "pragma execution_character_set",
1532 /*AllowMacroExpansion=*/false))
1533 return;
1534
1535 // MSVC supports either of these, but nothing else.
1536 if (ExecCharset != "UTF-8" && ExecCharset != "utf-8") {
1537 PP.Diag(Tok, diag::warn_pragma_exec_charset_push_invalid) << ExecCharset;
1538 return;
1539 }
1540 }
1541 if (Callbacks)
1542 Callbacks->PragmaExecCharsetPush(DiagLoc, "UTF-8");
1543 } else if (II && II->isStr("pop")) {
1544 // #pragma execution_character_set( pop )
1545 PP.Lex(Tok);
1546 if (Callbacks)
1547 Callbacks->PragmaExecCharsetPop(DiagLoc);
1548 } else {
1549 PP.Diag(Tok, diag::warn_pragma_exec_charset_spec_invalid);
1550 return;
1551 }
1552
1553 if (Tok.isNot(tok::r_paren)) {
1554 PP.Diag(Tok, diag::warn_pragma_exec_charset_expected) << ")";
1555 return;
1556 }
1557
1558 PP.Lex(Tok);
1559 if (Tok.isNot(tok::eod))
1560 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma execution_character_set";
1561 }
1562 };
1563
1564 /// PragmaIncludeAliasHandler - "\#pragma include_alias("...")".
1565 struct PragmaIncludeAliasHandler : public PragmaHandler {
PragmaIncludeAliasHandler__anon339268100311::PragmaIncludeAliasHandler1566 PragmaIncludeAliasHandler() : PragmaHandler("include_alias") {}
1567
HandlePragma__anon339268100311::PragmaIncludeAliasHandler1568 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1569 Token &IncludeAliasTok) override {
1570 PP.HandlePragmaIncludeAlias(IncludeAliasTok);
1571 }
1572 };
1573
1574 /// PragmaMessageHandler - Handle the microsoft and gcc \#pragma message
1575 /// extension. The syntax is:
1576 /// \code
1577 /// #pragma message(string)
1578 /// \endcode
1579 /// OR, in GCC mode:
1580 /// \code
1581 /// #pragma message string
1582 /// \endcode
1583 /// string is a string, which is fully macro expanded, and permits string
1584 /// concatenation, embedded escape characters, etc... See MSDN for more details.
1585 /// Also handles \#pragma GCC warning and \#pragma GCC error which take the same
1586 /// form as \#pragma message.
1587 struct PragmaMessageHandler : public PragmaHandler {
1588 private:
1589 const PPCallbacks::PragmaMessageKind Kind;
1590 const StringRef Namespace;
1591
PragmaKind__anon339268100311::PragmaMessageHandler1592 static const char* PragmaKind(PPCallbacks::PragmaMessageKind Kind,
1593 bool PragmaNameOnly = false) {
1594 switch (Kind) {
1595 case PPCallbacks::PMK_Message:
1596 return PragmaNameOnly ? "message" : "pragma message";
1597 case PPCallbacks::PMK_Warning:
1598 return PragmaNameOnly ? "warning" : "pragma warning";
1599 case PPCallbacks::PMK_Error:
1600 return PragmaNameOnly ? "error" : "pragma error";
1601 }
1602 llvm_unreachable("Unknown PragmaMessageKind!");
1603 }
1604
1605 public:
PragmaMessageHandler__anon339268100311::PragmaMessageHandler1606 PragmaMessageHandler(PPCallbacks::PragmaMessageKind Kind,
1607 StringRef Namespace = StringRef())
1608 : PragmaHandler(PragmaKind(Kind, true)), Kind(Kind),
1609 Namespace(Namespace) {}
1610
HandlePragma__anon339268100311::PragmaMessageHandler1611 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1612 Token &Tok) override {
1613 SourceLocation MessageLoc = Tok.getLocation();
1614 PP.Lex(Tok);
1615 bool ExpectClosingParen = false;
1616 switch (Tok.getKind()) {
1617 case tok::l_paren:
1618 // We have a MSVC style pragma message.
1619 ExpectClosingParen = true;
1620 // Read the string.
1621 PP.Lex(Tok);
1622 break;
1623 case tok::string_literal:
1624 // We have a GCC style pragma message, and we just read the string.
1625 break;
1626 default:
1627 PP.Diag(MessageLoc, diag::err_pragma_message_malformed) << Kind;
1628 return;
1629 }
1630
1631 std::string MessageString;
1632 if (!PP.FinishLexStringLiteral(Tok, MessageString, PragmaKind(Kind),
1633 /*AllowMacroExpansion=*/true))
1634 return;
1635
1636 if (ExpectClosingParen) {
1637 if (Tok.isNot(tok::r_paren)) {
1638 PP.Diag(Tok.getLocation(), diag::err_pragma_message_malformed) << Kind;
1639 return;
1640 }
1641 PP.Lex(Tok); // eat the r_paren.
1642 }
1643
1644 if (Tok.isNot(tok::eod)) {
1645 PP.Diag(Tok.getLocation(), diag::err_pragma_message_malformed) << Kind;
1646 return;
1647 }
1648
1649 // Output the message.
1650 PP.Diag(MessageLoc, (Kind == PPCallbacks::PMK_Error)
1651 ? diag::err_pragma_message
1652 : diag::warn_pragma_message) << MessageString;
1653
1654 // If the pragma is lexically sound, notify any interested PPCallbacks.
1655 if (PPCallbacks *Callbacks = PP.getPPCallbacks())
1656 Callbacks->PragmaMessage(MessageLoc, Namespace, Kind, MessageString);
1657 }
1658 };
1659
1660 /// Handle the clang \#pragma module import extension. The syntax is:
1661 /// \code
1662 /// #pragma clang module import some.module.name
1663 /// \endcode
1664 struct PragmaModuleImportHandler : public PragmaHandler {
PragmaModuleImportHandler__anon339268100311::PragmaModuleImportHandler1665 PragmaModuleImportHandler() : PragmaHandler("import") {}
1666
HandlePragma__anon339268100311::PragmaModuleImportHandler1667 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1668 Token &Tok) override {
1669 SourceLocation ImportLoc = Tok.getLocation();
1670
1671 // Read the module name.
1672 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 8>
1673 ModuleName;
1674 if (LexModuleName(PP, Tok, ModuleName))
1675 return;
1676
1677 if (Tok.isNot(tok::eod))
1678 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1679
1680 // If we have a non-empty module path, load the named module.
1681 Module *Imported =
1682 PP.getModuleLoader().loadModule(ImportLoc, ModuleName, Module::Hidden,
1683 /*IsInclusionDirective=*/false);
1684 if (!Imported)
1685 return;
1686
1687 PP.makeModuleVisible(Imported, ImportLoc);
1688 PP.EnterAnnotationToken(SourceRange(ImportLoc, ModuleName.back().second),
1689 tok::annot_module_include, Imported);
1690 if (auto *CB = PP.getPPCallbacks())
1691 CB->moduleImport(ImportLoc, ModuleName, Imported);
1692 }
1693 };
1694
1695 /// Handle the clang \#pragma module begin extension. The syntax is:
1696 /// \code
1697 /// #pragma clang module begin some.module.name
1698 /// ...
1699 /// #pragma clang module end
1700 /// \endcode
1701 struct PragmaModuleBeginHandler : public PragmaHandler {
PragmaModuleBeginHandler__anon339268100311::PragmaModuleBeginHandler1702 PragmaModuleBeginHandler() : PragmaHandler("begin") {}
1703
HandlePragma__anon339268100311::PragmaModuleBeginHandler1704 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1705 Token &Tok) override {
1706 SourceLocation BeginLoc = Tok.getLocation();
1707
1708 // Read the module name.
1709 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 8>
1710 ModuleName;
1711 if (LexModuleName(PP, Tok, ModuleName))
1712 return;
1713
1714 if (Tok.isNot(tok::eod))
1715 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1716
1717 // We can only enter submodules of the current module.
1718 StringRef Current = PP.getLangOpts().CurrentModule;
1719 if (ModuleName.front().first->getName() != Current) {
1720 PP.Diag(ModuleName.front().second, diag::err_pp_module_begin_wrong_module)
1721 << ModuleName.front().first << (ModuleName.size() > 1)
1722 << Current.empty() << Current;
1723 return;
1724 }
1725
1726 // Find the module we're entering. We require that a module map for it
1727 // be loaded or implicitly loadable.
1728 auto &HSI = PP.getHeaderSearchInfo();
1729 Module *M = HSI.lookupModule(Current);
1730 if (!M) {
1731 PP.Diag(ModuleName.front().second,
1732 diag::err_pp_module_begin_no_module_map) << Current;
1733 return;
1734 }
1735 for (unsigned I = 1; I != ModuleName.size(); ++I) {
1736 auto *NewM = M->findOrInferSubmodule(ModuleName[I].first->getName());
1737 if (!NewM) {
1738 PP.Diag(ModuleName[I].second, diag::err_pp_module_begin_no_submodule)
1739 << M->getFullModuleName() << ModuleName[I].first;
1740 return;
1741 }
1742 M = NewM;
1743 }
1744
1745 // If the module isn't available, it doesn't make sense to enter it.
1746 if (Preprocessor::checkModuleIsAvailable(
1747 PP.getLangOpts(), PP.getTargetInfo(), PP.getDiagnostics(), M)) {
1748 PP.Diag(BeginLoc, diag::note_pp_module_begin_here)
1749 << M->getTopLevelModuleName();
1750 return;
1751 }
1752
1753 // Enter the scope of the submodule.
1754 PP.EnterSubmodule(M, BeginLoc, /*ForPragma*/true);
1755 PP.EnterAnnotationToken(SourceRange(BeginLoc, ModuleName.back().second),
1756 tok::annot_module_begin, M);
1757 }
1758 };
1759
1760 /// Handle the clang \#pragma module end extension.
1761 struct PragmaModuleEndHandler : public PragmaHandler {
PragmaModuleEndHandler__anon339268100311::PragmaModuleEndHandler1762 PragmaModuleEndHandler() : PragmaHandler("end") {}
1763
HandlePragma__anon339268100311::PragmaModuleEndHandler1764 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1765 Token &Tok) override {
1766 SourceLocation Loc = Tok.getLocation();
1767
1768 PP.LexUnexpandedToken(Tok);
1769 if (Tok.isNot(tok::eod))
1770 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1771
1772 Module *M = PP.LeaveSubmodule(/*ForPragma*/true);
1773 if (M)
1774 PP.EnterAnnotationToken(SourceRange(Loc), tok::annot_module_end, M);
1775 else
1776 PP.Diag(Loc, diag::err_pp_module_end_without_module_begin);
1777 }
1778 };
1779
1780 /// Handle the clang \#pragma module build extension.
1781 struct PragmaModuleBuildHandler : public PragmaHandler {
PragmaModuleBuildHandler__anon339268100311::PragmaModuleBuildHandler1782 PragmaModuleBuildHandler() : PragmaHandler("build") {}
1783
HandlePragma__anon339268100311::PragmaModuleBuildHandler1784 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1785 Token &Tok) override {
1786 PP.HandlePragmaModuleBuild(Tok);
1787 }
1788 };
1789
1790 /// Handle the clang \#pragma module load extension.
1791 struct PragmaModuleLoadHandler : public PragmaHandler {
PragmaModuleLoadHandler__anon339268100311::PragmaModuleLoadHandler1792 PragmaModuleLoadHandler() : PragmaHandler("load") {}
1793
HandlePragma__anon339268100311::PragmaModuleLoadHandler1794 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1795 Token &Tok) override {
1796 SourceLocation Loc = Tok.getLocation();
1797
1798 // Read the module name.
1799 llvm::SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 8>
1800 ModuleName;
1801 if (LexModuleName(PP, Tok, ModuleName))
1802 return;
1803
1804 if (Tok.isNot(tok::eod))
1805 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1806
1807 // Load the module, don't make it visible.
1808 PP.getModuleLoader().loadModule(Loc, ModuleName, Module::Hidden,
1809 /*IsInclusionDirective=*/false);
1810 }
1811 };
1812
1813 /// PragmaPushMacroHandler - "\#pragma push_macro" saves the value of the
1814 /// macro on the top of the stack.
1815 struct PragmaPushMacroHandler : public PragmaHandler {
PragmaPushMacroHandler__anon339268100311::PragmaPushMacroHandler1816 PragmaPushMacroHandler() : PragmaHandler("push_macro") {}
1817
HandlePragma__anon339268100311::PragmaPushMacroHandler1818 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1819 Token &PushMacroTok) override {
1820 PP.HandlePragmaPushMacro(PushMacroTok);
1821 }
1822 };
1823
1824 /// PragmaPopMacroHandler - "\#pragma pop_macro" sets the value of the
1825 /// macro to the value on the top of the stack.
1826 struct PragmaPopMacroHandler : public PragmaHandler {
PragmaPopMacroHandler__anon339268100311::PragmaPopMacroHandler1827 PragmaPopMacroHandler() : PragmaHandler("pop_macro") {}
1828
HandlePragma__anon339268100311::PragmaPopMacroHandler1829 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1830 Token &PopMacroTok) override {
1831 PP.HandlePragmaPopMacro(PopMacroTok);
1832 }
1833 };
1834
1835 /// PragmaARCCFCodeAuditedHandler -
1836 /// \#pragma clang arc_cf_code_audited begin/end
1837 struct PragmaARCCFCodeAuditedHandler : public PragmaHandler {
PragmaARCCFCodeAuditedHandler__anon339268100311::PragmaARCCFCodeAuditedHandler1838 PragmaARCCFCodeAuditedHandler() : PragmaHandler("arc_cf_code_audited") {}
1839
HandlePragma__anon339268100311::PragmaARCCFCodeAuditedHandler1840 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1841 Token &NameTok) override {
1842 SourceLocation Loc = NameTok.getLocation();
1843 bool IsBegin;
1844
1845 Token Tok;
1846
1847 // Lex the 'begin' or 'end'.
1848 PP.LexUnexpandedToken(Tok);
1849 const IdentifierInfo *BeginEnd = Tok.getIdentifierInfo();
1850 if (BeginEnd && BeginEnd->isStr("begin")) {
1851 IsBegin = true;
1852 } else if (BeginEnd && BeginEnd->isStr("end")) {
1853 IsBegin = false;
1854 } else {
1855 PP.Diag(Tok.getLocation(), diag::err_pp_arc_cf_code_audited_syntax);
1856 return;
1857 }
1858
1859 // Verify that this is followed by EOD.
1860 PP.LexUnexpandedToken(Tok);
1861 if (Tok.isNot(tok::eod))
1862 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1863
1864 // The start location of the active audit.
1865 SourceLocation BeginLoc = PP.getPragmaARCCFCodeAuditedInfo().second;
1866
1867 // The start location we want after processing this.
1868 SourceLocation NewLoc;
1869
1870 if (IsBegin) {
1871 // Complain about attempts to re-enter an audit.
1872 if (BeginLoc.isValid()) {
1873 PP.Diag(Loc, diag::err_pp_double_begin_of_arc_cf_code_audited);
1874 PP.Diag(BeginLoc, diag::note_pragma_entered_here);
1875 }
1876 NewLoc = Loc;
1877 } else {
1878 // Complain about attempts to leave an audit that doesn't exist.
1879 if (!BeginLoc.isValid()) {
1880 PP.Diag(Loc, diag::err_pp_unmatched_end_of_arc_cf_code_audited);
1881 return;
1882 }
1883 NewLoc = SourceLocation();
1884 }
1885
1886 PP.setPragmaARCCFCodeAuditedInfo(NameTok.getIdentifierInfo(), NewLoc);
1887 }
1888 };
1889
1890 /// PragmaAssumeNonNullHandler -
1891 /// \#pragma clang assume_nonnull begin/end
1892 struct PragmaAssumeNonNullHandler : public PragmaHandler {
PragmaAssumeNonNullHandler__anon339268100311::PragmaAssumeNonNullHandler1893 PragmaAssumeNonNullHandler() : PragmaHandler("assume_nonnull") {}
1894
HandlePragma__anon339268100311::PragmaAssumeNonNullHandler1895 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1896 Token &NameTok) override {
1897 SourceLocation Loc = NameTok.getLocation();
1898 bool IsBegin;
1899
1900 Token Tok;
1901
1902 // Lex the 'begin' or 'end'.
1903 PP.LexUnexpandedToken(Tok);
1904 const IdentifierInfo *BeginEnd = Tok.getIdentifierInfo();
1905 if (BeginEnd && BeginEnd->isStr("begin")) {
1906 IsBegin = true;
1907 } else if (BeginEnd && BeginEnd->isStr("end")) {
1908 IsBegin = false;
1909 } else {
1910 PP.Diag(Tok.getLocation(), diag::err_pp_assume_nonnull_syntax);
1911 return;
1912 }
1913
1914 // Verify that this is followed by EOD.
1915 PP.LexUnexpandedToken(Tok);
1916 if (Tok.isNot(tok::eod))
1917 PP.Diag(Tok, diag::ext_pp_extra_tokens_at_eol) << "pragma";
1918
1919 // The start location of the active audit.
1920 SourceLocation BeginLoc = PP.getPragmaAssumeNonNullLoc();
1921
1922 // The start location we want after processing this.
1923 SourceLocation NewLoc;
1924 PPCallbacks *Callbacks = PP.getPPCallbacks();
1925
1926 if (IsBegin) {
1927 // Complain about attempts to re-enter an audit.
1928 if (BeginLoc.isValid()) {
1929 PP.Diag(Loc, diag::err_pp_double_begin_of_assume_nonnull);
1930 PP.Diag(BeginLoc, diag::note_pragma_entered_here);
1931 }
1932 NewLoc = Loc;
1933 if (Callbacks)
1934 Callbacks->PragmaAssumeNonNullBegin(NewLoc);
1935 } else {
1936 // Complain about attempts to leave an audit that doesn't exist.
1937 if (!BeginLoc.isValid()) {
1938 PP.Diag(Loc, diag::err_pp_unmatched_end_of_assume_nonnull);
1939 return;
1940 }
1941 NewLoc = SourceLocation();
1942 if (Callbacks)
1943 Callbacks->PragmaAssumeNonNullEnd(NewLoc);
1944 }
1945
1946 PP.setPragmaAssumeNonNullLoc(NewLoc);
1947 }
1948 };
1949
1950 /// Handle "\#pragma region [...]"
1951 ///
1952 /// The syntax is
1953 /// \code
1954 /// #pragma region [optional name]
1955 /// #pragma endregion [optional comment]
1956 /// \endcode
1957 ///
1958 /// \note This is
1959 /// <a href="http://msdn.microsoft.com/en-us/library/b6xkz944(v=vs.80).aspx">editor-only</a>
1960 /// pragma, just skipped by compiler.
1961 struct PragmaRegionHandler : public PragmaHandler {
PragmaRegionHandler__anon339268100311::PragmaRegionHandler1962 PragmaRegionHandler(const char *pragma) : PragmaHandler(pragma) {}
1963
HandlePragma__anon339268100311::PragmaRegionHandler1964 void HandlePragma(Preprocessor &PP, PragmaIntroducer Introducer,
1965 Token &NameTok) override {
1966 // #pragma region: endregion matches can be verified
1967 // __pragma(region): no sense, but ignored by msvc
1968 // _Pragma is not valid for MSVC, but there isn't any point
1969 // to handle a _Pragma differently.
1970 }
1971 };
1972
1973 } // namespace
1974
1975 /// RegisterBuiltinPragmas - Install the standard preprocessor pragmas:
1976 /// \#pragma GCC poison/system_header/dependency and \#pragma once.
RegisterBuiltinPragmas()1977 void Preprocessor::RegisterBuiltinPragmas() {
1978 AddPragmaHandler(new PragmaOnceHandler());
1979 AddPragmaHandler(new PragmaMarkHandler());
1980 AddPragmaHandler(new PragmaPushMacroHandler());
1981 AddPragmaHandler(new PragmaPopMacroHandler());
1982 AddPragmaHandler(new PragmaMessageHandler(PPCallbacks::PMK_Message));
1983
1984 // #pragma GCC ...
1985 AddPragmaHandler("GCC", new PragmaPoisonHandler());
1986 AddPragmaHandler("GCC", new PragmaSystemHeaderHandler());
1987 AddPragmaHandler("GCC", new PragmaDependencyHandler());
1988 AddPragmaHandler("GCC", new PragmaDiagnosticHandler("GCC"));
1989 AddPragmaHandler("GCC", new PragmaMessageHandler(PPCallbacks::PMK_Warning,
1990 "GCC"));
1991 AddPragmaHandler("GCC", new PragmaMessageHandler(PPCallbacks::PMK_Error,
1992 "GCC"));
1993 // #pragma clang ...
1994 AddPragmaHandler("clang", new PragmaPoisonHandler());
1995 AddPragmaHandler("clang", new PragmaSystemHeaderHandler());
1996 AddPragmaHandler("clang", new PragmaIncludeInsteadHandler());
1997 AddPragmaHandler("clang", new PragmaDebugHandler());
1998 AddPragmaHandler("clang", new PragmaDependencyHandler());
1999 AddPragmaHandler("clang", new PragmaDiagnosticHandler("clang"));
2000 AddPragmaHandler("clang", new PragmaARCCFCodeAuditedHandler());
2001 AddPragmaHandler("clang", new PragmaAssumeNonNullHandler());
2002
2003 // #pragma clang module ...
2004 auto *ModuleHandler = new PragmaNamespace("module");
2005 AddPragmaHandler("clang", ModuleHandler);
2006 ModuleHandler->AddPragma(new PragmaModuleImportHandler());
2007 ModuleHandler->AddPragma(new PragmaModuleBeginHandler());
2008 ModuleHandler->AddPragma(new PragmaModuleEndHandler());
2009 ModuleHandler->AddPragma(new PragmaModuleBuildHandler());
2010 ModuleHandler->AddPragma(new PragmaModuleLoadHandler());
2011
2012 // Add region pragmas.
2013 AddPragmaHandler(new PragmaRegionHandler("region"));
2014 AddPragmaHandler(new PragmaRegionHandler("endregion"));
2015
2016 // MS extensions.
2017 if (LangOpts.MicrosoftExt) {
2018 AddPragmaHandler(new PragmaWarningHandler());
2019 AddPragmaHandler(new PragmaExecCharsetHandler());
2020 AddPragmaHandler(new PragmaIncludeAliasHandler());
2021 AddPragmaHandler(new PragmaHdrstopHandler());
2022 AddPragmaHandler(new PragmaSystemHeaderHandler());
2023 }
2024
2025 // Pragmas added by plugins
2026 for (const PragmaHandlerRegistry::entry &handler :
2027 PragmaHandlerRegistry::entries()) {
2028 AddPragmaHandler(handler.instantiate().release());
2029 }
2030 }
2031
2032 /// Ignore all pragmas, useful for modes such as -Eonly which would otherwise
2033 /// warn about those pragmas being unknown.
IgnorePragmas()2034 void Preprocessor::IgnorePragmas() {
2035 AddPragmaHandler(new EmptyPragmaHandler());
2036 // Also ignore all pragmas in all namespaces created
2037 // in Preprocessor::RegisterBuiltinPragmas().
2038 AddPragmaHandler("GCC", new EmptyPragmaHandler());
2039 AddPragmaHandler("clang", new EmptyPragmaHandler());
2040 }
2041