blob: 8b46f716910c943526839ecc8a7dd601fc92a068 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- Pragma.cpp - Pragma registration and handling --------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the PragmaHandler/PragmaTable interfaces and implements
11// pragma related methods of the Preprocessor class.
12//
13//===----------------------------------------------------------------------===//
14
15#include "clang/Lex/Pragma.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000016#include "clang/Lex/HeaderSearch.h"
Chris Lattnera9d91452009-01-16 18:59:23 +000017#include "clang/Lex/LiteralSupport.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000018#include "clang/Lex/Preprocessor.h"
Chris Lattner500d3292009-01-29 05:15:15 +000019#include "clang/Lex/LexDiagnostic.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000020#include "clang/Basic/FileManager.h"
21#include "clang/Basic/SourceManager.h"
Douglas Gregor2e222532009-07-02 17:08:52 +000022#include <algorithm>
Reid Spencer5f016e22007-07-11 17:01:13 +000023using namespace clang;
24
25// Out-of-line destructor to provide a home for the class.
26PragmaHandler::~PragmaHandler() {
27}
28
29//===----------------------------------------------------------------------===//
30// PragmaNamespace Implementation.
31//===----------------------------------------------------------------------===//
32
33
34PragmaNamespace::~PragmaNamespace() {
35 for (unsigned i = 0, e = Handlers.size(); i != e; ++i)
36 delete Handlers[i];
37}
38
39/// FindHandler - Check to see if there is already a handler for the
40/// specified name. If not, return the handler for the null identifier if it
41/// exists, otherwise return null. If IgnoreNull is true (the default) then
42/// the null handler isn't returned on failure to match.
43PragmaHandler *PragmaNamespace::FindHandler(const IdentifierInfo *Name,
44 bool IgnoreNull) const {
45 PragmaHandler *NullHandler = 0;
46 for (unsigned i = 0, e = Handlers.size(); i != e; ++i) {
Mike Stump1eb44332009-09-09 15:08:12 +000047 if (Handlers[i]->getName() == Name)
Reid Spencer5f016e22007-07-11 17:01:13 +000048 return Handlers[i];
Mike Stump1eb44332009-09-09 15:08:12 +000049
Reid Spencer5f016e22007-07-11 17:01:13 +000050 if (Handlers[i]->getName() == 0)
51 NullHandler = Handlers[i];
52 }
53 return IgnoreNull ? 0 : NullHandler;
54}
55
Daniel Dunbar40950802008-10-04 19:17:46 +000056void PragmaNamespace::RemovePragmaHandler(PragmaHandler *Handler) {
57 for (unsigned i = 0, e = Handlers.size(); i != e; ++i) {
58 if (Handlers[i] == Handler) {
59 Handlers[i] = Handlers.back();
60 Handlers.pop_back();
61 return;
62 }
63 }
64 assert(0 && "Handler not registered in this namespace");
65}
66
Chris Lattnerd2177732007-07-20 16:59:19 +000067void PragmaNamespace::HandlePragma(Preprocessor &PP, Token &Tok) {
Reid Spencer5f016e22007-07-11 17:01:13 +000068 // Read the 'namespace' that the directive is in, e.g. STDC. Do not macro
69 // expand it, the user can have a STDC #define, that should not affect this.
70 PP.LexUnexpandedToken(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +000071
Reid Spencer5f016e22007-07-11 17:01:13 +000072 // Get the handler for this token. If there is no handler, ignore the pragma.
73 PragmaHandler *Handler = FindHandler(Tok.getIdentifierInfo(), false);
Chris Lattneraf7cdf42009-04-19 21:10:26 +000074 if (Handler == 0) {
75 PP.Diag(Tok, diag::warn_pragma_ignored);
76 return;
77 }
Mike Stump1eb44332009-09-09 15:08:12 +000078
Reid Spencer5f016e22007-07-11 17:01:13 +000079 // Otherwise, pass it down.
80 Handler->HandlePragma(PP, Tok);
81}
82
83//===----------------------------------------------------------------------===//
84// Preprocessor Pragma Directive Handling.
85//===----------------------------------------------------------------------===//
86
87/// HandlePragmaDirective - The "#pragma" directive has been parsed. Lex the
88/// rest of the pragma, passing it to the registered pragma handlers.
89void Preprocessor::HandlePragmaDirective() {
90 ++NumPragma;
Mike Stump1eb44332009-09-09 15:08:12 +000091
Reid Spencer5f016e22007-07-11 17:01:13 +000092 // Invoke the first level of pragma handlers which reads the namespace id.
Chris Lattnerd2177732007-07-20 16:59:19 +000093 Token Tok;
Reid Spencer5f016e22007-07-11 17:01:13 +000094 PragmaHandlers->HandlePragma(*this, Tok);
Mike Stump1eb44332009-09-09 15:08:12 +000095
Reid Spencer5f016e22007-07-11 17:01:13 +000096 // If the pragma handler didn't read the rest of the line, consume it now.
Chris Lattner027cff62009-06-18 05:55:53 +000097 if (CurPPLexer && CurPPLexer->ParsingPreprocessorDirective)
Reid Spencer5f016e22007-07-11 17:01:13 +000098 DiscardUntilEndOfDirective();
99}
100
101/// Handle_Pragma - Read a _Pragma directive, slice it up, process it, then
102/// return the first token after the directive. The _Pragma token has just
103/// been read into 'Tok'.
Chris Lattnerd2177732007-07-20 16:59:19 +0000104void Preprocessor::Handle_Pragma(Token &Tok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000105 // Remember the pragma token location.
106 SourceLocation PragmaLoc = Tok.getLocation();
Mike Stump1eb44332009-09-09 15:08:12 +0000107
Reid Spencer5f016e22007-07-11 17:01:13 +0000108 // Read the '('.
109 Lex(Tok);
Chris Lattner3692b092008-11-18 07:59:24 +0000110 if (Tok.isNot(tok::l_paren)) {
111 Diag(PragmaLoc, diag::err__Pragma_malformed);
112 return;
113 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000114
115 // Read the '"..."'.
116 Lex(Tok);
Chris Lattner3692b092008-11-18 07:59:24 +0000117 if (Tok.isNot(tok::string_literal) && Tok.isNot(tok::wide_string_literal)) {
118 Diag(PragmaLoc, diag::err__Pragma_malformed);
119 return;
120 }
Mike Stump1eb44332009-09-09 15:08:12 +0000121
Reid Spencer5f016e22007-07-11 17:01:13 +0000122 // Remember the string.
123 std::string StrVal = getSpelling(Tok);
Reid Spencer5f016e22007-07-11 17:01:13 +0000124
125 // Read the ')'.
126 Lex(Tok);
Chris Lattner3692b092008-11-18 07:59:24 +0000127 if (Tok.isNot(tok::r_paren)) {
128 Diag(PragmaLoc, diag::err__Pragma_malformed);
129 return;
130 }
Mike Stump1eb44332009-09-09 15:08:12 +0000131
Chris Lattnere7fb4842009-02-15 20:52:18 +0000132 SourceLocation RParenLoc = Tok.getLocation();
Mike Stump1eb44332009-09-09 15:08:12 +0000133
Chris Lattnera9d91452009-01-16 18:59:23 +0000134 // The _Pragma is lexically sound. Destringize according to C99 6.10.9.1:
135 // "The string literal is destringized by deleting the L prefix, if present,
136 // deleting the leading and trailing double-quotes, replacing each escape
137 // sequence \" by a double-quote, and replacing each escape sequence \\ by a
138 // single backslash."
Reid Spencer5f016e22007-07-11 17:01:13 +0000139 if (StrVal[0] == 'L') // Remove L prefix.
140 StrVal.erase(StrVal.begin());
141 assert(StrVal[0] == '"' && StrVal[StrVal.size()-1] == '"' &&
142 "Invalid string token!");
Mike Stump1eb44332009-09-09 15:08:12 +0000143
Reid Spencer5f016e22007-07-11 17:01:13 +0000144 // Remove the front quote, replacing it with a space, so that the pragma
145 // contents appear to have a space before them.
146 StrVal[0] = ' ';
Mike Stump1eb44332009-09-09 15:08:12 +0000147
Chris Lattner1fa49532009-03-08 08:08:45 +0000148 // Replace the terminating quote with a \n.
Reid Spencer5f016e22007-07-11 17:01:13 +0000149 StrVal[StrVal.size()-1] = '\n';
Mike Stump1eb44332009-09-09 15:08:12 +0000150
Reid Spencer5f016e22007-07-11 17:01:13 +0000151 // Remove escaped quotes and escapes.
152 for (unsigned i = 0, e = StrVal.size(); i != e-1; ++i) {
153 if (StrVal[i] == '\\' &&
154 (StrVal[i+1] == '\\' || StrVal[i+1] == '"')) {
155 // \\ -> '\' and \" -> '"'.
156 StrVal.erase(StrVal.begin()+i);
157 --e;
158 }
159 }
Mike Stump1eb44332009-09-09 15:08:12 +0000160
Reid Spencer5f016e22007-07-11 17:01:13 +0000161 // Plop the string (including the newline and trailing null) into a buffer
162 // where we can lex it.
Chris Lattner47246be2009-01-26 19:29:26 +0000163 Token TmpTok;
164 TmpTok.startToken();
165 CreateString(&StrVal[0], StrVal.size(), TmpTok);
166 SourceLocation TokLoc = TmpTok.getLocation();
Reid Spencer5f016e22007-07-11 17:01:13 +0000167
Reid Spencer5f016e22007-07-11 17:01:13 +0000168 // Make and enter a lexer object so that we lex and expand the tokens just
169 // like any others.
Chris Lattnere7fb4842009-02-15 20:52:18 +0000170 Lexer *TL = Lexer::Create_PragmaLexer(TokLoc, PragmaLoc, RParenLoc,
Chris Lattner1fa49532009-03-08 08:08:45 +0000171 StrVal.size(), *this);
Reid Spencer5f016e22007-07-11 17:01:13 +0000172
173 EnterSourceFileWithLexer(TL, 0);
174
175 // With everything set up, lex this as a #pragma directive.
176 HandlePragmaDirective();
Mike Stump1eb44332009-09-09 15:08:12 +0000177
Reid Spencer5f016e22007-07-11 17:01:13 +0000178 // Finally, return whatever came after the pragma directive.
179 return Lex(Tok);
180}
181
182
183
184/// HandlePragmaOnce - Handle #pragma once. OnceTok is the 'once'.
185///
Chris Lattnerd2177732007-07-20 16:59:19 +0000186void Preprocessor::HandlePragmaOnce(Token &OnceTok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000187 if (isInPrimaryFile()) {
188 Diag(OnceTok, diag::pp_pragma_once_in_main_file);
189 return;
190 }
Mike Stump1eb44332009-09-09 15:08:12 +0000191
Reid Spencer5f016e22007-07-11 17:01:13 +0000192 // Get the current file lexer we're looking at. Ignore _Pragma 'files' etc.
Reid Spencer5f016e22007-07-11 17:01:13 +0000193 // Mark the file as a once-only file now.
Chris Lattner2b2453a2009-01-17 06:22:33 +0000194 HeaderInfo.MarkFileIncludeOnce(getCurrentFileLexer()->getFileEntry());
Reid Spencer5f016e22007-07-11 17:01:13 +0000195}
196
Chris Lattner22434492007-12-19 19:38:36 +0000197void Preprocessor::HandlePragmaMark() {
Ted Kremenek17ff58a2008-11-19 22:21:33 +0000198 assert(CurPPLexer && "No current lexer?");
Chris Lattner6896a372009-06-15 05:02:34 +0000199 if (CurLexer)
200 CurLexer->ReadToEndOfLine();
201 else
202 CurPTHLexer->DiscardToEndOfLine();
Chris Lattner22434492007-12-19 19:38:36 +0000203}
204
205
Reid Spencer5f016e22007-07-11 17:01:13 +0000206/// HandlePragmaPoison - Handle #pragma GCC poison. PoisonTok is the 'poison'.
207///
Chris Lattnerd2177732007-07-20 16:59:19 +0000208void Preprocessor::HandlePragmaPoison(Token &PoisonTok) {
209 Token Tok;
Reid Spencer5f016e22007-07-11 17:01:13 +0000210
211 while (1) {
212 // Read the next token to poison. While doing this, pretend that we are
213 // skipping while reading the identifier to poison.
214 // This avoids errors on code like:
215 // #pragma GCC poison X
216 // #pragma GCC poison X
Ted Kremenek68a91d52008-11-18 01:12:54 +0000217 if (CurPPLexer) CurPPLexer->LexingRawMode = true;
Reid Spencer5f016e22007-07-11 17:01:13 +0000218 LexUnexpandedToken(Tok);
Ted Kremenek68a91d52008-11-18 01:12:54 +0000219 if (CurPPLexer) CurPPLexer->LexingRawMode = false;
Mike Stump1eb44332009-09-09 15:08:12 +0000220
Reid Spencer5f016e22007-07-11 17:01:13 +0000221 // If we reached the end of line, we're done.
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000222 if (Tok.is(tok::eom)) return;
Mike Stump1eb44332009-09-09 15:08:12 +0000223
Reid Spencer5f016e22007-07-11 17:01:13 +0000224 // Can only poison identifiers.
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000225 if (Tok.isNot(tok::identifier)) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000226 Diag(Tok, diag::err_pp_invalid_poison);
227 return;
228 }
Mike Stump1eb44332009-09-09 15:08:12 +0000229
Reid Spencer5f016e22007-07-11 17:01:13 +0000230 // Look up the identifier info for the token. We disabled identifier lookup
231 // by saying we're skipping contents, so we need to do this manually.
232 IdentifierInfo *II = LookUpIdentifierInfo(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +0000233
Reid Spencer5f016e22007-07-11 17:01:13 +0000234 // Already poisoned.
235 if (II->isPoisoned()) continue;
Mike Stump1eb44332009-09-09 15:08:12 +0000236
Reid Spencer5f016e22007-07-11 17:01:13 +0000237 // If this is a macro identifier, emit a warning.
Chris Lattner0edde552007-10-07 08:04:56 +0000238 if (II->hasMacroDefinition())
Reid Spencer5f016e22007-07-11 17:01:13 +0000239 Diag(Tok, diag::pp_poisoning_existing_macro);
Mike Stump1eb44332009-09-09 15:08:12 +0000240
Reid Spencer5f016e22007-07-11 17:01:13 +0000241 // Finally, poison it!
242 II->setIsPoisoned();
243 }
244}
245
246/// HandlePragmaSystemHeader - Implement #pragma GCC system_header. We know
247/// that the whole directive has been parsed.
Chris Lattnerd2177732007-07-20 16:59:19 +0000248void Preprocessor::HandlePragmaSystemHeader(Token &SysHeaderTok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000249 if (isInPrimaryFile()) {
250 Diag(SysHeaderTok, diag::pp_pragma_sysheader_in_main_file);
251 return;
252 }
Mike Stump1eb44332009-09-09 15:08:12 +0000253
Reid Spencer5f016e22007-07-11 17:01:13 +0000254 // Get the current file lexer we're looking at. Ignore _Pragma 'files' etc.
Ted Kremenek35c10c22008-11-20 01:45:11 +0000255 PreprocessorLexer *TheLexer = getCurrentFileLexer();
Mike Stump1eb44332009-09-09 15:08:12 +0000256
Reid Spencer5f016e22007-07-11 17:01:13 +0000257 // Mark the file as a system header.
Chris Lattner2b2453a2009-01-17 06:22:33 +0000258 HeaderInfo.MarkFileSystemHeader(TheLexer->getFileEntry());
Mike Stump1eb44332009-09-09 15:08:12 +0000259
260
Chris Lattner6896a372009-06-15 05:02:34 +0000261 PresumedLoc PLoc = SourceMgr.getPresumedLoc(SysHeaderTok.getLocation());
262 unsigned FilenameLen = strlen(PLoc.getFilename());
263 unsigned FilenameID = SourceMgr.getLineTableFilenameID(PLoc.getFilename(),
264 FilenameLen);
Mike Stump1eb44332009-09-09 15:08:12 +0000265
Chris Lattner6896a372009-06-15 05:02:34 +0000266 // Emit a line marker. This will change any source locations from this point
267 // forward to realize they are in a system header.
268 // Create a line note with this information.
269 SourceMgr.AddLineNote(SysHeaderTok.getLocation(), PLoc.getLine(), FilenameID,
270 false, false, true, false);
Mike Stump1eb44332009-09-09 15:08:12 +0000271
Reid Spencer5f016e22007-07-11 17:01:13 +0000272 // Notify the client, if desired, that we are in a new source file.
273 if (Callbacks)
Ted Kremenek35c10c22008-11-20 01:45:11 +0000274 Callbacks->FileChanged(SysHeaderTok.getLocation(),
Chris Lattner0b9e7362008-09-26 21:18:42 +0000275 PPCallbacks::SystemHeaderPragma, SrcMgr::C_System);
Reid Spencer5f016e22007-07-11 17:01:13 +0000276}
277
278/// HandlePragmaDependency - Handle #pragma GCC dependency "foo" blah.
279///
Chris Lattnerd2177732007-07-20 16:59:19 +0000280void Preprocessor::HandlePragmaDependency(Token &DependencyTok) {
281 Token FilenameTok;
Ted Kremenek68a91d52008-11-18 01:12:54 +0000282 CurPPLexer->LexIncludeFilename(FilenameTok);
Reid Spencer5f016e22007-07-11 17:01:13 +0000283
284 // If the token kind is EOM, the error has already been diagnosed.
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000285 if (FilenameTok.is(tok::eom))
Reid Spencer5f016e22007-07-11 17:01:13 +0000286 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000287
Reid Spencer5f016e22007-07-11 17:01:13 +0000288 // Reserve a buffer to get the spelling.
289 llvm::SmallVector<char, 128> FilenameBuffer;
290 FilenameBuffer.resize(FilenameTok.getLength());
Mike Stump1eb44332009-09-09 15:08:12 +0000291
Chris Lattnerf1c99ac2007-07-23 04:15:27 +0000292 const char *FilenameStart = &FilenameBuffer[0];
293 unsigned Len = getSpelling(FilenameTok, FilenameStart);
294 const char *FilenameEnd = FilenameStart+Len;
295 bool isAngled = GetIncludeFilenameSpelling(FilenameTok.getLocation(),
Reid Spencer5f016e22007-07-11 17:01:13 +0000296 FilenameStart, FilenameEnd);
297 // If GetIncludeFilenameSpelling set the start ptr to null, there was an
298 // error.
299 if (FilenameStart == 0)
300 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000301
Reid Spencer5f016e22007-07-11 17:01:13 +0000302 // Search include directories for this file.
303 const DirectoryLookup *CurDir;
304 const FileEntry *File = LookupFile(FilenameStart, FilenameEnd,
305 isAngled, 0, CurDir);
Chris Lattner56b05c82008-11-18 08:02:48 +0000306 if (File == 0) {
307 Diag(FilenameTok, diag::err_pp_file_not_found)
308 << std::string(FilenameStart, FilenameEnd);
309 return;
310 }
Mike Stump1eb44332009-09-09 15:08:12 +0000311
Chris Lattner2b2453a2009-01-17 06:22:33 +0000312 const FileEntry *CurFile = getCurrentFileLexer()->getFileEntry();
Reid Spencer5f016e22007-07-11 17:01:13 +0000313
314 // If this file is older than the file it depends on, emit a diagnostic.
315 if (CurFile && CurFile->getModificationTime() < File->getModificationTime()) {
316 // Lex tokens at the end of the message and include them in the message.
317 std::string Message;
318 Lex(DependencyTok);
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000319 while (DependencyTok.isNot(tok::eom)) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000320 Message += getSpelling(DependencyTok) + " ";
321 Lex(DependencyTok);
322 }
Mike Stump1eb44332009-09-09 15:08:12 +0000323
Reid Spencer5f016e22007-07-11 17:01:13 +0000324 Message.erase(Message.end()-1);
Chris Lattner56b05c82008-11-18 08:02:48 +0000325 Diag(FilenameTok, diag::pp_out_of_date_dependency) << Message;
Reid Spencer5f016e22007-07-11 17:01:13 +0000326 }
327}
328
Chris Lattner636c5ef2009-01-16 08:21:25 +0000329/// HandlePragmaComment - Handle the microsoft #pragma comment extension. The
330/// syntax is:
331/// #pragma comment(linker, "foo")
332/// 'linker' is one of five identifiers: compiler, exestr, lib, linker, user.
333/// "foo" is a string, which is fully macro expanded, and permits string
Gabor Greifd7ee3492009-03-17 11:39:38 +0000334/// concatenation, embedded escape characters etc. See MSDN for more details.
Chris Lattner636c5ef2009-01-16 08:21:25 +0000335void Preprocessor::HandlePragmaComment(Token &Tok) {
336 SourceLocation CommentLoc = Tok.getLocation();
337 Lex(Tok);
338 if (Tok.isNot(tok::l_paren)) {
339 Diag(CommentLoc, diag::err_pragma_comment_malformed);
340 return;
341 }
Mike Stump1eb44332009-09-09 15:08:12 +0000342
Chris Lattner636c5ef2009-01-16 08:21:25 +0000343 // Read the identifier.
344 Lex(Tok);
345 if (Tok.isNot(tok::identifier)) {
346 Diag(CommentLoc, diag::err_pragma_comment_malformed);
347 return;
348 }
Mike Stump1eb44332009-09-09 15:08:12 +0000349
Chris Lattner636c5ef2009-01-16 08:21:25 +0000350 // Verify that this is one of the 5 whitelisted options.
351 // FIXME: warn that 'exestr' is deprecated.
352 const IdentifierInfo *II = Tok.getIdentifierInfo();
Mike Stump1eb44332009-09-09 15:08:12 +0000353 if (!II->isStr("compiler") && !II->isStr("exestr") && !II->isStr("lib") &&
Chris Lattner636c5ef2009-01-16 08:21:25 +0000354 !II->isStr("linker") && !II->isStr("user")) {
355 Diag(Tok.getLocation(), diag::err_pragma_comment_unknown_kind);
356 return;
357 }
Mike Stump1eb44332009-09-09 15:08:12 +0000358
Chris Lattnera9d91452009-01-16 18:59:23 +0000359 // Read the optional string if present.
Chris Lattner636c5ef2009-01-16 08:21:25 +0000360 Lex(Tok);
Chris Lattnera9d91452009-01-16 18:59:23 +0000361 std::string ArgumentString;
Chris Lattner636c5ef2009-01-16 08:21:25 +0000362 if (Tok.is(tok::comma)) {
Chris Lattnera9d91452009-01-16 18:59:23 +0000363 Lex(Tok); // eat the comma.
Chris Lattner636c5ef2009-01-16 08:21:25 +0000364
365 // We need at least one string.
Chris Lattneredaf8772009-04-19 23:16:58 +0000366 if (Tok.isNot(tok::string_literal)) {
Chris Lattner636c5ef2009-01-16 08:21:25 +0000367 Diag(Tok.getLocation(), diag::err_pragma_comment_malformed);
368 return;
369 }
370
371 // String concatenation allows multiple strings, which can even come from
372 // macro expansion.
373 // "foo " "bar" "Baz"
Chris Lattnera9d91452009-01-16 18:59:23 +0000374 llvm::SmallVector<Token, 4> StrToks;
Chris Lattneredaf8772009-04-19 23:16:58 +0000375 while (Tok.is(tok::string_literal)) {
Chris Lattnera9d91452009-01-16 18:59:23 +0000376 StrToks.push_back(Tok);
Chris Lattner636c5ef2009-01-16 08:21:25 +0000377 Lex(Tok);
Chris Lattnera9d91452009-01-16 18:59:23 +0000378 }
379
380 // Concatenate and parse the strings.
381 StringLiteralParser Literal(&StrToks[0], StrToks.size(), *this);
382 assert(!Literal.AnyWide && "Didn't allow wide strings in");
383 if (Literal.hadError)
384 return;
385 if (Literal.Pascal) {
386 Diag(StrToks[0].getLocation(), diag::err_pragma_comment_malformed);
387 return;
388 }
389
390 ArgumentString = std::string(Literal.GetString(),
391 Literal.GetString()+Literal.GetStringLength());
Chris Lattner636c5ef2009-01-16 08:21:25 +0000392 }
Mike Stump1eb44332009-09-09 15:08:12 +0000393
Chris Lattnera9d91452009-01-16 18:59:23 +0000394 // FIXME: If the kind is "compiler" warn if the string is present (it is
395 // ignored).
396 // FIXME: 'lib' requires a comment string.
397 // FIXME: 'linker' requires a comment string, and has a specific list of
398 // things that are allowable.
Mike Stump1eb44332009-09-09 15:08:12 +0000399
Chris Lattner636c5ef2009-01-16 08:21:25 +0000400 if (Tok.isNot(tok::r_paren)) {
401 Diag(Tok.getLocation(), diag::err_pragma_comment_malformed);
402 return;
403 }
Chris Lattnera9d91452009-01-16 18:59:23 +0000404 Lex(Tok); // eat the r_paren.
Chris Lattner636c5ef2009-01-16 08:21:25 +0000405
406 if (Tok.isNot(tok::eom)) {
407 Diag(Tok.getLocation(), diag::err_pragma_comment_malformed);
408 return;
409 }
Mike Stump1eb44332009-09-09 15:08:12 +0000410
Chris Lattnera9d91452009-01-16 18:59:23 +0000411 // If the pragma is lexically sound, notify any interested PPCallbacks.
Chris Lattner172e3362009-01-16 19:01:46 +0000412 if (Callbacks)
413 Callbacks->PragmaComment(CommentLoc, II, ArgumentString);
Chris Lattner636c5ef2009-01-16 08:21:25 +0000414}
415
416
417
Reid Spencer5f016e22007-07-11 17:01:13 +0000418
419/// AddPragmaHandler - Add the specified pragma handler to the preprocessor.
420/// If 'Namespace' is non-null, then it is a token required to exist on the
421/// pragma line before the pragma string starts, e.g. "STDC" or "GCC".
Mike Stump1eb44332009-09-09 15:08:12 +0000422void Preprocessor::AddPragmaHandler(const char *Namespace,
Reid Spencer5f016e22007-07-11 17:01:13 +0000423 PragmaHandler *Handler) {
424 PragmaNamespace *InsertNS = PragmaHandlers;
Mike Stump1eb44332009-09-09 15:08:12 +0000425
Reid Spencer5f016e22007-07-11 17:01:13 +0000426 // If this is specified to be in a namespace, step down into it.
427 if (Namespace) {
428 IdentifierInfo *NSID = getIdentifierInfo(Namespace);
Mike Stump1eb44332009-09-09 15:08:12 +0000429
Reid Spencer5f016e22007-07-11 17:01:13 +0000430 // If there is already a pragma handler with the name of this namespace,
431 // we either have an error (directive with the same name as a namespace) or
432 // we already have the namespace to insert into.
433 if (PragmaHandler *Existing = PragmaHandlers->FindHandler(NSID)) {
434 InsertNS = Existing->getIfNamespace();
435 assert(InsertNS != 0 && "Cannot have a pragma namespace and pragma"
436 " handler with the same name!");
437 } else {
438 // Otherwise, this namespace doesn't exist yet, create and insert the
439 // handler for it.
440 InsertNS = new PragmaNamespace(NSID);
441 PragmaHandlers->AddPragma(InsertNS);
442 }
443 }
Mike Stump1eb44332009-09-09 15:08:12 +0000444
Reid Spencer5f016e22007-07-11 17:01:13 +0000445 // Check to make sure we don't already have a pragma for this identifier.
446 assert(!InsertNS->FindHandler(Handler->getName()) &&
447 "Pragma handler already exists for this identifier!");
448 InsertNS->AddPragma(Handler);
449}
450
Daniel Dunbar40950802008-10-04 19:17:46 +0000451/// RemovePragmaHandler - Remove the specific pragma handler from the
452/// preprocessor. If \arg Namespace is non-null, then it should be the
453/// namespace that \arg Handler was added to. It is an error to remove
454/// a handler that has not been registered.
455void Preprocessor::RemovePragmaHandler(const char *Namespace,
456 PragmaHandler *Handler) {
457 PragmaNamespace *NS = PragmaHandlers;
Mike Stump1eb44332009-09-09 15:08:12 +0000458
Daniel Dunbar40950802008-10-04 19:17:46 +0000459 // If this is specified to be in a namespace, step down into it.
460 if (Namespace) {
461 IdentifierInfo *NSID = getIdentifierInfo(Namespace);
462 PragmaHandler *Existing = PragmaHandlers->FindHandler(NSID);
463 assert(Existing && "Namespace containing handler does not exist!");
464
465 NS = Existing->getIfNamespace();
466 assert(NS && "Invalid namespace, registered as a regular pragma handler!");
467 }
468
469 NS->RemovePragmaHandler(Handler);
Mike Stump1eb44332009-09-09 15:08:12 +0000470
Daniel Dunbar40950802008-10-04 19:17:46 +0000471 // If this is a non-default namespace and it is now empty, remove
472 // it.
473 if (NS != PragmaHandlers && NS->IsEmpty())
474 PragmaHandlers->RemovePragmaHandler(NS);
475}
476
Reid Spencer5f016e22007-07-11 17:01:13 +0000477namespace {
Chris Lattner22434492007-12-19 19:38:36 +0000478/// PragmaOnceHandler - "#pragma once" marks the file as atomically included.
Reid Spencer5f016e22007-07-11 17:01:13 +0000479struct PragmaOnceHandler : public PragmaHandler {
480 PragmaOnceHandler(const IdentifierInfo *OnceID) : PragmaHandler(OnceID) {}
Chris Lattnerd2177732007-07-20 16:59:19 +0000481 virtual void HandlePragma(Preprocessor &PP, Token &OnceTok) {
Chris Lattner35410d52009-04-14 05:07:49 +0000482 PP.CheckEndOfDirective("pragma once");
Reid Spencer5f016e22007-07-11 17:01:13 +0000483 PP.HandlePragmaOnce(OnceTok);
484 }
485};
486
Chris Lattner22434492007-12-19 19:38:36 +0000487/// PragmaMarkHandler - "#pragma mark ..." is ignored by the compiler, and the
488/// rest of the line is not lexed.
489struct PragmaMarkHandler : public PragmaHandler {
490 PragmaMarkHandler(const IdentifierInfo *MarkID) : PragmaHandler(MarkID) {}
491 virtual void HandlePragma(Preprocessor &PP, Token &MarkTok) {
492 PP.HandlePragmaMark();
493 }
494};
495
496/// PragmaPoisonHandler - "#pragma poison x" marks x as not usable.
Reid Spencer5f016e22007-07-11 17:01:13 +0000497struct PragmaPoisonHandler : public PragmaHandler {
498 PragmaPoisonHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
Chris Lattnerd2177732007-07-20 16:59:19 +0000499 virtual void HandlePragma(Preprocessor &PP, Token &PoisonTok) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000500 PP.HandlePragmaPoison(PoisonTok);
501 }
502};
503
Chris Lattner22434492007-12-19 19:38:36 +0000504/// PragmaSystemHeaderHandler - "#pragma system_header" marks the current file
505/// as a system header, which silences warnings in it.
Reid Spencer5f016e22007-07-11 17:01:13 +0000506struct PragmaSystemHeaderHandler : public PragmaHandler {
507 PragmaSystemHeaderHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
Chris Lattnerd2177732007-07-20 16:59:19 +0000508 virtual void HandlePragma(Preprocessor &PP, Token &SHToken) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000509 PP.HandlePragmaSystemHeader(SHToken);
Chris Lattner35410d52009-04-14 05:07:49 +0000510 PP.CheckEndOfDirective("pragma");
Reid Spencer5f016e22007-07-11 17:01:13 +0000511 }
512};
513struct PragmaDependencyHandler : public PragmaHandler {
514 PragmaDependencyHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
Chris Lattnerd2177732007-07-20 16:59:19 +0000515 virtual void HandlePragma(Preprocessor &PP, Token &DepToken) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000516 PP.HandlePragmaDependency(DepToken);
517 }
518};
Mike Stump1eb44332009-09-09 15:08:12 +0000519
Chris Lattneredaf8772009-04-19 23:16:58 +0000520/// PragmaDiagnosticHandler - e.g. '#pragma GCC diagnostic ignored "-Wformat"'
Chris Lattner04ae2df2009-07-12 21:18:45 +0000521/// Since clang's diagnostic supports extended functionality beyond GCC's
522/// the constructor takes a clangMode flag to tell it whether or not to allow
523/// clang's extended functionality, or whether to reject it.
Chris Lattneredaf8772009-04-19 23:16:58 +0000524struct PragmaDiagnosticHandler : public PragmaHandler {
Chris Lattner04ae2df2009-07-12 21:18:45 +0000525private:
526 const bool ClangMode;
527public:
528 PragmaDiagnosticHandler(const IdentifierInfo *ID,
529 const bool clangMode) : PragmaHandler(ID),
530 ClangMode(clangMode) {}
Chris Lattneredaf8772009-04-19 23:16:58 +0000531 virtual void HandlePragma(Preprocessor &PP, Token &DiagToken) {
532 Token Tok;
533 PP.LexUnexpandedToken(Tok);
534 if (Tok.isNot(tok::identifier)) {
Chris Lattner04ae2df2009-07-12 21:18:45 +0000535 unsigned Diag = ClangMode ? diag::warn_pragma_diagnostic_clang_invalid
536 : diag::warn_pragma_diagnostic_gcc_invalid;
537 PP.Diag(Tok, Diag);
Chris Lattneredaf8772009-04-19 23:16:58 +0000538 return;
539 }
540 IdentifierInfo *II = Tok.getIdentifierInfo();
Mike Stump1eb44332009-09-09 15:08:12 +0000541
Chris Lattneredaf8772009-04-19 23:16:58 +0000542 diag::Mapping Map;
543 if (II->isStr("warning"))
544 Map = diag::MAP_WARNING;
545 else if (II->isStr("error"))
546 Map = diag::MAP_ERROR;
547 else if (II->isStr("ignored"))
548 Map = diag::MAP_IGNORE;
549 else if (II->isStr("fatal"))
550 Map = diag::MAP_FATAL;
Chris Lattner04ae2df2009-07-12 21:18:45 +0000551 else if (ClangMode) {
552 if (II->isStr("pop")) {
Mike Stump1eb44332009-09-09 15:08:12 +0000553 if (!PP.getDiagnostics().popMappings())
Chris Lattner04ae2df2009-07-12 21:18:45 +0000554 PP.Diag(Tok, diag::warn_pragma_diagnostic_clang_cannot_ppp);
555 return;
556 }
557
558 if (II->isStr("push")) {
559 PP.getDiagnostics().pushMappings();
Mike Stump1eb44332009-09-09 15:08:12 +0000560 return;
Chris Lattner04ae2df2009-07-12 21:18:45 +0000561 }
562
563 PP.Diag(Tok, diag::warn_pragma_diagnostic_clang_invalid);
564 return;
565 } else {
566 PP.Diag(Tok, diag::warn_pragma_diagnostic_gcc_invalid);
Chris Lattneredaf8772009-04-19 23:16:58 +0000567 return;
568 }
Mike Stump1eb44332009-09-09 15:08:12 +0000569
Chris Lattneredaf8772009-04-19 23:16:58 +0000570 PP.LexUnexpandedToken(Tok);
571
572 // We need at least one string.
573 if (Tok.isNot(tok::string_literal)) {
574 PP.Diag(Tok.getLocation(), diag::warn_pragma_diagnostic_invalid_token);
575 return;
576 }
Mike Stump1eb44332009-09-09 15:08:12 +0000577
Chris Lattneredaf8772009-04-19 23:16:58 +0000578 // String concatenation allows multiple strings, which can even come from
579 // macro expansion.
580 // "foo " "bar" "Baz"
581 llvm::SmallVector<Token, 4> StrToks;
582 while (Tok.is(tok::string_literal)) {
583 StrToks.push_back(Tok);
584 PP.LexUnexpandedToken(Tok);
585 }
Mike Stump1eb44332009-09-09 15:08:12 +0000586
Chris Lattneredaf8772009-04-19 23:16:58 +0000587 if (Tok.isNot(tok::eom)) {
588 PP.Diag(Tok.getLocation(), diag::warn_pragma_diagnostic_invalid_token);
589 return;
590 }
Mike Stump1eb44332009-09-09 15:08:12 +0000591
Chris Lattneredaf8772009-04-19 23:16:58 +0000592 // Concatenate and parse the strings.
593 StringLiteralParser Literal(&StrToks[0], StrToks.size(), PP);
594 assert(!Literal.AnyWide && "Didn't allow wide strings in");
595 if (Literal.hadError)
596 return;
597 if (Literal.Pascal) {
Chris Lattner04ae2df2009-07-12 21:18:45 +0000598 unsigned Diag = ClangMode ? diag::warn_pragma_diagnostic_clang_invalid
599 : diag::warn_pragma_diagnostic_gcc_invalid;
600 PP.Diag(Tok, Diag);
Chris Lattneredaf8772009-04-19 23:16:58 +0000601 return;
602 }
Chris Lattner04ae2df2009-07-12 21:18:45 +0000603
Chris Lattneredaf8772009-04-19 23:16:58 +0000604 std::string WarningName(Literal.GetString(),
605 Literal.GetString()+Literal.GetStringLength());
606
607 if (WarningName.size() < 3 || WarningName[0] != '-' ||
608 WarningName[1] != 'W') {
609 PP.Diag(StrToks[0].getLocation(),
610 diag::warn_pragma_diagnostic_invalid_option);
611 return;
612 }
Mike Stump1eb44332009-09-09 15:08:12 +0000613
Chris Lattneredaf8772009-04-19 23:16:58 +0000614 if (PP.getDiagnostics().setDiagnosticGroupMapping(WarningName.c_str()+2,
615 Map))
616 PP.Diag(StrToks[0].getLocation(),
617 diag::warn_pragma_diagnostic_unknown_warning) << WarningName;
618 }
619};
Mike Stump1eb44332009-09-09 15:08:12 +0000620
Chris Lattner636c5ef2009-01-16 08:21:25 +0000621/// PragmaCommentHandler - "#pragma comment ...".
622struct PragmaCommentHandler : public PragmaHandler {
623 PragmaCommentHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
624 virtual void HandlePragma(Preprocessor &PP, Token &CommentTok) {
625 PP.HandlePragmaComment(CommentTok);
626 }
627};
Mike Stump1eb44332009-09-09 15:08:12 +0000628
Chris Lattner062f2322009-04-19 21:20:35 +0000629// Pragma STDC implementations.
Chris Lattner6c5cf4a2009-04-19 21:50:08 +0000630
631enum STDCSetting {
632 STDC_ON, STDC_OFF, STDC_DEFAULT, STDC_INVALID
633};
Mike Stump1eb44332009-09-09 15:08:12 +0000634
Chris Lattner6c5cf4a2009-04-19 21:50:08 +0000635static STDCSetting LexOnOffSwitch(Preprocessor &PP) {
636 Token Tok;
637 PP.LexUnexpandedToken(Tok);
638
639 if (Tok.isNot(tok::identifier)) {
640 PP.Diag(Tok, diag::ext_stdc_pragma_syntax);
641 return STDC_INVALID;
642 }
643 IdentifierInfo *II = Tok.getIdentifierInfo();
644 STDCSetting Result;
645 if (II->isStr("ON"))
646 Result = STDC_ON;
647 else if (II->isStr("OFF"))
648 Result = STDC_OFF;
649 else if (II->isStr("DEFAULT"))
650 Result = STDC_DEFAULT;
651 else {
652 PP.Diag(Tok, diag::ext_stdc_pragma_syntax);
653 return STDC_INVALID;
654 }
655
656 // Verify that this is followed by EOM.
657 PP.LexUnexpandedToken(Tok);
658 if (Tok.isNot(tok::eom))
659 PP.Diag(Tok, diag::ext_stdc_pragma_syntax_eom);
660 return Result;
661}
Mike Stump1eb44332009-09-09 15:08:12 +0000662
Chris Lattner062f2322009-04-19 21:20:35 +0000663/// PragmaSTDC_FP_CONTRACTHandler - "#pragma STDC FP_CONTRACT ...".
664struct PragmaSTDC_FP_CONTRACTHandler : public PragmaHandler {
665 PragmaSTDC_FP_CONTRACTHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
Chris Lattnerf545be52009-04-19 21:25:37 +0000666 virtual void HandlePragma(Preprocessor &PP, Token &Tok) {
Chris Lattner6c5cf4a2009-04-19 21:50:08 +0000667 // We just ignore the setting of FP_CONTRACT. Since we don't do contractions
668 // at all, our default is OFF and setting it to ON is an optimization hint
669 // we can safely ignore. When we support -ffma or something, we would need
670 // to diagnose that we are ignoring FMA.
671 LexOnOffSwitch(PP);
Chris Lattner062f2322009-04-19 21:20:35 +0000672 }
673};
Mike Stump1eb44332009-09-09 15:08:12 +0000674
Chris Lattner062f2322009-04-19 21:20:35 +0000675/// PragmaSTDC_FENV_ACCESSHandler - "#pragma STDC FENV_ACCESS ...".
676struct PragmaSTDC_FENV_ACCESSHandler : public PragmaHandler {
677 PragmaSTDC_FENV_ACCESSHandler(const IdentifierInfo *ID) : PragmaHandler(ID) {}
Chris Lattnerf545be52009-04-19 21:25:37 +0000678 virtual void HandlePragma(Preprocessor &PP, Token &Tok) {
Chris Lattner4d8aac32009-04-19 21:55:32 +0000679 if (LexOnOffSwitch(PP) == STDC_ON)
680 PP.Diag(Tok, diag::warn_stdc_fenv_access_not_supported);
Chris Lattner062f2322009-04-19 21:20:35 +0000681 }
682};
Mike Stump1eb44332009-09-09 15:08:12 +0000683
Chris Lattner062f2322009-04-19 21:20:35 +0000684/// PragmaSTDC_CX_LIMITED_RANGEHandler - "#pragma STDC CX_LIMITED_RANGE ...".
685struct PragmaSTDC_CX_LIMITED_RANGEHandler : public PragmaHandler {
686 PragmaSTDC_CX_LIMITED_RANGEHandler(const IdentifierInfo *ID)
687 : PragmaHandler(ID) {}
Chris Lattnerf545be52009-04-19 21:25:37 +0000688 virtual void HandlePragma(Preprocessor &PP, Token &Tok) {
Chris Lattner6c5cf4a2009-04-19 21:50:08 +0000689 LexOnOffSwitch(PP);
Chris Lattner062f2322009-04-19 21:20:35 +0000690 }
691};
Mike Stump1eb44332009-09-09 15:08:12 +0000692
Chris Lattner062f2322009-04-19 21:20:35 +0000693/// PragmaSTDC_UnknownHandler - "#pragma STDC ...".
694struct PragmaSTDC_UnknownHandler : public PragmaHandler {
695 PragmaSTDC_UnknownHandler() : PragmaHandler(0) {}
Chris Lattnerf545be52009-04-19 21:25:37 +0000696 virtual void HandlePragma(Preprocessor &PP, Token &UnknownTok) {
Chris Lattner6c5cf4a2009-04-19 21:50:08 +0000697 // C99 6.10.6p2, unknown forms are not allowed.
Chris Lattnerf545be52009-04-19 21:25:37 +0000698 PP.Diag(UnknownTok, diag::ext_stdc_pragma_ignored);
Chris Lattner062f2322009-04-19 21:20:35 +0000699 }
700};
Mike Stump1eb44332009-09-09 15:08:12 +0000701
Reid Spencer5f016e22007-07-11 17:01:13 +0000702} // end anonymous namespace
703
704
705/// RegisterBuiltinPragmas - Install the standard preprocessor pragmas:
706/// #pragma GCC poison/system_header/dependency and #pragma once.
707void Preprocessor::RegisterBuiltinPragmas() {
708 AddPragmaHandler(0, new PragmaOnceHandler(getIdentifierInfo("once")));
Chris Lattner22434492007-12-19 19:38:36 +0000709 AddPragmaHandler(0, new PragmaMarkHandler(getIdentifierInfo("mark")));
Mike Stump1eb44332009-09-09 15:08:12 +0000710
Chris Lattnere8fa06e2009-05-12 18:21:11 +0000711 // #pragma GCC ...
Reid Spencer5f016e22007-07-11 17:01:13 +0000712 AddPragmaHandler("GCC", new PragmaPoisonHandler(getIdentifierInfo("poison")));
713 AddPragmaHandler("GCC", new PragmaSystemHeaderHandler(
714 getIdentifierInfo("system_header")));
715 AddPragmaHandler("GCC", new PragmaDependencyHandler(
716 getIdentifierInfo("dependency")));
Chris Lattneredaf8772009-04-19 23:16:58 +0000717 AddPragmaHandler("GCC", new PragmaDiagnosticHandler(
Chris Lattner04ae2df2009-07-12 21:18:45 +0000718 getIdentifierInfo("diagnostic"),
719 false));
Chris Lattnere8fa06e2009-05-12 18:21:11 +0000720 // #pragma clang ...
721 AddPragmaHandler("clang", new PragmaPoisonHandler(
722 getIdentifierInfo("poison")));
723 AddPragmaHandler("clang", new PragmaSystemHeaderHandler(
724 getIdentifierInfo("system_header")));
725 AddPragmaHandler("clang", new PragmaDependencyHandler(
726 getIdentifierInfo("dependency")));
727 AddPragmaHandler("clang", new PragmaDiagnosticHandler(
Chris Lattner04ae2df2009-07-12 21:18:45 +0000728 getIdentifierInfo("diagnostic"),
729 true));
Chris Lattnere8fa06e2009-05-12 18:21:11 +0000730
Chris Lattner062f2322009-04-19 21:20:35 +0000731 AddPragmaHandler("STDC", new PragmaSTDC_FP_CONTRACTHandler(
732 getIdentifierInfo("FP_CONTRACT")));
733 AddPragmaHandler("STDC", new PragmaSTDC_FENV_ACCESSHandler(
734 getIdentifierInfo("FENV_ACCESS")));
735 AddPragmaHandler("STDC", new PragmaSTDC_CX_LIMITED_RANGEHandler(
736 getIdentifierInfo("CX_LIMITED_RANGE")));
737 AddPragmaHandler("STDC", new PragmaSTDC_UnknownHandler());
Mike Stump1eb44332009-09-09 15:08:12 +0000738
Chris Lattner636c5ef2009-01-16 08:21:25 +0000739 // MS extensions.
740 if (Features.Microsoft)
741 AddPragmaHandler(0, new PragmaCommentHandler(getIdentifierInfo("comment")));
Reid Spencer5f016e22007-07-11 17:01:13 +0000742}