blob: 4ebe1579d03e4ee5f593677ba790dffda69cf5b1 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- Lexer.cpp - C Language Family Lexer ------------------------------===//
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//
Chris Lattnerd2177732007-07-20 16:59:19 +000010// This file implements the Lexer and Token interfaces.
Reid Spencer5f016e22007-07-11 17:01:13 +000011//
12//===----------------------------------------------------------------------===//
13//
14// TODO: GCC Diagnostics emitted by the lexer:
15// PEDWARN: (form feed|vertical tab) in preprocessing directive
16//
17// Universal characters, unicode, char mapping:
18// WARNING: `%.*s' is not in NFKC
19// WARNING: `%.*s' is not in NFC
20//
21// Other:
22// TODO: Options to support:
23// -fexec-charset,-fwide-exec-charset
24//
25//===----------------------------------------------------------------------===//
26
27#include "clang/Lex/Lexer.h"
28#include "clang/Lex/Preprocessor.h"
Chris Lattner500d3292009-01-29 05:15:15 +000029#include "clang/Lex/LexDiagnostic.h"
Douglas Gregor55817af2010-08-25 17:04:25 +000030#include "clang/Lex/CodeCompletionHandler.h"
Chris Lattner9dc1f532007-07-20 16:37:10 +000031#include "clang/Basic/SourceManager.h"
Douglas Gregorf033f1d2010-07-20 20:18:03 +000032#include "llvm/ADT/StringSwitch.h"
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +000033#include "llvm/ADT/STLExtras.h"
Chris Lattner409a0362007-07-22 18:38:25 +000034#include "llvm/Support/Compiler.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000035#include "llvm/Support/MemoryBuffer.h"
Craig Topper2fa4e862011-08-11 04:06:15 +000036#include <cstring>
Reid Spencer5f016e22007-07-11 17:01:13 +000037using namespace clang;
38
Chris Lattnera2bf1052009-12-17 05:29:40 +000039static void InitCharacterInfo();
Reid Spencer5f016e22007-07-11 17:01:13 +000040
Chris Lattnerdbf388b2007-10-07 08:47:24 +000041//===----------------------------------------------------------------------===//
42// Token Class Implementation
43//===----------------------------------------------------------------------===//
44
Mike Stump1eb44332009-09-09 15:08:12 +000045/// isObjCAtKeyword - Return true if we have an ObjC keyword identifier.
Chris Lattnerdbf388b2007-10-07 08:47:24 +000046bool Token::isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const {
Douglas Gregorbec1c9d2008-12-01 21:46:47 +000047 if (IdentifierInfo *II = getIdentifierInfo())
48 return II->getObjCKeywordID() == objcKey;
49 return false;
Chris Lattnerdbf388b2007-10-07 08:47:24 +000050}
51
52/// getObjCKeywordID - Return the ObjC keyword kind.
53tok::ObjCKeywordKind Token::getObjCKeywordID() const {
54 IdentifierInfo *specId = getIdentifierInfo();
55 return specId ? specId->getObjCKeywordID() : tok::objc_not_keyword;
56}
57
Chris Lattner53702cd2007-12-13 01:59:49 +000058
Chris Lattnerdbf388b2007-10-07 08:47:24 +000059//===----------------------------------------------------------------------===//
60// Lexer Class Implementation
61//===----------------------------------------------------------------------===//
62
David Blaikie99ba9e32011-12-20 02:48:34 +000063void Lexer::anchor() { }
64
Mike Stump1eb44332009-09-09 15:08:12 +000065void Lexer::InitLexer(const char *BufStart, const char *BufPtr,
Chris Lattner22d91ca2009-01-17 06:55:17 +000066 const char *BufEnd) {
Chris Lattnera2bf1052009-12-17 05:29:40 +000067 InitCharacterInfo();
Mike Stump1eb44332009-09-09 15:08:12 +000068
Chris Lattner22d91ca2009-01-17 06:55:17 +000069 BufferStart = BufStart;
70 BufferPtr = BufPtr;
71 BufferEnd = BufEnd;
Mike Stump1eb44332009-09-09 15:08:12 +000072
Chris Lattner22d91ca2009-01-17 06:55:17 +000073 assert(BufEnd[0] == 0 &&
74 "We assume that the input buffer has a null character at the end"
75 " to simplify lexing!");
Mike Stump1eb44332009-09-09 15:08:12 +000076
Eric Christopher156119d2011-04-09 00:01:04 +000077 // Check whether we have a BOM in the beginning of the buffer. If yes - act
78 // accordingly. Right now we support only UTF-8 with and without BOM, so, just
79 // skip the UTF-8 BOM if it's present.
80 if (BufferStart == BufferPtr) {
81 // Determine the size of the BOM.
Chris Lattner5f9e2722011-07-23 10:55:15 +000082 StringRef Buf(BufferStart, BufferEnd - BufferStart);
Eli Friedman969f9d42011-05-10 17:11:21 +000083 size_t BOMLength = llvm::StringSwitch<size_t>(Buf)
Eric Christopher156119d2011-04-09 00:01:04 +000084 .StartsWith("\xEF\xBB\xBF", 3) // UTF-8 BOM
85 .Default(0);
86
87 // Skip the BOM.
88 BufferPtr += BOMLength;
89 }
90
Chris Lattner22d91ca2009-01-17 06:55:17 +000091 Is_PragmaLexer = false;
Richard Smithd5e1d602011-10-12 00:37:51 +000092 CurrentConflictMarkerState = CMK_None;
Eric Christopher156119d2011-04-09 00:01:04 +000093
Chris Lattner22d91ca2009-01-17 06:55:17 +000094 // Start of the file is a start of line.
95 IsAtStartOfLine = true;
Mike Stump1eb44332009-09-09 15:08:12 +000096
Chris Lattner22d91ca2009-01-17 06:55:17 +000097 // We are not after parsing a #.
98 ParsingPreprocessorDirective = false;
Mike Stump1eb44332009-09-09 15:08:12 +000099
Chris Lattner22d91ca2009-01-17 06:55:17 +0000100 // We are not after parsing #include.
101 ParsingFilename = false;
Mike Stump1eb44332009-09-09 15:08:12 +0000102
Chris Lattner22d91ca2009-01-17 06:55:17 +0000103 // We are not in raw mode. Raw mode disables diagnostics and interpretation
104 // of tokens (e.g. identifiers, thus disabling macro expansion). It is used
105 // to quickly lex the tokens of the buffer, e.g. when handling a "#if 0" block
106 // or otherwise skipping over tokens.
107 LexingRawMode = false;
Mike Stump1eb44332009-09-09 15:08:12 +0000108
Chris Lattner22d91ca2009-01-17 06:55:17 +0000109 // Default to not keeping comments.
110 ExtendedTokenMode = 0;
111}
112
Chris Lattner0770dab2009-01-17 07:56:59 +0000113/// Lexer constructor - Create a new lexer object for the specified buffer
114/// with the specified preprocessor managing the lexing process. This lexer
115/// assumes that the associated file buffer and Preprocessor objects will
116/// outlive it, so it doesn't take ownership of either of them.
Chris Lattner6e290142009-11-30 04:18:44 +0000117Lexer::Lexer(FileID FID, const llvm::MemoryBuffer *InputFile, Preprocessor &PP)
Chris Lattner88d3ac12009-01-17 08:03:42 +0000118 : PreprocessorLexer(&PP, FID),
119 FileLoc(PP.getSourceManager().getLocForStartOfFile(FID)),
David Blaikie4e4d0842012-03-11 07:00:24 +0000120 LangOpts(PP.getLangOpts()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000121
Chris Lattner0770dab2009-01-17 07:56:59 +0000122 InitLexer(InputFile->getBufferStart(), InputFile->getBufferStart(),
123 InputFile->getBufferEnd());
Mike Stump1eb44332009-09-09 15:08:12 +0000124
Chris Lattner0770dab2009-01-17 07:56:59 +0000125 // Default to keeping comments if the preprocessor wants them.
126 SetCommentRetentionState(PP.getCommentRetentionState());
127}
Chris Lattnerdbf388b2007-10-07 08:47:24 +0000128
Chris Lattner168ae2d2007-10-17 20:41:00 +0000129/// Lexer constructor - Create a new raw lexer object. This object is only
Dmitri Gribenko092bf672012-06-08 23:19:37 +0000130/// suitable for calls to 'LexFromRawLexer'. This lexer assumes that the text
Chris Lattner590f0cc2008-10-12 01:15:46 +0000131/// range will outlive it, so it doesn't take ownership of it.
David Blaikie4e4d0842012-03-11 07:00:24 +0000132Lexer::Lexer(SourceLocation fileloc, const LangOptions &langOpts,
Chris Lattnerde96c0f2009-01-17 07:42:27 +0000133 const char *BufStart, const char *BufPtr, const char *BufEnd)
David Blaikie4e4d0842012-03-11 07:00:24 +0000134 : FileLoc(fileloc), LangOpts(langOpts) {
Chris Lattner22d91ca2009-01-17 06:55:17 +0000135
Chris Lattner22d91ca2009-01-17 06:55:17 +0000136 InitLexer(BufStart, BufPtr, BufEnd);
Mike Stump1eb44332009-09-09 15:08:12 +0000137
Chris Lattner168ae2d2007-10-17 20:41:00 +0000138 // We *are* in raw mode.
139 LexingRawMode = true;
Chris Lattner168ae2d2007-10-17 20:41:00 +0000140}
141
Chris Lattner025c3a62009-01-17 07:35:14 +0000142/// Lexer constructor - Create a new raw lexer object. This object is only
Dmitri Gribenko092bf672012-06-08 23:19:37 +0000143/// suitable for calls to 'LexFromRawLexer'. This lexer assumes that the text
Chris Lattner025c3a62009-01-17 07:35:14 +0000144/// range will outlive it, so it doesn't take ownership of it.
Chris Lattner6e290142009-11-30 04:18:44 +0000145Lexer::Lexer(FileID FID, const llvm::MemoryBuffer *FromFile,
David Blaikie4e4d0842012-03-11 07:00:24 +0000146 const SourceManager &SM, const LangOptions &langOpts)
147 : FileLoc(SM.getLocForStartOfFile(FID)), LangOpts(langOpts) {
Chris Lattner025c3a62009-01-17 07:35:14 +0000148
Mike Stump1eb44332009-09-09 15:08:12 +0000149 InitLexer(FromFile->getBufferStart(), FromFile->getBufferStart(),
Chris Lattner025c3a62009-01-17 07:35:14 +0000150 FromFile->getBufferEnd());
Mike Stump1eb44332009-09-09 15:08:12 +0000151
Chris Lattner025c3a62009-01-17 07:35:14 +0000152 // We *are* in raw mode.
153 LexingRawMode = true;
154}
155
Chris Lattner42e00d12009-01-17 08:27:52 +0000156/// Create_PragmaLexer: Lexer constructor - Create a new lexer object for
157/// _Pragma expansion. This has a variety of magic semantics that this method
158/// sets up. It returns a new'd Lexer that must be delete'd when done.
159///
160/// On entrance to this routine, TokStartLoc is a macro location which has a
161/// spelling loc that indicates the bytes to be lexed for the token and an
Chandler Carruth433db062011-07-14 08:20:40 +0000162/// expansion location that indicates where all lexed tokens should be
Chris Lattner42e00d12009-01-17 08:27:52 +0000163/// "expanded from".
164///
165/// FIXME: It would really be nice to make _Pragma just be a wrapper around a
166/// normal lexer that remaps tokens as they fly by. This would require making
167/// Preprocessor::Lex virtual. Given that, we could just dump in a magic lexer
168/// interface that could handle this stuff. This would pull GetMappedTokenLoc
169/// out of the critical path of the lexer!
170///
Mike Stump1eb44332009-09-09 15:08:12 +0000171Lexer *Lexer::Create_PragmaLexer(SourceLocation SpellingLoc,
Chandler Carruth433db062011-07-14 08:20:40 +0000172 SourceLocation ExpansionLocStart,
173 SourceLocation ExpansionLocEnd,
Chris Lattnerbcc2a672009-01-19 06:46:35 +0000174 unsigned TokLen, Preprocessor &PP) {
Chris Lattner42e00d12009-01-17 08:27:52 +0000175 SourceManager &SM = PP.getSourceManager();
Chris Lattner42e00d12009-01-17 08:27:52 +0000176
177 // Create the lexer as if we were going to lex the file normally.
Chris Lattnera11d6172009-01-19 07:46:45 +0000178 FileID SpellingFID = SM.getFileID(SpellingLoc);
Chris Lattner6e290142009-11-30 04:18:44 +0000179 const llvm::MemoryBuffer *InputFile = SM.getBuffer(SpellingFID);
180 Lexer *L = new Lexer(SpellingFID, InputFile, PP);
Mike Stump1eb44332009-09-09 15:08:12 +0000181
Chris Lattner42e00d12009-01-17 08:27:52 +0000182 // Now that the lexer is created, change the start/end locations so that we
183 // just lex the subsection of the file that we want. This is lexing from a
184 // scratch buffer.
185 const char *StrData = SM.getCharacterData(SpellingLoc);
Mike Stump1eb44332009-09-09 15:08:12 +0000186
Chris Lattner42e00d12009-01-17 08:27:52 +0000187 L->BufferPtr = StrData;
188 L->BufferEnd = StrData+TokLen;
Chris Lattner1fa49532009-03-08 08:08:45 +0000189 assert(L->BufferEnd[0] == 0 && "Buffer is not nul terminated!");
Chris Lattner42e00d12009-01-17 08:27:52 +0000190
191 // Set the SourceLocation with the remapping information. This ensures that
192 // GetMappedTokenLoc will remap the tokens as they are lexed.
Chandler Carruthbf340e42011-07-26 03:03:05 +0000193 L->FileLoc = SM.createExpansionLoc(SM.getLocForStartOfFile(SpellingFID),
194 ExpansionLocStart,
195 ExpansionLocEnd, TokLen);
Mike Stump1eb44332009-09-09 15:08:12 +0000196
Chris Lattner42e00d12009-01-17 08:27:52 +0000197 // Ensure that the lexer thinks it is inside a directive, so that end \n will
Peter Collingbourne84021552011-02-28 02:37:51 +0000198 // return an EOD token.
Chris Lattner42e00d12009-01-17 08:27:52 +0000199 L->ParsingPreprocessorDirective = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000200
Chris Lattner42e00d12009-01-17 08:27:52 +0000201 // This lexer really is for _Pragma.
202 L->Is_PragmaLexer = true;
203 return L;
204}
205
Chris Lattner168ae2d2007-10-17 20:41:00 +0000206
Reid Spencer5f016e22007-07-11 17:01:13 +0000207/// Stringify - Convert the specified string into a C string, with surrounding
208/// ""'s, and with escaped \ and " characters.
209std::string Lexer::Stringify(const std::string &Str, bool Charify) {
210 std::string Result = Str;
211 char Quote = Charify ? '\'' : '"';
212 for (unsigned i = 0, e = Result.size(); i != e; ++i) {
213 if (Result[i] == '\\' || Result[i] == Quote) {
214 Result.insert(Result.begin()+i, '\\');
215 ++i; ++e;
216 }
217 }
218 return Result;
219}
220
Chris Lattnerd8e30832007-07-24 06:57:14 +0000221/// Stringify - Convert the specified string into a C string by escaping '\'
222/// and " characters. This does not add surrounding ""'s to the string.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000223void Lexer::Stringify(SmallVectorImpl<char> &Str) {
Chris Lattnerd8e30832007-07-24 06:57:14 +0000224 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
225 if (Str[i] == '\\' || Str[i] == '"') {
226 Str.insert(Str.begin()+i, '\\');
227 ++i; ++e;
228 }
229 }
230}
231
Chris Lattnerb0607272010-11-17 07:26:20 +0000232//===----------------------------------------------------------------------===//
233// Token Spelling
234//===----------------------------------------------------------------------===//
235
236/// getSpelling() - Return the 'spelling' of this token. The spelling of a
237/// token are the characters used to represent the token in the source file
238/// after trigraph expansion and escaped-newline folding. In particular, this
239/// wants to get the true, uncanonicalized, spelling of things like digraphs
240/// UCNs, etc.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000241StringRef Lexer::getSpelling(SourceLocation loc,
242 SmallVectorImpl<char> &buffer,
John McCall834e3f62011-03-08 07:59:04 +0000243 const SourceManager &SM,
244 const LangOptions &options,
245 bool *invalid) {
246 // Break down the source location.
247 std::pair<FileID, unsigned> locInfo = SM.getDecomposedLoc(loc);
248
249 // Try to the load the file buffer.
250 bool invalidTemp = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000251 StringRef file = SM.getBufferData(locInfo.first, &invalidTemp);
John McCall834e3f62011-03-08 07:59:04 +0000252 if (invalidTemp) {
253 if (invalid) *invalid = true;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000254 return StringRef();
John McCall834e3f62011-03-08 07:59:04 +0000255 }
256
257 const char *tokenBegin = file.data() + locInfo.second;
258
259 // Lex from the start of the given location.
260 Lexer lexer(SM.getLocForStartOfFile(locInfo.first), options,
261 file.begin(), tokenBegin, file.end());
262 Token token;
263 lexer.LexFromRawLexer(token);
264
265 unsigned length = token.getLength();
266
267 // Common case: no need for cleaning.
268 if (!token.needsCleaning())
Chris Lattner5f9e2722011-07-23 10:55:15 +0000269 return StringRef(tokenBegin, length);
John McCall834e3f62011-03-08 07:59:04 +0000270
271 // Hard case, we need to relex the characters into the string.
272 buffer.clear();
273 buffer.reserve(length);
274
275 for (const char *ti = tokenBegin, *te = ti + length; ti != te; ) {
276 unsigned charSize;
277 buffer.push_back(Lexer::getCharAndSizeNoWarn(ti, charSize, options));
278 ti += charSize;
279 }
280
Chris Lattner5f9e2722011-07-23 10:55:15 +0000281 return StringRef(buffer.data(), buffer.size());
John McCall834e3f62011-03-08 07:59:04 +0000282}
283
284/// getSpelling() - Return the 'spelling' of this token. The spelling of a
285/// token are the characters used to represent the token in the source file
286/// after trigraph expansion and escaped-newline folding. In particular, this
287/// wants to get the true, uncanonicalized, spelling of things like digraphs
288/// UCNs, etc.
Chris Lattnerb0607272010-11-17 07:26:20 +0000289std::string Lexer::getSpelling(const Token &Tok, const SourceManager &SourceMgr,
David Blaikie4e4d0842012-03-11 07:00:24 +0000290 const LangOptions &LangOpts, bool *Invalid) {
Chris Lattnerb0607272010-11-17 07:26:20 +0000291 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
292
293 // If this token contains nothing interesting, return it directly.
294 bool CharDataInvalid = false;
295 const char* TokStart = SourceMgr.getCharacterData(Tok.getLocation(),
296 &CharDataInvalid);
297 if (Invalid)
298 *Invalid = CharDataInvalid;
299 if (CharDataInvalid)
300 return std::string();
301
302 if (!Tok.needsCleaning())
303 return std::string(TokStart, TokStart+Tok.getLength());
304
305 std::string Result;
306 Result.reserve(Tok.getLength());
307
308 // Otherwise, hard case, relex the characters into the string.
309 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
310 Ptr != End; ) {
311 unsigned CharSize;
David Blaikie4e4d0842012-03-11 07:00:24 +0000312 Result.push_back(Lexer::getCharAndSizeNoWarn(Ptr, CharSize, LangOpts));
Chris Lattnerb0607272010-11-17 07:26:20 +0000313 Ptr += CharSize;
314 }
315 assert(Result.size() != unsigned(Tok.getLength()) &&
316 "NeedsCleaning flag set on something that didn't need cleaning!");
317 return Result;
318}
319
320/// getSpelling - This method is used to get the spelling of a token into a
321/// preallocated buffer, instead of as an std::string. The caller is required
322/// to allocate enough space for the token, which is guaranteed to be at least
323/// Tok.getLength() bytes long. The actual length of the token is returned.
324///
325/// Note that this method may do two possible things: it may either fill in
326/// the buffer specified with characters, or it may *change the input pointer*
327/// to point to a constant buffer with the data already in it (avoiding a
328/// copy). The caller is not allowed to modify the returned buffer pointer
329/// if an internal buffer is returned.
330unsigned Lexer::getSpelling(const Token &Tok, const char *&Buffer,
331 const SourceManager &SourceMgr,
David Blaikie4e4d0842012-03-11 07:00:24 +0000332 const LangOptions &LangOpts, bool *Invalid) {
Chris Lattnerb0607272010-11-17 07:26:20 +0000333 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000334
335 const char *TokStart = 0;
336 // NOTE: this has to be checked *before* testing for an IdentifierInfo.
337 if (Tok.is(tok::raw_identifier))
338 TokStart = Tok.getRawIdentifierData();
339 else if (const IdentifierInfo *II = Tok.getIdentifierInfo()) {
340 // Just return the string from the identifier table, which is very quick.
Chris Lattnerb0607272010-11-17 07:26:20 +0000341 Buffer = II->getNameStart();
342 return II->getLength();
343 }
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000344
345 // NOTE: this can be checked even after testing for an IdentifierInfo.
Chris Lattnerb0607272010-11-17 07:26:20 +0000346 if (Tok.isLiteral())
347 TokStart = Tok.getLiteralData();
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000348
Chris Lattnerb0607272010-11-17 07:26:20 +0000349 if (TokStart == 0) {
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000350 // Compute the start of the token in the input lexer buffer.
Chris Lattnerb0607272010-11-17 07:26:20 +0000351 bool CharDataInvalid = false;
352 TokStart = SourceMgr.getCharacterData(Tok.getLocation(), &CharDataInvalid);
353 if (Invalid)
354 *Invalid = CharDataInvalid;
355 if (CharDataInvalid) {
356 Buffer = "";
357 return 0;
358 }
359 }
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000360
Chris Lattnerb0607272010-11-17 07:26:20 +0000361 // If this token contains nothing interesting, return it directly.
362 if (!Tok.needsCleaning()) {
363 Buffer = TokStart;
364 return Tok.getLength();
365 }
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000366
Chris Lattnerb0607272010-11-17 07:26:20 +0000367 // Otherwise, hard case, relex the characters into the string.
368 char *OutBuf = const_cast<char*>(Buffer);
369 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
370 Ptr != End; ) {
371 unsigned CharSize;
David Blaikie4e4d0842012-03-11 07:00:24 +0000372 *OutBuf++ = Lexer::getCharAndSizeNoWarn(Ptr, CharSize, LangOpts);
Chris Lattnerb0607272010-11-17 07:26:20 +0000373 Ptr += CharSize;
374 }
375 assert(unsigned(OutBuf-Buffer) != Tok.getLength() &&
376 "NeedsCleaning flag set on something that didn't need cleaning!");
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000377
Chris Lattnerb0607272010-11-17 07:26:20 +0000378 return OutBuf-Buffer;
379}
380
381
382
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000383static bool isWhitespace(unsigned char c);
Reid Spencer5f016e22007-07-11 17:01:13 +0000384
Chris Lattner9a611942007-10-17 21:18:47 +0000385/// MeasureTokenLength - Relex the token at the specified location and return
386/// its length in bytes in the input file. If the token needs cleaning (e.g.
387/// includes a trigraph or an escaped newline) then this count includes bytes
388/// that are part of that.
389unsigned Lexer::MeasureTokenLength(SourceLocation Loc,
Chris Lattner2c78b872009-04-14 23:22:57 +0000390 const SourceManager &SM,
391 const LangOptions &LangOpts) {
Chris Lattner9a611942007-10-17 21:18:47 +0000392 // TODO: this could be special cased for common tokens like identifiers, ')',
393 // etc to make this faster, if it mattered. Just look at StrData[0] to handle
Mike Stump1eb44332009-09-09 15:08:12 +0000394 // all obviously single-char tokens. This could use
Chris Lattner9a611942007-10-17 21:18:47 +0000395 // Lexer::isObviouslySimpleCharacter for example to handle identifiers or
396 // something.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000397
398 // If this comes from a macro expansion, we really do want the macro name, not
399 // the token this macro expanded to.
Chandler Carruth40278532011-07-25 16:49:02 +0000400 Loc = SM.getExpansionLoc(Loc);
Chris Lattner363fdc22009-01-26 22:24:27 +0000401 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +0000402 bool Invalid = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000403 StringRef Buffer = SM.getBufferData(LocInfo.first, &Invalid);
Douglas Gregorf715ca12010-03-16 00:06:06 +0000404 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +0000405 return 0;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +0000406
407 const char *StrData = Buffer.data()+LocInfo.second;
Chris Lattner83503942009-01-17 08:30:10 +0000408
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000409 if (isWhitespace(StrData[0]))
410 return 0;
411
Chris Lattner9a611942007-10-17 21:18:47 +0000412 // Create a lexer starting at the beginning of this token.
Sebastian Redlc3526d82010-09-30 01:03:03 +0000413 Lexer TheLexer(SM.getLocForStartOfFile(LocInfo.first), LangOpts,
414 Buffer.begin(), StrData, Buffer.end());
Chris Lattner39de7402009-10-14 15:04:18 +0000415 TheLexer.SetCommentRetentionState(true);
Chris Lattner9a611942007-10-17 21:18:47 +0000416 Token TheTok;
Chris Lattner590f0cc2008-10-12 01:15:46 +0000417 TheLexer.LexFromRawLexer(TheTok);
Chris Lattner9a611942007-10-17 21:18:47 +0000418 return TheTok.getLength();
419}
420
Argyrios Kyrtzidis0e870622011-08-17 00:31:23 +0000421static SourceLocation getBeginningOfFileToken(SourceLocation Loc,
422 const SourceManager &SM,
423 const LangOptions &LangOpts) {
424 assert(Loc.isFileID());
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000425 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc);
Douglas Gregor3de84242011-01-31 22:42:36 +0000426 if (LocInfo.first.isInvalid())
427 return Loc;
428
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000429 bool Invalid = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000430 StringRef Buffer = SM.getBufferData(LocInfo.first, &Invalid);
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000431 if (Invalid)
432 return Loc;
433
434 // Back up from the current location until we hit the beginning of a line
435 // (or the buffer). We'll relex from that point.
436 const char *BufStart = Buffer.data();
Douglas Gregor3de84242011-01-31 22:42:36 +0000437 if (LocInfo.second >= Buffer.size())
438 return Loc;
439
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000440 const char *StrData = BufStart+LocInfo.second;
441 if (StrData[0] == '\n' || StrData[0] == '\r')
442 return Loc;
443
444 const char *LexStart = StrData;
445 while (LexStart != BufStart) {
446 if (LexStart[0] == '\n' || LexStart[0] == '\r') {
447 ++LexStart;
448 break;
449 }
450
451 --LexStart;
452 }
453
454 // Create a lexer starting at the beginning of this token.
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000455 SourceLocation LexerStartLoc = Loc.getLocWithOffset(-LocInfo.second);
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000456 Lexer TheLexer(LexerStartLoc, LangOpts, BufStart, LexStart, Buffer.end());
457 TheLexer.SetCommentRetentionState(true);
458
459 // Lex tokens until we find the token that contains the source location.
460 Token TheTok;
461 do {
462 TheLexer.LexFromRawLexer(TheTok);
463
464 if (TheLexer.getBufferLocation() > StrData) {
465 // Lexing this token has taken the lexer past the source location we're
466 // looking for. If the current token encompasses our source location,
467 // return the beginning of that token.
468 if (TheLexer.getBufferLocation() - TheTok.getLength() <= StrData)
469 return TheTok.getLocation();
470
471 // We ended up skipping over the source location entirely, which means
472 // that it points into whitespace. We're done here.
473 break;
474 }
475 } while (TheTok.getKind() != tok::eof);
476
477 // We've passed our source location; just return the original source location.
478 return Loc;
479}
480
Argyrios Kyrtzidis0e870622011-08-17 00:31:23 +0000481SourceLocation Lexer::GetBeginningOfToken(SourceLocation Loc,
482 const SourceManager &SM,
483 const LangOptions &LangOpts) {
484 if (Loc.isFileID())
485 return getBeginningOfFileToken(Loc, SM, LangOpts);
486
487 if (!SM.isMacroArgExpansion(Loc))
488 return Loc;
489
490 SourceLocation FileLoc = SM.getSpellingLoc(Loc);
491 SourceLocation BeginFileLoc = getBeginningOfFileToken(FileLoc, SM, LangOpts);
492 std::pair<FileID, unsigned> FileLocInfo = SM.getDecomposedLoc(FileLoc);
Chandler Carruthae9f85b2012-01-15 09:03:45 +0000493 std::pair<FileID, unsigned> BeginFileLocInfo
494 = SM.getDecomposedLoc(BeginFileLoc);
Argyrios Kyrtzidis0e870622011-08-17 00:31:23 +0000495 assert(FileLocInfo.first == BeginFileLocInfo.first &&
496 FileLocInfo.second >= BeginFileLocInfo.second);
Chandler Carruthae9f85b2012-01-15 09:03:45 +0000497 return Loc.getLocWithOffset(BeginFileLocInfo.second - FileLocInfo.second);
Argyrios Kyrtzidis0e870622011-08-17 00:31:23 +0000498}
499
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000500namespace {
501 enum PreambleDirectiveKind {
502 PDK_Skipped,
503 PDK_StartIf,
504 PDK_EndIf,
505 PDK_Unknown
506 };
507}
508
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000509std::pair<unsigned, bool>
Argyrios Kyrtzidis03c107a2011-08-25 20:39:19 +0000510Lexer::ComputePreamble(const llvm::MemoryBuffer *Buffer,
David Blaikie4e4d0842012-03-11 07:00:24 +0000511 const LangOptions &LangOpts, unsigned MaxLines) {
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000512 // Create a lexer starting at the beginning of the file. Note that we use a
513 // "fake" file source location at offset 1 so that the lexer will track our
514 // position within the file.
515 const unsigned StartOffset = 1;
516 SourceLocation StartLoc = SourceLocation::getFromRawEncoding(StartOffset);
David Blaikie4e4d0842012-03-11 07:00:24 +0000517 Lexer TheLexer(StartLoc, LangOpts, Buffer->getBufferStart(),
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000518 Buffer->getBufferStart(), Buffer->getBufferEnd());
519
520 bool InPreprocessorDirective = false;
521 Token TheTok;
522 Token IfStartTok;
523 unsigned IfCount = 0;
Argyrios Kyrtzidisc8c97a02011-09-04 03:32:04 +0000524
525 unsigned MaxLineOffset = 0;
526 if (MaxLines) {
527 const char *CurPtr = Buffer->getBufferStart();
528 unsigned CurLine = 0;
529 while (CurPtr != Buffer->getBufferEnd()) {
530 char ch = *CurPtr++;
531 if (ch == '\n') {
532 ++CurLine;
533 if (CurLine == MaxLines)
534 break;
535 }
536 }
537 if (CurPtr != Buffer->getBufferEnd())
538 MaxLineOffset = CurPtr - Buffer->getBufferStart();
539 }
Douglas Gregordf95a132010-08-09 20:45:32 +0000540
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000541 do {
542 TheLexer.LexFromRawLexer(TheTok);
543
544 if (InPreprocessorDirective) {
545 // If we've hit the end of the file, we're done.
546 if (TheTok.getKind() == tok::eof) {
547 InPreprocessorDirective = false;
548 break;
549 }
550
551 // If we haven't hit the end of the preprocessor directive, skip this
552 // token.
553 if (!TheTok.isAtStartOfLine())
554 continue;
555
556 // We've passed the end of the preprocessor directive, and will look
557 // at this token again below.
558 InPreprocessorDirective = false;
559 }
560
Douglas Gregordf95a132010-08-09 20:45:32 +0000561 // Keep track of the # of lines in the preamble.
562 if (TheTok.isAtStartOfLine()) {
Argyrios Kyrtzidisc8c97a02011-09-04 03:32:04 +0000563 unsigned TokOffset = TheTok.getLocation().getRawEncoding() - StartOffset;
Douglas Gregordf95a132010-08-09 20:45:32 +0000564
565 // If we were asked to limit the number of lines in the preamble,
566 // and we're about to exceed that limit, we're done.
Argyrios Kyrtzidisc8c97a02011-09-04 03:32:04 +0000567 if (MaxLineOffset && TokOffset >= MaxLineOffset)
Douglas Gregordf95a132010-08-09 20:45:32 +0000568 break;
569 }
570
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000571 // Comments are okay; skip over them.
572 if (TheTok.getKind() == tok::comment)
573 continue;
574
575 if (TheTok.isAtStartOfLine() && TheTok.getKind() == tok::hash) {
576 // This is the start of a preprocessor directive.
577 Token HashTok = TheTok;
578 InPreprocessorDirective = true;
579
Joerg Sonnenberger19207f12011-07-20 00:14:37 +0000580 // Figure out which directive this is. Since we're lexing raw tokens,
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000581 // we don't have an identifier table available. Instead, just look at
582 // the raw identifier to recognize and categorize preprocessor directives.
583 TheLexer.LexFromRawLexer(TheTok);
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000584 if (TheTok.getKind() == tok::raw_identifier && !TheTok.needsCleaning()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000585 StringRef Keyword(TheTok.getRawIdentifierData(),
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +0000586 TheTok.getLength());
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000587 PreambleDirectiveKind PDK
588 = llvm::StringSwitch<PreambleDirectiveKind>(Keyword)
589 .Case("include", PDK_Skipped)
590 .Case("__include_macros", PDK_Skipped)
591 .Case("define", PDK_Skipped)
592 .Case("undef", PDK_Skipped)
593 .Case("line", PDK_Skipped)
594 .Case("error", PDK_Skipped)
595 .Case("pragma", PDK_Skipped)
596 .Case("import", PDK_Skipped)
597 .Case("include_next", PDK_Skipped)
598 .Case("warning", PDK_Skipped)
599 .Case("ident", PDK_Skipped)
600 .Case("sccs", PDK_Skipped)
601 .Case("assert", PDK_Skipped)
602 .Case("unassert", PDK_Skipped)
603 .Case("if", PDK_StartIf)
604 .Case("ifdef", PDK_StartIf)
605 .Case("ifndef", PDK_StartIf)
606 .Case("elif", PDK_Skipped)
607 .Case("else", PDK_Skipped)
608 .Case("endif", PDK_EndIf)
609 .Default(PDK_Unknown);
610
611 switch (PDK) {
612 case PDK_Skipped:
613 continue;
614
615 case PDK_StartIf:
616 if (IfCount == 0)
617 IfStartTok = HashTok;
618
619 ++IfCount;
620 continue;
621
622 case PDK_EndIf:
623 // Mismatched #endif. The preamble ends here.
624 if (IfCount == 0)
625 break;
626
627 --IfCount;
628 continue;
629
630 case PDK_Unknown:
631 // We don't know what this directive is; stop at the '#'.
632 break;
633 }
634 }
635
636 // We only end up here if we didn't recognize the preprocessor
637 // directive or it was one that can't occur in the preamble at this
638 // point. Roll back the current token to the location of the '#'.
639 InPreprocessorDirective = false;
640 TheTok = HashTok;
641 }
642
Douglas Gregordf95a132010-08-09 20:45:32 +0000643 // We hit a token that we don't recognize as being in the
644 // "preprocessing only" part of the file, so we're no longer in
645 // the preamble.
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000646 break;
647 } while (true);
648
649 SourceLocation End = IfCount? IfStartTok.getLocation() : TheTok.getLocation();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000650 return std::make_pair(End.getRawEncoding() - StartLoc.getRawEncoding(),
651 IfCount? IfStartTok.isAtStartOfLine()
652 : TheTok.isAtStartOfLine());
Douglas Gregorf033f1d2010-07-20 20:18:03 +0000653}
654
Chris Lattner7ef5c272010-11-17 07:05:50 +0000655
656/// AdvanceToTokenCharacter - Given a location that specifies the start of a
657/// token, return a new location that specifies a character within the token.
658SourceLocation Lexer::AdvanceToTokenCharacter(SourceLocation TokStart,
659 unsigned CharNo,
660 const SourceManager &SM,
David Blaikie4e4d0842012-03-11 07:00:24 +0000661 const LangOptions &LangOpts) {
Chandler Carruth433db062011-07-14 08:20:40 +0000662 // Figure out how many physical characters away the specified expansion
Chris Lattner7ef5c272010-11-17 07:05:50 +0000663 // character is. This needs to take into consideration newlines and
664 // trigraphs.
665 bool Invalid = false;
666 const char *TokPtr = SM.getCharacterData(TokStart, &Invalid);
667
668 // If they request the first char of the token, we're trivially done.
669 if (Invalid || (CharNo == 0 && Lexer::isObviouslySimpleCharacter(*TokPtr)))
670 return TokStart;
671
672 unsigned PhysOffset = 0;
673
674 // The usual case is that tokens don't contain anything interesting. Skip
675 // over the uninteresting characters. If a token only consists of simple
676 // chars, this method is extremely fast.
677 while (Lexer::isObviouslySimpleCharacter(*TokPtr)) {
678 if (CharNo == 0)
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000679 return TokStart.getLocWithOffset(PhysOffset);
Chris Lattner7ef5c272010-11-17 07:05:50 +0000680 ++TokPtr, --CharNo, ++PhysOffset;
681 }
682
683 // If we have a character that may be a trigraph or escaped newline, use a
684 // lexer to parse it correctly.
685 for (; CharNo; --CharNo) {
686 unsigned Size;
David Blaikie4e4d0842012-03-11 07:00:24 +0000687 Lexer::getCharAndSizeNoWarn(TokPtr, Size, LangOpts);
Chris Lattner7ef5c272010-11-17 07:05:50 +0000688 TokPtr += Size;
689 PhysOffset += Size;
690 }
691
692 // Final detail: if we end up on an escaped newline, we want to return the
693 // location of the actual byte of the token. For example foo\<newline>bar
694 // advanced by 3 should return the location of b, not of \\. One compounding
695 // detail of this is that the escape may be made by a trigraph.
696 if (!Lexer::isObviouslySimpleCharacter(*TokPtr))
697 PhysOffset += Lexer::SkipEscapedNewLines(TokPtr)-TokPtr;
698
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000699 return TokStart.getLocWithOffset(PhysOffset);
Chris Lattner7ef5c272010-11-17 07:05:50 +0000700}
701
702/// \brief Computes the source location just past the end of the
703/// token at this source location.
704///
705/// This routine can be used to produce a source location that
706/// points just past the end of the token referenced by \p Loc, and
707/// is generally used when a diagnostic needs to point just after a
708/// token where it expected something different that it received. If
709/// the returned source location would not be meaningful (e.g., if
710/// it points into a macro), this routine returns an invalid
711/// source location.
712///
713/// \param Offset an offset from the end of the token, where the source
714/// location should refer to. The default offset (0) produces a source
715/// location pointing just past the end of the token; an offset of 1 produces
716/// a source location pointing to the last character in the token, etc.
717SourceLocation Lexer::getLocForEndOfToken(SourceLocation Loc, unsigned Offset,
718 const SourceManager &SM,
David Blaikie4e4d0842012-03-11 07:00:24 +0000719 const LangOptions &LangOpts) {
Argyrios Kyrtzidis7ddf6b22011-06-24 17:58:59 +0000720 if (Loc.isInvalid())
Chris Lattner7ef5c272010-11-17 07:05:50 +0000721 return SourceLocation();
Argyrios Kyrtzidis7ddf6b22011-06-24 17:58:59 +0000722
723 if (Loc.isMacroID()) {
David Blaikie4e4d0842012-03-11 07:00:24 +0000724 if (Offset > 0 || !isAtEndOfMacroExpansion(Loc, SM, LangOpts, &Loc))
Chandler Carruth433db062011-07-14 08:20:40 +0000725 return SourceLocation(); // Points inside the macro expansion.
Argyrios Kyrtzidis7ddf6b22011-06-24 17:58:59 +0000726 }
727
David Blaikie4e4d0842012-03-11 07:00:24 +0000728 unsigned Len = Lexer::MeasureTokenLength(Loc, SM, LangOpts);
Chris Lattner7ef5c272010-11-17 07:05:50 +0000729 if (Len > Offset)
730 Len = Len - Offset;
731 else
732 return Loc;
733
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000734 return Loc.getLocWithOffset(Len);
Chris Lattner7ef5c272010-11-17 07:05:50 +0000735}
736
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000737/// \brief Returns true if the given MacroID location points at the first
Chandler Carruth433db062011-07-14 08:20:40 +0000738/// token of the macro expansion.
739bool Lexer::isAtStartOfMacroExpansion(SourceLocation loc,
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000740 const SourceManager &SM,
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000741 const LangOptions &LangOpts,
742 SourceLocation *MacroBegin) {
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000743 assert(loc.isValid() && loc.isMacroID() && "Expected a valid macro loc");
744
745 std::pair<FileID, unsigned> infoLoc = SM.getDecomposedLoc(loc);
746 // FIXME: If the token comes from the macro token paste operator ('##')
747 // this function will always return false;
748 if (infoLoc.second > 0)
749 return false; // Does not point at the start of token.
750
Chandler Carruth433db062011-07-14 08:20:40 +0000751 SourceLocation expansionLoc =
Chandler Carruth17287622011-07-26 04:56:51 +0000752 SM.getSLocEntry(infoLoc.first).getExpansion().getExpansionLocStart();
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000753 if (expansionLoc.isFileID()) {
754 // No other macro expansions, this is the first.
755 if (MacroBegin)
756 *MacroBegin = expansionLoc;
757 return true;
758 }
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000759
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000760 return isAtStartOfMacroExpansion(expansionLoc, SM, LangOpts, MacroBegin);
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000761}
762
763/// \brief Returns true if the given MacroID location points at the last
Chandler Carruth433db062011-07-14 08:20:40 +0000764/// token of the macro expansion.
765bool Lexer::isAtEndOfMacroExpansion(SourceLocation loc,
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000766 const SourceManager &SM,
767 const LangOptions &LangOpts,
768 SourceLocation *MacroEnd) {
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000769 assert(loc.isValid() && loc.isMacroID() && "Expected a valid macro loc");
770
771 SourceLocation spellLoc = SM.getSpellingLoc(loc);
772 unsigned tokLen = MeasureTokenLength(spellLoc, SM, LangOpts);
773 if (tokLen == 0)
774 return false;
775
776 FileID FID = SM.getFileID(loc);
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000777 SourceLocation afterLoc = loc.getLocWithOffset(tokLen+1);
Argyrios Kyrtzidisf8c50652011-08-23 21:02:30 +0000778 if (SM.isInFileID(afterLoc, FID))
779 return false; // Still in the same FileID, does not point to the last token.
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000780
781 // FIXME: If the token comes from the macro token paste operator ('##')
782 // or the stringify operator ('#') this function will always return false;
Argyrios Kyrtzidisf8c50652011-08-23 21:02:30 +0000783
Chandler Carruth433db062011-07-14 08:20:40 +0000784 SourceLocation expansionLoc =
Chandler Carruth17287622011-07-26 04:56:51 +0000785 SM.getSLocEntry(FID).getExpansion().getExpansionLocEnd();
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000786 if (expansionLoc.isFileID()) {
787 // No other macro expansions.
788 if (MacroEnd)
789 *MacroEnd = expansionLoc;
790 return true;
791 }
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000792
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +0000793 return isAtEndOfMacroExpansion(expansionLoc, SM, LangOpts, MacroEnd);
Argyrios Kyrtzidis7a759602011-07-07 21:54:45 +0000794}
795
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000796static CharSourceRange makeRangeFromFileLocs(CharSourceRange Range,
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000797 const SourceManager &SM,
798 const LangOptions &LangOpts) {
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000799 SourceLocation Begin = Range.getBegin();
800 SourceLocation End = Range.getEnd();
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000801 assert(Begin.isFileID() && End.isFileID());
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000802 if (Range.isTokenRange()) {
803 End = Lexer::getLocForEndOfToken(End, 0, SM,LangOpts);
804 if (End.isInvalid())
805 return CharSourceRange();
806 }
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000807
808 // Break down the source locations.
809 FileID FID;
810 unsigned BeginOffs;
811 llvm::tie(FID, BeginOffs) = SM.getDecomposedLoc(Begin);
812 if (FID.isInvalid())
813 return CharSourceRange();
814
815 unsigned EndOffs;
816 if (!SM.isInFileID(End, FID, &EndOffs) ||
817 BeginOffs > EndOffs)
818 return CharSourceRange();
819
820 return CharSourceRange::getCharRange(Begin, End);
821}
822
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000823/// \brief Accepts a range and returns a character range with file locations.
824///
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000825/// Returns a null range if a part of the range resides inside a macro
826/// expansion or the range does not reside on the same FileID.
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000827CharSourceRange Lexer::makeFileCharRange(CharSourceRange Range,
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000828 const SourceManager &SM,
829 const LangOptions &LangOpts) {
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000830 SourceLocation Begin = Range.getBegin();
831 SourceLocation End = Range.getEnd();
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000832 if (Begin.isInvalid() || End.isInvalid())
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000833 return CharSourceRange();
834
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000835 if (Begin.isFileID() && End.isFileID())
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000836 return makeRangeFromFileLocs(Range, SM, LangOpts);
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000837
838 if (Begin.isMacroID() && End.isFileID()) {
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000839 if (!isAtStartOfMacroExpansion(Begin, SM, LangOpts, &Begin))
840 return CharSourceRange();
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000841 Range.setBegin(Begin);
842 return makeRangeFromFileLocs(Range, SM, LangOpts);
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000843 }
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000844
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000845 if (Begin.isFileID() && End.isMacroID()) {
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000846 if ((Range.isTokenRange() && !isAtEndOfMacroExpansion(End, SM, LangOpts,
847 &End)) ||
848 (Range.isCharRange() && !isAtStartOfMacroExpansion(End, SM, LangOpts,
849 &End)))
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000850 return CharSourceRange();
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000851 Range.setEnd(End);
852 return makeRangeFromFileLocs(Range, SM, LangOpts);
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000853 }
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000854
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000855 assert(Begin.isMacroID() && End.isMacroID());
856 SourceLocation MacroBegin, MacroEnd;
857 if (isAtStartOfMacroExpansion(Begin, SM, LangOpts, &MacroBegin) &&
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000858 ((Range.isTokenRange() && isAtEndOfMacroExpansion(End, SM, LangOpts,
859 &MacroEnd)) ||
860 (Range.isCharRange() && isAtStartOfMacroExpansion(End, SM, LangOpts,
861 &MacroEnd)))) {
862 Range.setBegin(MacroBegin);
863 Range.setEnd(MacroEnd);
864 return makeRangeFromFileLocs(Range, SM, LangOpts);
865 }
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000866
867 FileID FID;
868 unsigned BeginOffs;
869 llvm::tie(FID, BeginOffs) = SM.getDecomposedLoc(Begin);
870 if (FID.isInvalid())
Argyrios Kyrtzidise64d9032012-01-19 15:59:19 +0000871 return CharSourceRange();
872
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000873 unsigned EndOffs;
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000874 if (!SM.isInFileID(End, FID, &EndOffs) ||
875 BeginOffs > EndOffs)
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000876 return CharSourceRange();
877
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000878 const SrcMgr::SLocEntry *E = &SM.getSLocEntry(FID);
879 const SrcMgr::ExpansionInfo &Expansion = E->getExpansion();
880 if (Expansion.isMacroArgExpansion() &&
881 Expansion.getSpellingLoc().isFileID()) {
882 SourceLocation SpellLoc = Expansion.getSpellingLoc();
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000883 Range.setBegin(SpellLoc.getLocWithOffset(BeginOffs));
884 Range.setEnd(SpellLoc.getLocWithOffset(EndOffs));
885 return makeRangeFromFileLocs(Range, SM, LangOpts);
Argyrios Kyrtzidisd9806c92012-01-20 16:52:43 +0000886 }
887
888 return CharSourceRange();
Argyrios Kyrtzidis11b652d2012-01-19 15:59:14 +0000889}
890
Argyrios Kyrtzidise64d9032012-01-19 15:59:19 +0000891StringRef Lexer::getSourceText(CharSourceRange Range,
892 const SourceManager &SM,
893 const LangOptions &LangOpts,
894 bool *Invalid) {
Argyrios Kyrtzidisa83f4d22012-02-03 05:58:29 +0000895 Range = makeFileCharRange(Range, SM, LangOpts);
896 if (Range.isInvalid()) {
Argyrios Kyrtzidise64d9032012-01-19 15:59:19 +0000897 if (Invalid) *Invalid = true;
898 return StringRef();
899 }
900
901 // Break down the source location.
902 std::pair<FileID, unsigned> beginInfo = SM.getDecomposedLoc(Range.getBegin());
903 if (beginInfo.first.isInvalid()) {
904 if (Invalid) *Invalid = true;
905 return StringRef();
906 }
907
908 unsigned EndOffs;
909 if (!SM.isInFileID(Range.getEnd(), beginInfo.first, &EndOffs) ||
910 beginInfo.second > EndOffs) {
911 if (Invalid) *Invalid = true;
912 return StringRef();
913 }
914
915 // Try to the load the file buffer.
916 bool invalidTemp = false;
917 StringRef file = SM.getBufferData(beginInfo.first, &invalidTemp);
918 if (invalidTemp) {
919 if (Invalid) *Invalid = true;
920 return StringRef();
921 }
922
923 if (Invalid) *Invalid = false;
924 return file.substr(beginInfo.second, EndOffs - beginInfo.second);
925}
926
Anna Zaksc2a8d6c2012-01-18 20:17:16 +0000927StringRef Lexer::getImmediateMacroName(SourceLocation Loc,
928 const SourceManager &SM,
929 const LangOptions &LangOpts) {
930 assert(Loc.isMacroID() && "Only reasonble to call this on macros");
Argyrios Kyrtzidis7f6cf972012-01-23 16:58:33 +0000931
932 // Find the location of the immediate macro expansion.
933 while (1) {
934 FileID FID = SM.getFileID(Loc);
935 const SrcMgr::SLocEntry *E = &SM.getSLocEntry(FID);
936 const SrcMgr::ExpansionInfo &Expansion = E->getExpansion();
937 Loc = Expansion.getExpansionLocStart();
938 if (!Expansion.isMacroArgExpansion())
939 break;
940
941 // For macro arguments we need to check that the argument did not come
942 // from an inner macro, e.g: "MAC1( MAC2(foo) )"
943
944 // Loc points to the argument id of the macro definition, move to the
945 // macro expansion.
Anna Zaksc2a8d6c2012-01-18 20:17:16 +0000946 Loc = SM.getImmediateExpansionRange(Loc).first;
Argyrios Kyrtzidis7f6cf972012-01-23 16:58:33 +0000947 SourceLocation SpellLoc = Expansion.getSpellingLoc();
948 if (SpellLoc.isFileID())
949 break; // No inner macro.
950
951 // If spelling location resides in the same FileID as macro expansion
952 // location, it means there is no inner macro.
953 FileID MacroFID = SM.getFileID(Loc);
954 if (SM.isInFileID(SpellLoc, MacroFID))
955 break;
956
957 // Argument came from inner macro.
958 Loc = SpellLoc;
959 }
Anna Zaksc2a8d6c2012-01-18 20:17:16 +0000960
961 // Find the spelling location of the start of the non-argument expansion
962 // range. This is where the macro name was spelled in order to begin
963 // expanding this macro.
Argyrios Kyrtzidis7f6cf972012-01-23 16:58:33 +0000964 Loc = SM.getSpellingLoc(Loc);
Anna Zaksc2a8d6c2012-01-18 20:17:16 +0000965
966 // Dig out the buffer where the macro name was spelled and the extents of the
967 // name so that we can render it into the expansion note.
968 std::pair<FileID, unsigned> ExpansionInfo = SM.getDecomposedLoc(Loc);
969 unsigned MacroTokenLength = Lexer::MeasureTokenLength(Loc, SM, LangOpts);
970 StringRef ExpansionBuffer = SM.getBufferData(ExpansionInfo.first);
971 return ExpansionBuffer.substr(ExpansionInfo.second, MacroTokenLength);
972}
973
Reid Spencer5f016e22007-07-11 17:01:13 +0000974//===----------------------------------------------------------------------===//
975// Character information.
976//===----------------------------------------------------------------------===//
977
Reid Spencer5f016e22007-07-11 17:01:13 +0000978enum {
979 CHAR_HORZ_WS = 0x01, // ' ', '\t', '\f', '\v'. Note, no '\0'
980 CHAR_VERT_WS = 0x02, // '\r', '\n'
981 CHAR_LETTER = 0x04, // a-z,A-Z
982 CHAR_NUMBER = 0x08, // 0-9
983 CHAR_UNDER = 0x10, // _
Craig Topper2fa4e862011-08-11 04:06:15 +0000984 CHAR_PERIOD = 0x20, // .
985 CHAR_RAWDEL = 0x40 // {}[]#<>%:;?*+-/^&|~!=,"'
Reid Spencer5f016e22007-07-11 17:01:13 +0000986};
987
Chris Lattner03b98662009-07-07 17:09:54 +0000988// Statically initialize CharInfo table based on ASCII character set
989// Reference: FreeBSD 7.2 /usr/share/misc/ascii
Chris Lattnera2bf1052009-12-17 05:29:40 +0000990static const unsigned char CharInfo[256] =
Chris Lattner03b98662009-07-07 17:09:54 +0000991{
992// 0 NUL 1 SOH 2 STX 3 ETX
993// 4 EOT 5 ENQ 6 ACK 7 BEL
994 0 , 0 , 0 , 0 ,
995 0 , 0 , 0 , 0 ,
996// 8 BS 9 HT 10 NL 11 VT
997//12 NP 13 CR 14 SO 15 SI
998 0 , CHAR_HORZ_WS, CHAR_VERT_WS, CHAR_HORZ_WS,
999 CHAR_HORZ_WS, CHAR_VERT_WS, 0 , 0 ,
1000//16 DLE 17 DC1 18 DC2 19 DC3
1001//20 DC4 21 NAK 22 SYN 23 ETB
1002 0 , 0 , 0 , 0 ,
1003 0 , 0 , 0 , 0 ,
1004//24 CAN 25 EM 26 SUB 27 ESC
1005//28 FS 29 GS 30 RS 31 US
1006 0 , 0 , 0 , 0 ,
1007 0 , 0 , 0 , 0 ,
1008//32 SP 33 ! 34 " 35 #
1009//36 $ 37 % 38 & 39 '
Craig Topper2fa4e862011-08-11 04:06:15 +00001010 CHAR_HORZ_WS, CHAR_RAWDEL , CHAR_RAWDEL , CHAR_RAWDEL ,
1011 0 , CHAR_RAWDEL , CHAR_RAWDEL , CHAR_RAWDEL ,
Chris Lattner03b98662009-07-07 17:09:54 +00001012//40 ( 41 ) 42 * 43 +
1013//44 , 45 - 46 . 47 /
Craig Topper2fa4e862011-08-11 04:06:15 +00001014 0 , 0 , CHAR_RAWDEL , CHAR_RAWDEL ,
1015 CHAR_RAWDEL , CHAR_RAWDEL , CHAR_PERIOD , CHAR_RAWDEL ,
Chris Lattner03b98662009-07-07 17:09:54 +00001016//48 0 49 1 50 2 51 3
1017//52 4 53 5 54 6 55 7
1018 CHAR_NUMBER , CHAR_NUMBER , CHAR_NUMBER , CHAR_NUMBER ,
1019 CHAR_NUMBER , CHAR_NUMBER , CHAR_NUMBER , CHAR_NUMBER ,
1020//56 8 57 9 58 : 59 ;
1021//60 < 61 = 62 > 63 ?
Craig Topper2fa4e862011-08-11 04:06:15 +00001022 CHAR_NUMBER , CHAR_NUMBER , CHAR_RAWDEL , CHAR_RAWDEL ,
1023 CHAR_RAWDEL , CHAR_RAWDEL , CHAR_RAWDEL , CHAR_RAWDEL ,
Chris Lattner03b98662009-07-07 17:09:54 +00001024//64 @ 65 A 66 B 67 C
1025//68 D 69 E 70 F 71 G
1026 0 , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1027 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1028//72 H 73 I 74 J 75 K
1029//76 L 77 M 78 N 79 O
1030 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1031 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1032//80 P 81 Q 82 R 83 S
1033//84 T 85 U 86 V 87 W
1034 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1035 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1036//88 X 89 Y 90 Z 91 [
1037//92 \ 93 ] 94 ^ 95 _
Craig Topper2fa4e862011-08-11 04:06:15 +00001038 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_RAWDEL ,
1039 0 , CHAR_RAWDEL , CHAR_RAWDEL , CHAR_UNDER ,
Chris Lattner03b98662009-07-07 17:09:54 +00001040//96 ` 97 a 98 b 99 c
1041//100 d 101 e 102 f 103 g
1042 0 , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1043 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1044//104 h 105 i 106 j 107 k
1045//108 l 109 m 110 n 111 o
1046 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1047 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1048//112 p 113 q 114 r 115 s
1049//116 t 117 u 118 v 119 w
1050 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1051 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_LETTER ,
1052//120 x 121 y 122 z 123 {
Craig Topper2fa4e862011-08-11 04:06:15 +00001053//124 | 125 } 126 ~ 127 DEL
1054 CHAR_LETTER , CHAR_LETTER , CHAR_LETTER , CHAR_RAWDEL ,
1055 CHAR_RAWDEL , CHAR_RAWDEL , CHAR_RAWDEL , 0
Chris Lattner03b98662009-07-07 17:09:54 +00001056};
1057
Chris Lattnera2bf1052009-12-17 05:29:40 +00001058static void InitCharacterInfo() {
Reid Spencer5f016e22007-07-11 17:01:13 +00001059 static bool isInited = false;
1060 if (isInited) return;
Chris Lattner03b98662009-07-07 17:09:54 +00001061 // check the statically-initialized CharInfo table
1062 assert(CHAR_HORZ_WS == CharInfo[(int)' ']);
1063 assert(CHAR_HORZ_WS == CharInfo[(int)'\t']);
1064 assert(CHAR_HORZ_WS == CharInfo[(int)'\f']);
1065 assert(CHAR_HORZ_WS == CharInfo[(int)'\v']);
1066 assert(CHAR_VERT_WS == CharInfo[(int)'\n']);
1067 assert(CHAR_VERT_WS == CharInfo[(int)'\r']);
1068 assert(CHAR_UNDER == CharInfo[(int)'_']);
1069 assert(CHAR_PERIOD == CharInfo[(int)'.']);
1070 for (unsigned i = 'a'; i <= 'z'; ++i) {
1071 assert(CHAR_LETTER == CharInfo[i]);
1072 assert(CHAR_LETTER == CharInfo[i+'A'-'a']);
1073 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001074 for (unsigned i = '0'; i <= '9'; ++i)
Chris Lattner03b98662009-07-07 17:09:54 +00001075 assert(CHAR_NUMBER == CharInfo[i]);
Steve Naroff7b682652009-12-08 16:38:12 +00001076
Chris Lattner03b98662009-07-07 17:09:54 +00001077 isInited = true;
Reid Spencer5f016e22007-07-11 17:01:13 +00001078}
1079
Chris Lattner03b98662009-07-07 17:09:54 +00001080
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001081/// isIdentifierHead - Return true if this is the first character of an
1082/// identifier, which is [a-zA-Z_].
1083static inline bool isIdentifierHead(unsigned char c) {
1084 return (CharInfo[c] & (CHAR_LETTER|CHAR_UNDER)) ? true : false;
1085}
1086
Reid Spencer5f016e22007-07-11 17:01:13 +00001087/// isIdentifierBody - Return true if this is the body character of an
1088/// identifier, which is [a-zA-Z0-9_].
1089static inline bool isIdentifierBody(unsigned char c) {
Hartmut Kaiser95c062b2007-10-18 12:47:01 +00001090 return (CharInfo[c] & (CHAR_LETTER|CHAR_NUMBER|CHAR_UNDER)) ? true : false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001091}
1092
1093/// isHorizontalWhitespace - Return true if this character is horizontal
James Dennetta05369f2012-06-15 21:36:54 +00001094/// whitespace: ' ', '\\t', '\\f', '\\v'. Note that this returns false for
1095/// '\\0'.
Reid Spencer5f016e22007-07-11 17:01:13 +00001096static inline bool isHorizontalWhitespace(unsigned char c) {
Hartmut Kaiser95c062b2007-10-18 12:47:01 +00001097 return (CharInfo[c] & CHAR_HORZ_WS) ? true : false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001098}
1099
Anna Zaksaca25bc2011-07-27 21:43:43 +00001100/// isVerticalWhitespace - Return true if this character is vertical
James Dennetta05369f2012-06-15 21:36:54 +00001101/// whitespace: '\\n', '\\r'. Note that this returns false for '\\0'.
Anna Zaksaca25bc2011-07-27 21:43:43 +00001102static inline bool isVerticalWhitespace(unsigned char c) {
1103 return (CharInfo[c] & CHAR_VERT_WS) ? true : false;
1104}
1105
Reid Spencer5f016e22007-07-11 17:01:13 +00001106/// isWhitespace - Return true if this character is horizontal or vertical
James Dennetta05369f2012-06-15 21:36:54 +00001107/// whitespace: ' ', '\\t', '\\f', '\\v', '\\n', '\\r'. Note that this returns
1108/// false for '\\0'.
Reid Spencer5f016e22007-07-11 17:01:13 +00001109static inline bool isWhitespace(unsigned char c) {
Hartmut Kaiser95c062b2007-10-18 12:47:01 +00001110 return (CharInfo[c] & (CHAR_HORZ_WS|CHAR_VERT_WS)) ? true : false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001111}
1112
1113/// isNumberBody - Return true if this is the body character of an
1114/// preprocessing number, which is [a-zA-Z0-9_.].
1115static inline bool isNumberBody(unsigned char c) {
Mike Stump1eb44332009-09-09 15:08:12 +00001116 return (CharInfo[c] & (CHAR_LETTER|CHAR_NUMBER|CHAR_UNDER|CHAR_PERIOD)) ?
Hartmut Kaiser95c062b2007-10-18 12:47:01 +00001117 true : false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001118}
1119
Craig Topper2fa4e862011-08-11 04:06:15 +00001120/// isRawStringDelimBody - Return true if this is the body character of a
1121/// raw string delimiter.
1122static inline bool isRawStringDelimBody(unsigned char c) {
1123 return (CharInfo[c] &
1124 (CHAR_LETTER|CHAR_NUMBER|CHAR_UNDER|CHAR_PERIOD|CHAR_RAWDEL)) ?
1125 true : false;
1126}
1127
Jordan Rosed880b3a2012-06-07 01:10:31 +00001128// Allow external clients to make use of CharInfo.
1129bool Lexer::isIdentifierBodyChar(char c, const LangOptions &LangOpts) {
1130 return isIdentifierBody(c) || (c == '$' && LangOpts.DollarIdents);
1131}
1132
Reid Spencer5f016e22007-07-11 17:01:13 +00001133
1134//===----------------------------------------------------------------------===//
1135// Diagnostics forwarding code.
1136//===----------------------------------------------------------------------===//
1137
Chris Lattner409a0362007-07-22 18:38:25 +00001138/// GetMappedTokenLoc - If lexing out of a 'mapped buffer', where we pretend the
Chandler Carruth433db062011-07-14 08:20:40 +00001139/// lexer buffer was all expanded at a single point, perform the mapping.
Chris Lattner409a0362007-07-22 18:38:25 +00001140/// This is currently only used for _Pragma implementation, so it is the slow
1141/// path of the hot getSourceLocation method. Do not allow it to be inlined.
Chandler Carruth14bd9652010-10-23 08:44:57 +00001142static LLVM_ATTRIBUTE_NOINLINE SourceLocation GetMappedTokenLoc(
1143 Preprocessor &PP, SourceLocation FileLoc, unsigned CharNo, unsigned TokLen);
Chris Lattner409a0362007-07-22 18:38:25 +00001144static SourceLocation GetMappedTokenLoc(Preprocessor &PP,
1145 SourceLocation FileLoc,
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001146 unsigned CharNo, unsigned TokLen) {
Chandler Carruth433db062011-07-14 08:20:40 +00001147 assert(FileLoc.isMacroID() && "Must be a macro expansion");
Mike Stump1eb44332009-09-09 15:08:12 +00001148
Chris Lattner409a0362007-07-22 18:38:25 +00001149 // Otherwise, we're lexing "mapped tokens". This is used for things like
Chandler Carruth433db062011-07-14 08:20:40 +00001150 // _Pragma handling. Combine the expansion location of FileLoc with the
Chris Lattnerdf7c17a2009-01-16 07:00:02 +00001151 // spelling location.
Chris Lattnere7fb4842009-02-15 20:52:18 +00001152 SourceManager &SM = PP.getSourceManager();
Mike Stump1eb44332009-09-09 15:08:12 +00001153
Chandler Carruth433db062011-07-14 08:20:40 +00001154 // Create a new SLoc which is expanded from Expansion(FileLoc) but whose
Chris Lattnerdf7c17a2009-01-16 07:00:02 +00001155 // characters come from spelling(FileLoc)+Offset.
Chris Lattnere7fb4842009-02-15 20:52:18 +00001156 SourceLocation SpellingLoc = SM.getSpellingLoc(FileLoc);
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001157 SpellingLoc = SpellingLoc.getLocWithOffset(CharNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001158
Chris Lattnere7fb4842009-02-15 20:52:18 +00001159 // Figure out the expansion loc range, which is the range covered by the
1160 // original _Pragma(...) sequence.
1161 std::pair<SourceLocation,SourceLocation> II =
Chandler Carruth999f7392011-07-25 20:52:21 +00001162 SM.getImmediateExpansionRange(FileLoc);
Mike Stump1eb44332009-09-09 15:08:12 +00001163
Chandler Carruthbf340e42011-07-26 03:03:05 +00001164 return SM.createExpansionLoc(SpellingLoc, II.first, II.second, TokLen);
Chris Lattner409a0362007-07-22 18:38:25 +00001165}
1166
Reid Spencer5f016e22007-07-11 17:01:13 +00001167/// getSourceLocation - Return a source location identifier for the specified
1168/// offset in the current file.
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001169SourceLocation Lexer::getSourceLocation(const char *Loc,
1170 unsigned TokLen) const {
Chris Lattner448cec42007-07-22 18:44:36 +00001171 assert(Loc >= BufferStart && Loc <= BufferEnd &&
Reid Spencer5f016e22007-07-11 17:01:13 +00001172 "Location out of range for this buffer!");
Chris Lattner9dc1f532007-07-20 16:37:10 +00001173
1174 // In the normal case, we're just lexing from a simple file buffer, return
1175 // the file id from FileLoc with the offset specified.
Chris Lattner448cec42007-07-22 18:44:36 +00001176 unsigned CharNo = Loc-BufferStart;
Chris Lattner9dc1f532007-07-20 16:37:10 +00001177 if (FileLoc.isFileID())
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001178 return FileLoc.getLocWithOffset(CharNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001179
Chris Lattner2b2453a2009-01-17 06:22:33 +00001180 // Otherwise, this is the _Pragma lexer case, which pretends that all of the
1181 // tokens are lexed from where the _Pragma was defined.
Chris Lattner168ae2d2007-10-17 20:41:00 +00001182 assert(PP && "This doesn't work on raw lexers");
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001183 return GetMappedTokenLoc(*PP, FileLoc, CharNo, TokLen);
Reid Spencer5f016e22007-07-11 17:01:13 +00001184}
1185
Reid Spencer5f016e22007-07-11 17:01:13 +00001186/// Diag - Forwarding function for diagnostics. This translate a source
1187/// position in the current buffer into a SourceLocation object for rendering.
Chris Lattner3cbfe2c2008-11-22 00:59:29 +00001188DiagnosticBuilder Lexer::Diag(const char *Loc, unsigned DiagID) const {
Chris Lattner3692b092008-11-18 07:59:24 +00001189 return PP->Diag(getSourceLocation(Loc), DiagID);
Reid Spencer5f016e22007-07-11 17:01:13 +00001190}
Reid Spencer5f016e22007-07-11 17:01:13 +00001191
1192//===----------------------------------------------------------------------===//
1193// Trigraph and Escaped Newline Handling Code.
1194//===----------------------------------------------------------------------===//
1195
1196/// GetTrigraphCharForLetter - Given a character that occurs after a ?? pair,
1197/// return the decoded trigraph letter it corresponds to, or '\0' if nothing.
1198static char GetTrigraphCharForLetter(char Letter) {
1199 switch (Letter) {
1200 default: return 0;
1201 case '=': return '#';
1202 case ')': return ']';
1203 case '(': return '[';
1204 case '!': return '|';
1205 case '\'': return '^';
1206 case '>': return '}';
1207 case '/': return '\\';
1208 case '<': return '{';
1209 case '-': return '~';
1210 }
1211}
1212
1213/// DecodeTrigraphChar - If the specified character is a legal trigraph when
1214/// prefixed with ??, emit a trigraph warning. If trigraphs are enabled,
1215/// return the result character. Finally, emit a warning about trigraph use
1216/// whether trigraphs are enabled or not.
1217static char DecodeTrigraphChar(const char *CP, Lexer *L) {
1218 char Res = GetTrigraphCharForLetter(*CP);
Chris Lattner3692b092008-11-18 07:59:24 +00001219 if (!Res || !L) return Res;
Mike Stump1eb44332009-09-09 15:08:12 +00001220
David Blaikie4e4d0842012-03-11 07:00:24 +00001221 if (!L->getLangOpts().Trigraphs) {
Chris Lattner74d15df2008-11-22 02:02:22 +00001222 if (!L->isLexingRawMode())
1223 L->Diag(CP-2, diag::trigraph_ignored);
Chris Lattner3692b092008-11-18 07:59:24 +00001224 return 0;
Reid Spencer5f016e22007-07-11 17:01:13 +00001225 }
Mike Stump1eb44332009-09-09 15:08:12 +00001226
Chris Lattner74d15df2008-11-22 02:02:22 +00001227 if (!L->isLexingRawMode())
Chris Lattner5f9e2722011-07-23 10:55:15 +00001228 L->Diag(CP-2, diag::trigraph_converted) << StringRef(&Res, 1);
Reid Spencer5f016e22007-07-11 17:01:13 +00001229 return Res;
1230}
1231
Chris Lattner24f0e482009-04-18 22:05:41 +00001232/// getEscapedNewLineSize - Return the size of the specified escaped newline,
1233/// or 0 if it is not an escaped newline. P[-1] is known to be a "\" or a
Mike Stump1eb44332009-09-09 15:08:12 +00001234/// trigraph equivalent on entry to this function.
Chris Lattner24f0e482009-04-18 22:05:41 +00001235unsigned Lexer::getEscapedNewLineSize(const char *Ptr) {
1236 unsigned Size = 0;
1237 while (isWhitespace(Ptr[Size])) {
1238 ++Size;
Mike Stump1eb44332009-09-09 15:08:12 +00001239
Chris Lattner24f0e482009-04-18 22:05:41 +00001240 if (Ptr[Size-1] != '\n' && Ptr[Size-1] != '\r')
1241 continue;
1242
1243 // If this is a \r\n or \n\r, skip the other half.
1244 if ((Ptr[Size] == '\r' || Ptr[Size] == '\n') &&
1245 Ptr[Size-1] != Ptr[Size])
1246 ++Size;
Mike Stump1eb44332009-09-09 15:08:12 +00001247
Chris Lattner24f0e482009-04-18 22:05:41 +00001248 return Size;
Mike Stump1eb44332009-09-09 15:08:12 +00001249 }
1250
Chris Lattner24f0e482009-04-18 22:05:41 +00001251 // Not an escaped newline, must be a \t or something else.
1252 return 0;
1253}
1254
Chris Lattner03374952009-04-18 22:27:02 +00001255/// SkipEscapedNewLines - If P points to an escaped newline (or a series of
1256/// them), skip over them and return the first non-escaped-newline found,
1257/// otherwise return P.
1258const char *Lexer::SkipEscapedNewLines(const char *P) {
1259 while (1) {
1260 const char *AfterEscape;
1261 if (*P == '\\') {
1262 AfterEscape = P+1;
1263 } else if (*P == '?') {
1264 // If not a trigraph for escape, bail out.
1265 if (P[1] != '?' || P[2] != '/')
1266 return P;
1267 AfterEscape = P+3;
1268 } else {
1269 return P;
1270 }
Mike Stump1eb44332009-09-09 15:08:12 +00001271
Chris Lattner03374952009-04-18 22:27:02 +00001272 unsigned NewLineSize = Lexer::getEscapedNewLineSize(AfterEscape);
1273 if (NewLineSize == 0) return P;
1274 P = AfterEscape+NewLineSize;
1275 }
1276}
1277
Anna Zaksaca25bc2011-07-27 21:43:43 +00001278/// \brief Checks that the given token is the first token that occurs after the
1279/// given location (this excludes comments and whitespace). Returns the location
1280/// immediately after the specified token. If the token is not found or the
1281/// location is inside a macro, the returned source location will be invalid.
1282SourceLocation Lexer::findLocationAfterToken(SourceLocation Loc,
1283 tok::TokenKind TKind,
1284 const SourceManager &SM,
1285 const LangOptions &LangOpts,
1286 bool SkipTrailingWhitespaceAndNewLine) {
1287 if (Loc.isMacroID()) {
Argyrios Kyrtzidis69bda4c2012-01-19 15:59:08 +00001288 if (!Lexer::isAtEndOfMacroExpansion(Loc, SM, LangOpts, &Loc))
Anna Zaksaca25bc2011-07-27 21:43:43 +00001289 return SourceLocation();
Anna Zaksaca25bc2011-07-27 21:43:43 +00001290 }
1291 Loc = Lexer::getLocForEndOfToken(Loc, 0, SM, LangOpts);
1292
1293 // Break down the source location.
1294 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc);
1295
1296 // Try to load the file buffer.
1297 bool InvalidTemp = false;
1298 llvm::StringRef File = SM.getBufferData(LocInfo.first, &InvalidTemp);
1299 if (InvalidTemp)
1300 return SourceLocation();
1301
1302 const char *TokenBegin = File.data() + LocInfo.second;
1303
1304 // Lex from the start of the given location.
1305 Lexer lexer(SM.getLocForStartOfFile(LocInfo.first), LangOpts, File.begin(),
1306 TokenBegin, File.end());
1307 // Find the token.
1308 Token Tok;
1309 lexer.LexFromRawLexer(Tok);
1310 if (Tok.isNot(TKind))
1311 return SourceLocation();
1312 SourceLocation TokenLoc = Tok.getLocation();
1313
1314 // Calculate how much whitespace needs to be skipped if any.
1315 unsigned NumWhitespaceChars = 0;
1316 if (SkipTrailingWhitespaceAndNewLine) {
1317 const char *TokenEnd = SM.getCharacterData(TokenLoc) +
1318 Tok.getLength();
1319 unsigned char C = *TokenEnd;
1320 while (isHorizontalWhitespace(C)) {
1321 C = *(++TokenEnd);
1322 NumWhitespaceChars++;
1323 }
1324 if (isVerticalWhitespace(C))
1325 NumWhitespaceChars++;
1326 }
1327
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001328 return TokenLoc.getLocWithOffset(Tok.getLength() + NumWhitespaceChars);
Anna Zaksaca25bc2011-07-27 21:43:43 +00001329}
Chris Lattner24f0e482009-04-18 22:05:41 +00001330
Reid Spencer5f016e22007-07-11 17:01:13 +00001331/// getCharAndSizeSlow - Peek a single 'character' from the specified buffer,
1332/// get its size, and return it. This is tricky in several cases:
1333/// 1. If currently at the start of a trigraph, we warn about the trigraph,
1334/// then either return the trigraph (skipping 3 chars) or the '?',
1335/// depending on whether trigraphs are enabled or not.
1336/// 2. If this is an escaped newline (potentially with whitespace between
1337/// the backslash and newline), implicitly skip the newline and return
1338/// the char after it.
1339/// 3. If this is a UCN, return it. FIXME: C++ UCN's?
1340///
1341/// This handles the slow/uncommon case of the getCharAndSize method. Here we
1342/// know that we can accumulate into Size, and that we have already incremented
1343/// Ptr by Size bytes.
1344///
1345/// NOTE: When this method is updated, getCharAndSizeSlowNoWarn (below) should
1346/// be updated to match.
1347///
1348char Lexer::getCharAndSizeSlow(const char *Ptr, unsigned &Size,
Chris Lattnerd2177732007-07-20 16:59:19 +00001349 Token *Tok) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001350 // If we have a slash, look for an escaped newline.
1351 if (Ptr[0] == '\\') {
1352 ++Size;
1353 ++Ptr;
1354Slash:
1355 // Common case, backslash-char where the char is not whitespace.
1356 if (!isWhitespace(Ptr[0])) return '\\';
Mike Stump1eb44332009-09-09 15:08:12 +00001357
Chris Lattner5636a3b2009-06-23 05:15:06 +00001358 // See if we have optional whitespace characters between the slash and
1359 // newline.
Chris Lattner24f0e482009-04-18 22:05:41 +00001360 if (unsigned EscapedNewLineSize = getEscapedNewLineSize(Ptr)) {
1361 // Remember that this token needs to be cleaned.
1362 if (Tok) Tok->setFlag(Token::NeedsCleaning);
Reid Spencer5f016e22007-07-11 17:01:13 +00001363
Chris Lattner24f0e482009-04-18 22:05:41 +00001364 // Warn if there was whitespace between the backslash and newline.
Chris Lattner5636a3b2009-06-23 05:15:06 +00001365 if (Ptr[0] != '\n' && Ptr[0] != '\r' && Tok && !isLexingRawMode())
Chris Lattner24f0e482009-04-18 22:05:41 +00001366 Diag(Ptr, diag::backslash_newline_space);
Mike Stump1eb44332009-09-09 15:08:12 +00001367
Chris Lattner24f0e482009-04-18 22:05:41 +00001368 // Found backslash<whitespace><newline>. Parse the char after it.
1369 Size += EscapedNewLineSize;
1370 Ptr += EscapedNewLineSize;
Argyrios Kyrtzidisf132dca2011-12-21 20:19:55 +00001371
Argyrios Kyrtzidis04a94bc2011-12-22 04:38:07 +00001372 // If the char that we finally got was a \n, then we must have had
1373 // something like \<newline><newline>. We don't want to consume the
1374 // second newline.
1375 if (*Ptr == '\n' || *Ptr == '\r' || *Ptr == '\0')
1376 return ' ';
Argyrios Kyrtzidisf132dca2011-12-21 20:19:55 +00001377
Chris Lattner24f0e482009-04-18 22:05:41 +00001378 // Use slow version to accumulate a correct size field.
1379 return getCharAndSizeSlow(Ptr, Size, Tok);
1380 }
Mike Stump1eb44332009-09-09 15:08:12 +00001381
Reid Spencer5f016e22007-07-11 17:01:13 +00001382 // Otherwise, this is not an escaped newline, just return the slash.
1383 return '\\';
1384 }
Mike Stump1eb44332009-09-09 15:08:12 +00001385
Reid Spencer5f016e22007-07-11 17:01:13 +00001386 // If this is a trigraph, process it.
1387 if (Ptr[0] == '?' && Ptr[1] == '?') {
1388 // If this is actually a legal trigraph (not something like "??x"), emit
1389 // a trigraph warning. If so, and if trigraphs are enabled, return it.
1390 if (char C = DecodeTrigraphChar(Ptr+2, Tok ? this : 0)) {
1391 // Remember that this token needs to be cleaned.
Chris Lattnerd2177732007-07-20 16:59:19 +00001392 if (Tok) Tok->setFlag(Token::NeedsCleaning);
Reid Spencer5f016e22007-07-11 17:01:13 +00001393
1394 Ptr += 3;
1395 Size += 3;
1396 if (C == '\\') goto Slash;
1397 return C;
1398 }
1399 }
Mike Stump1eb44332009-09-09 15:08:12 +00001400
Reid Spencer5f016e22007-07-11 17:01:13 +00001401 // If this is neither, return a single character.
1402 ++Size;
1403 return *Ptr;
1404}
1405
1406
1407/// getCharAndSizeSlowNoWarn - Handle the slow/uncommon case of the
1408/// getCharAndSizeNoWarn method. Here we know that we can accumulate into Size,
1409/// and that we have already incremented Ptr by Size bytes.
1410///
1411/// NOTE: When this method is updated, getCharAndSizeSlow (above) should
1412/// be updated to match.
1413char Lexer::getCharAndSizeSlowNoWarn(const char *Ptr, unsigned &Size,
David Blaikie4e4d0842012-03-11 07:00:24 +00001414 const LangOptions &LangOpts) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001415 // If we have a slash, look for an escaped newline.
1416 if (Ptr[0] == '\\') {
1417 ++Size;
1418 ++Ptr;
1419Slash:
1420 // Common case, backslash-char where the char is not whitespace.
1421 if (!isWhitespace(Ptr[0])) return '\\';
Mike Stump1eb44332009-09-09 15:08:12 +00001422
Reid Spencer5f016e22007-07-11 17:01:13 +00001423 // See if we have optional whitespace characters followed by a newline.
Chris Lattner24f0e482009-04-18 22:05:41 +00001424 if (unsigned EscapedNewLineSize = getEscapedNewLineSize(Ptr)) {
1425 // Found backslash<whitespace><newline>. Parse the char after it.
1426 Size += EscapedNewLineSize;
1427 Ptr += EscapedNewLineSize;
Mike Stump1eb44332009-09-09 15:08:12 +00001428
Argyrios Kyrtzidis04a94bc2011-12-22 04:38:07 +00001429 // If the char that we finally got was a \n, then we must have had
1430 // something like \<newline><newline>. We don't want to consume the
1431 // second newline.
1432 if (*Ptr == '\n' || *Ptr == '\r' || *Ptr == '\0')
1433 return ' ';
Argyrios Kyrtzidisf132dca2011-12-21 20:19:55 +00001434
Chris Lattner24f0e482009-04-18 22:05:41 +00001435 // Use slow version to accumulate a correct size field.
David Blaikie4e4d0842012-03-11 07:00:24 +00001436 return getCharAndSizeSlowNoWarn(Ptr, Size, LangOpts);
Chris Lattner24f0e482009-04-18 22:05:41 +00001437 }
Mike Stump1eb44332009-09-09 15:08:12 +00001438
Reid Spencer5f016e22007-07-11 17:01:13 +00001439 // Otherwise, this is not an escaped newline, just return the slash.
1440 return '\\';
1441 }
Mike Stump1eb44332009-09-09 15:08:12 +00001442
Reid Spencer5f016e22007-07-11 17:01:13 +00001443 // If this is a trigraph, process it.
David Blaikie4e4d0842012-03-11 07:00:24 +00001444 if (LangOpts.Trigraphs && Ptr[0] == '?' && Ptr[1] == '?') {
Reid Spencer5f016e22007-07-11 17:01:13 +00001445 // If this is actually a legal trigraph (not something like "??x"), return
1446 // it.
1447 if (char C = GetTrigraphCharForLetter(Ptr[2])) {
1448 Ptr += 3;
1449 Size += 3;
1450 if (C == '\\') goto Slash;
1451 return C;
1452 }
1453 }
Mike Stump1eb44332009-09-09 15:08:12 +00001454
Reid Spencer5f016e22007-07-11 17:01:13 +00001455 // If this is neither, return a single character.
1456 ++Size;
1457 return *Ptr;
1458}
1459
1460//===----------------------------------------------------------------------===//
1461// Helper methods for lexing.
1462//===----------------------------------------------------------------------===//
1463
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001464/// \brief Routine that indiscriminately skips bytes in the source file.
1465void Lexer::SkipBytes(unsigned Bytes, bool StartOfLine) {
1466 BufferPtr += Bytes;
1467 if (BufferPtr > BufferEnd)
1468 BufferPtr = BufferEnd;
1469 IsAtStartOfLine = StartOfLine;
1470}
1471
Chris Lattnerd2177732007-07-20 16:59:19 +00001472void Lexer::LexIdentifier(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001473 // Match [_A-Za-z0-9]*, we have already matched [_A-Za-z$]
1474 unsigned Size;
1475 unsigned char C = *CurPtr++;
Chris Lattnercd991db2010-01-11 02:38:50 +00001476 while (isIdentifierBody(C))
Reid Spencer5f016e22007-07-11 17:01:13 +00001477 C = *CurPtr++;
Chris Lattnercd991db2010-01-11 02:38:50 +00001478
Reid Spencer5f016e22007-07-11 17:01:13 +00001479 --CurPtr; // Back up over the skipped character.
1480
1481 // Fast path, no $,\,? in identifier found. '\' might be an escaped newline
1482 // or UCN, and ? might be a trigraph for '\', an escaped newline or UCN.
1483 // FIXME: UCNs.
Chris Lattnercd991db2010-01-11 02:38:50 +00001484 //
1485 // TODO: Could merge these checks into a CharInfo flag to make the comparison
1486 // cheaper
David Blaikie4e4d0842012-03-11 07:00:24 +00001487 if (C != '\\' && C != '?' && (C != '$' || !LangOpts.DollarIdents)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001488FinishIdentifier:
1489 const char *IdStart = BufferPtr;
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00001490 FormTokenWithChars(Result, CurPtr, tok::raw_identifier);
1491 Result.setRawIdentifierData(IdStart);
Mike Stump1eb44332009-09-09 15:08:12 +00001492
Reid Spencer5f016e22007-07-11 17:01:13 +00001493 // If we are in raw mode, return this identifier raw. There is no need to
1494 // look up identifier information or attempt to macro expand it.
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00001495 if (LexingRawMode)
1496 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001497
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00001498 // Fill in Result.IdentifierInfo and update the token kind,
1499 // looking up the identifier in the identifier table.
1500 IdentifierInfo *II = PP->LookUpIdentifierInfo(Result);
Mike Stump1eb44332009-09-09 15:08:12 +00001501
Reid Spencer5f016e22007-07-11 17:01:13 +00001502 // Finally, now that we know we have an identifier, pass this off to the
1503 // preprocessor, which may macro expand it or something.
Chris Lattnerd1186fa2009-01-21 07:45:14 +00001504 if (II->isHandleIdentifierCase())
Chris Lattner6a170eb2009-01-21 07:43:11 +00001505 PP->HandleIdentifier(Result);
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001506
Chris Lattner6a170eb2009-01-21 07:43:11 +00001507 return;
Reid Spencer5f016e22007-07-11 17:01:13 +00001508 }
Mike Stump1eb44332009-09-09 15:08:12 +00001509
Reid Spencer5f016e22007-07-11 17:01:13 +00001510 // Otherwise, $,\,? in identifier found. Enter slower path.
Mike Stump1eb44332009-09-09 15:08:12 +00001511
Reid Spencer5f016e22007-07-11 17:01:13 +00001512 C = getCharAndSize(CurPtr, Size);
1513 while (1) {
1514 if (C == '$') {
1515 // If we hit a $ and they are not supported in identifiers, we are done.
David Blaikie4e4d0842012-03-11 07:00:24 +00001516 if (!LangOpts.DollarIdents) goto FinishIdentifier;
Mike Stump1eb44332009-09-09 15:08:12 +00001517
Reid Spencer5f016e22007-07-11 17:01:13 +00001518 // Otherwise, emit a diagnostic and continue.
Chris Lattner74d15df2008-11-22 02:02:22 +00001519 if (!isLexingRawMode())
1520 Diag(CurPtr, diag::ext_dollar_in_identifier);
Reid Spencer5f016e22007-07-11 17:01:13 +00001521 CurPtr = ConsumeChar(CurPtr, Size, Result);
1522 C = getCharAndSize(CurPtr, Size);
1523 continue;
1524 } else if (!isIdentifierBody(C)) { // FIXME: UCNs.
1525 // Found end of identifier.
1526 goto FinishIdentifier;
1527 }
1528
1529 // Otherwise, this character is good, consume it.
1530 CurPtr = ConsumeChar(CurPtr, Size, Result);
1531
1532 C = getCharAndSize(CurPtr, Size);
1533 while (isIdentifierBody(C)) { // FIXME: UCNs.
1534 CurPtr = ConsumeChar(CurPtr, Size, Result);
1535 C = getCharAndSize(CurPtr, Size);
1536 }
1537 }
1538}
1539
Douglas Gregora75ec432010-08-30 14:50:47 +00001540/// isHexaLiteral - Return true if Start points to a hex constant.
Chris Lattner4a551002010-08-30 17:11:14 +00001541/// in microsoft mode (where this is supposed to be several different tokens).
David Blaikie4e4d0842012-03-11 07:00:24 +00001542static bool isHexaLiteral(const char *Start, const LangOptions &LangOpts) {
Chris Lattner6ab55eb2010-08-31 16:42:00 +00001543 unsigned Size;
David Blaikie4e4d0842012-03-11 07:00:24 +00001544 char C1 = Lexer::getCharAndSizeNoWarn(Start, Size, LangOpts);
Chris Lattner6ab55eb2010-08-31 16:42:00 +00001545 if (C1 != '0')
1546 return false;
David Blaikie4e4d0842012-03-11 07:00:24 +00001547 char C2 = Lexer::getCharAndSizeNoWarn(Start + Size, Size, LangOpts);
Chris Lattner6ab55eb2010-08-31 16:42:00 +00001548 return (C2 == 'x' || C2 == 'X');
Douglas Gregora75ec432010-08-30 14:50:47 +00001549}
Reid Spencer5f016e22007-07-11 17:01:13 +00001550
Nate Begeman5253c7f2008-04-14 02:26:39 +00001551/// LexNumericConstant - Lex the remainder of a integer or floating point
Reid Spencer5f016e22007-07-11 17:01:13 +00001552/// constant. From[-1] is the first character lexed. Return the end of the
1553/// constant.
Chris Lattnerd2177732007-07-20 16:59:19 +00001554void Lexer::LexNumericConstant(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001555 unsigned Size;
1556 char C = getCharAndSize(CurPtr, Size);
1557 char PrevCh = 0;
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001558 while (isNumberBody(C)) { // FIXME: UCNs.
Reid Spencer5f016e22007-07-11 17:01:13 +00001559 CurPtr = ConsumeChar(CurPtr, Size, Result);
1560 PrevCh = C;
1561 C = getCharAndSize(CurPtr, Size);
1562 }
Mike Stump1eb44332009-09-09 15:08:12 +00001563
Reid Spencer5f016e22007-07-11 17:01:13 +00001564 // If we fell out, check for a sign, due to 1e+12. If we have one, continue.
Chris Lattnerb2f4a202010-08-30 17:09:08 +00001565 if ((C == '-' || C == '+') && (PrevCh == 'E' || PrevCh == 'e')) {
1566 // If we are in Microsoft mode, don't continue if the constant is hex.
1567 // For example, MSVC will accept the following as 3 tokens: 0x1234567e+1
David Blaikie4e4d0842012-03-11 07:00:24 +00001568 if (!LangOpts.MicrosoftExt || !isHexaLiteral(BufferPtr, LangOpts))
Chris Lattnerb2f4a202010-08-30 17:09:08 +00001569 return LexNumericConstant(Result, ConsumeChar(CurPtr, Size, Result));
1570 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001571
1572 // If we have a hex FP constant, continue.
Richard Smithd2e95d12012-06-15 05:07:49 +00001573 if ((C == '-' || C == '+') && (PrevCh == 'P' || PrevCh == 'p')) {
1574 // Outside C99, we accept hexadecimal floating point numbers as a
1575 // not-quite-conforming extension. Only do so if this looks like it's
1576 // actually meant to be a hexfloat, and not if it has a ud-suffix.
1577 bool IsHexFloat = true;
1578 if (!LangOpts.C99) {
1579 if (!isHexaLiteral(BufferPtr, LangOpts))
1580 IsHexFloat = false;
1581 else if (std::find(BufferPtr, CurPtr, '_') != CurPtr)
1582 IsHexFloat = false;
1583 }
1584 if (IsHexFloat)
1585 return LexNumericConstant(Result, ConsumeChar(CurPtr, Size, Result));
1586 }
Mike Stump1eb44332009-09-09 15:08:12 +00001587
Reid Spencer5f016e22007-07-11 17:01:13 +00001588 // Update the location of token as well as BufferPtr.
Chris Lattner47246be2009-01-26 19:29:26 +00001589 const char *TokStart = BufferPtr;
Chris Lattner9e6293d2008-10-12 04:51:35 +00001590 FormTokenWithChars(Result, CurPtr, tok::numeric_constant);
Chris Lattner47246be2009-01-26 19:29:26 +00001591 Result.setLiteralData(TokStart);
Reid Spencer5f016e22007-07-11 17:01:13 +00001592}
1593
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001594/// LexUDSuffix - Lex the ud-suffix production for user-defined literal suffixes
Richard Smithe816c712012-03-07 03:13:00 +00001595/// in C++11, or warn on a ud-suffix in C++98.
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001596const char *Lexer::LexUDSuffix(Token &Result, const char *CurPtr) {
David Blaikie4e4d0842012-03-11 07:00:24 +00001597 assert(getLangOpts().CPlusPlus);
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001598
1599 // Maximally munch an identifier. FIXME: UCNs.
1600 unsigned Size;
1601 char C = getCharAndSize(CurPtr, Size);
1602 if (isIdentifierHead(C)) {
David Blaikie4e4d0842012-03-11 07:00:24 +00001603 if (!getLangOpts().CPlusPlus0x) {
Richard Smithe816c712012-03-07 03:13:00 +00001604 if (!isLexingRawMode())
Richard Smith2fb4ae32012-03-08 02:39:21 +00001605 Diag(CurPtr,
1606 C == '_' ? diag::warn_cxx11_compat_user_defined_literal
1607 : diag::warn_cxx11_compat_reserved_user_defined_literal)
1608 << FixItHint::CreateInsertion(getSourceLocation(CurPtr), " ");
1609 return CurPtr;
1610 }
1611
1612 // C++11 [lex.ext]p10, [usrlit.suffix]p1: A program containing a ud-suffix
1613 // that does not start with an underscore is ill-formed. As a conforming
1614 // extension, we treat all such suffixes as if they had whitespace before
1615 // them.
1616 if (C != '_') {
1617 if (!isLexingRawMode())
Francois Pichetb0afd5d2012-04-07 23:09:23 +00001618 Diag(CurPtr, getLangOpts().MicrosoftMode ?
1619 diag::ext_ms_reserved_user_defined_literal :
1620 diag::ext_reserved_user_defined_literal)
Richard Smithe816c712012-03-07 03:13:00 +00001621 << FixItHint::CreateInsertion(getSourceLocation(CurPtr), " ");
1622 return CurPtr;
1623 }
1624
Richard Smith99831e42012-03-06 03:21:47 +00001625 Result.setFlag(Token::HasUDSuffix);
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001626 do {
1627 CurPtr = ConsumeChar(CurPtr, Size, Result);
1628 C = getCharAndSize(CurPtr, Size);
1629 } while (isIdentifierBody(C));
1630 }
1631 return CurPtr;
1632}
1633
Reid Spencer5f016e22007-07-11 17:01:13 +00001634/// LexStringLiteral - Lex the remainder of a string literal, after having lexed
Douglas Gregor5cee1192011-07-27 05:40:30 +00001635/// either " or L" or u8" or u" or U".
1636void Lexer::LexStringLiteral(Token &Result, const char *CurPtr,
1637 tok::TokenKind Kind) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001638 const char *NulCharacter = 0; // Does this string contain the \0 character?
Mike Stump1eb44332009-09-09 15:08:12 +00001639
Richard Smith661a9962011-10-15 01:18:56 +00001640 if (!isLexingRawMode() &&
1641 (Kind == tok::utf8_string_literal ||
1642 Kind == tok::utf16_string_literal ||
1643 Kind == tok::utf32_string_literal))
1644 Diag(BufferPtr, diag::warn_cxx98_compat_unicode_literal);
1645
Reid Spencer5f016e22007-07-11 17:01:13 +00001646 char C = getAndAdvanceChar(CurPtr, Result);
1647 while (C != '"') {
Chris Lattner571339c2010-05-30 23:27:38 +00001648 // Skip escaped characters. Escaped newlines will already be processed by
1649 // getAndAdvanceChar.
1650 if (C == '\\')
Reid Spencer5f016e22007-07-11 17:01:13 +00001651 C = getAndAdvanceChar(CurPtr, Result);
Douglas Gregor33611e02010-05-30 22:59:50 +00001652
Chris Lattner571339c2010-05-30 23:27:38 +00001653 if (C == '\n' || C == '\r' || // Newline.
Douglas Gregor33611e02010-05-30 22:59:50 +00001654 (C == 0 && CurPtr-1 == BufferEnd)) { // End of file.
David Blaikie4e4d0842012-03-11 07:00:24 +00001655 if (!isLexingRawMode() && !LangOpts.AsmPreprocessor)
Argyrios Kyrtzidisff1ed982011-02-15 23:45:31 +00001656 Diag(BufferPtr, diag::warn_unterminated_string);
Chris Lattner9e6293d2008-10-12 04:51:35 +00001657 FormTokenWithChars(Result, CurPtr-1, tok::unknown);
Reid Spencer5f016e22007-07-11 17:01:13 +00001658 return;
Reid Spencer5f016e22007-07-11 17:01:13 +00001659 }
Chris Lattner571339c2010-05-30 23:27:38 +00001660
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001661 if (C == 0) {
1662 if (isCodeCompletionPoint(CurPtr-1)) {
1663 PP->CodeCompleteNaturalLanguage();
1664 FormTokenWithChars(Result, CurPtr-1, tok::unknown);
1665 return cutOffLexing();
1666 }
1667
Chris Lattner571339c2010-05-30 23:27:38 +00001668 NulCharacter = CurPtr-1;
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001669 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001670 C = getAndAdvanceChar(CurPtr, Result);
1671 }
Mike Stump1eb44332009-09-09 15:08:12 +00001672
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001673 // If we are in C++11, lex the optional ud-suffix.
David Blaikie4e4d0842012-03-11 07:00:24 +00001674 if (getLangOpts().CPlusPlus)
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001675 CurPtr = LexUDSuffix(Result, CurPtr);
1676
Reid Spencer5f016e22007-07-11 17:01:13 +00001677 // If a nul character existed in the string, warn about it.
Chris Lattner74d15df2008-11-22 02:02:22 +00001678 if (NulCharacter && !isLexingRawMode())
1679 Diag(NulCharacter, diag::null_in_string);
Reid Spencer5f016e22007-07-11 17:01:13 +00001680
Reid Spencer5f016e22007-07-11 17:01:13 +00001681 // Update the location of the token as well as the BufferPtr instance var.
Chris Lattner47246be2009-01-26 19:29:26 +00001682 const char *TokStart = BufferPtr;
Douglas Gregor5cee1192011-07-27 05:40:30 +00001683 FormTokenWithChars(Result, CurPtr, Kind);
Chris Lattner47246be2009-01-26 19:29:26 +00001684 Result.setLiteralData(TokStart);
Reid Spencer5f016e22007-07-11 17:01:13 +00001685}
1686
Craig Topper2fa4e862011-08-11 04:06:15 +00001687/// LexRawStringLiteral - Lex the remainder of a raw string literal, after
1688/// having lexed R", LR", u8R", uR", or UR".
1689void Lexer::LexRawStringLiteral(Token &Result, const char *CurPtr,
1690 tok::TokenKind Kind) {
1691 // This function doesn't use getAndAdvanceChar because C++0x [lex.pptoken]p3:
1692 // Between the initial and final double quote characters of the raw string,
1693 // any transformations performed in phases 1 and 2 (trigraphs,
1694 // universal-character-names, and line splicing) are reverted.
1695
Richard Smith661a9962011-10-15 01:18:56 +00001696 if (!isLexingRawMode())
1697 Diag(BufferPtr, diag::warn_cxx98_compat_raw_string_literal);
1698
Craig Topper2fa4e862011-08-11 04:06:15 +00001699 unsigned PrefixLen = 0;
1700
1701 while (PrefixLen != 16 && isRawStringDelimBody(CurPtr[PrefixLen]))
1702 ++PrefixLen;
1703
1704 // If the last character was not a '(', then we didn't lex a valid delimiter.
1705 if (CurPtr[PrefixLen] != '(') {
1706 if (!isLexingRawMode()) {
1707 const char *PrefixEnd = &CurPtr[PrefixLen];
1708 if (PrefixLen == 16) {
1709 Diag(PrefixEnd, diag::err_raw_delim_too_long);
1710 } else {
1711 Diag(PrefixEnd, diag::err_invalid_char_raw_delim)
1712 << StringRef(PrefixEnd, 1);
1713 }
1714 }
1715
1716 // Search for the next '"' in hopes of salvaging the lexer. Unfortunately,
1717 // it's possible the '"' was intended to be part of the raw string, but
1718 // there's not much we can do about that.
1719 while (1) {
1720 char C = *CurPtr++;
1721
1722 if (C == '"')
1723 break;
1724 if (C == 0 && CurPtr-1 == BufferEnd) {
1725 --CurPtr;
1726 break;
1727 }
1728 }
1729
1730 FormTokenWithChars(Result, CurPtr, tok::unknown);
1731 return;
1732 }
1733
1734 // Save prefix and move CurPtr past it
1735 const char *Prefix = CurPtr;
1736 CurPtr += PrefixLen + 1; // skip over prefix and '('
1737
1738 while (1) {
1739 char C = *CurPtr++;
1740
1741 if (C == ')') {
1742 // Check for prefix match and closing quote.
1743 if (strncmp(CurPtr, Prefix, PrefixLen) == 0 && CurPtr[PrefixLen] == '"') {
1744 CurPtr += PrefixLen + 1; // skip over prefix and '"'
1745 break;
1746 }
1747 } else if (C == 0 && CurPtr-1 == BufferEnd) { // End of file.
1748 if (!isLexingRawMode())
1749 Diag(BufferPtr, diag::err_unterminated_raw_string)
1750 << StringRef(Prefix, PrefixLen);
1751 FormTokenWithChars(Result, CurPtr-1, tok::unknown);
1752 return;
1753 }
1754 }
1755
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001756 // If we are in C++11, lex the optional ud-suffix.
David Blaikie4e4d0842012-03-11 07:00:24 +00001757 if (getLangOpts().CPlusPlus)
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001758 CurPtr = LexUDSuffix(Result, CurPtr);
1759
Craig Topper2fa4e862011-08-11 04:06:15 +00001760 // Update the location of token as well as BufferPtr.
1761 const char *TokStart = BufferPtr;
1762 FormTokenWithChars(Result, CurPtr, Kind);
1763 Result.setLiteralData(TokStart);
1764}
1765
Reid Spencer5f016e22007-07-11 17:01:13 +00001766/// LexAngledStringLiteral - Lex the remainder of an angled string literal,
1767/// after having lexed the '<' character. This is used for #include filenames.
Chris Lattnerd2177732007-07-20 16:59:19 +00001768void Lexer::LexAngledStringLiteral(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001769 const char *NulCharacter = 0; // Does this string contain the \0 character?
Chris Lattner9cb51ce2009-04-17 23:56:52 +00001770 const char *AfterLessPos = CurPtr;
Reid Spencer5f016e22007-07-11 17:01:13 +00001771 char C = getAndAdvanceChar(CurPtr, Result);
1772 while (C != '>') {
1773 // Skip escaped characters.
1774 if (C == '\\') {
1775 // Skip the escaped character.
1776 C = getAndAdvanceChar(CurPtr, Result);
1777 } else if (C == '\n' || C == '\r' || // Newline.
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001778 (C == 0 && (CurPtr-1 == BufferEnd || // End of file.
1779 isCodeCompletionPoint(CurPtr-1)))) {
Chris Lattner9cb51ce2009-04-17 23:56:52 +00001780 // If the filename is unterminated, then it must just be a lone <
1781 // character. Return this as such.
1782 FormTokenWithChars(Result, AfterLessPos, tok::less);
Reid Spencer5f016e22007-07-11 17:01:13 +00001783 return;
1784 } else if (C == 0) {
1785 NulCharacter = CurPtr-1;
1786 }
1787 C = getAndAdvanceChar(CurPtr, Result);
1788 }
Mike Stump1eb44332009-09-09 15:08:12 +00001789
Reid Spencer5f016e22007-07-11 17:01:13 +00001790 // If a nul character existed in the string, warn about it.
Chris Lattner74d15df2008-11-22 02:02:22 +00001791 if (NulCharacter && !isLexingRawMode())
1792 Diag(NulCharacter, diag::null_in_string);
Mike Stump1eb44332009-09-09 15:08:12 +00001793
Reid Spencer5f016e22007-07-11 17:01:13 +00001794 // Update the location of token as well as BufferPtr.
Chris Lattner47246be2009-01-26 19:29:26 +00001795 const char *TokStart = BufferPtr;
Chris Lattner9e6293d2008-10-12 04:51:35 +00001796 FormTokenWithChars(Result, CurPtr, tok::angle_string_literal);
Chris Lattner47246be2009-01-26 19:29:26 +00001797 Result.setLiteralData(TokStart);
Reid Spencer5f016e22007-07-11 17:01:13 +00001798}
1799
1800
1801/// LexCharConstant - Lex the remainder of a character constant, after having
Douglas Gregor5cee1192011-07-27 05:40:30 +00001802/// lexed either ' or L' or u' or U'.
1803void Lexer::LexCharConstant(Token &Result, const char *CurPtr,
1804 tok::TokenKind Kind) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001805 const char *NulCharacter = 0; // Does this character contain the \0 character?
1806
Richard Smith661a9962011-10-15 01:18:56 +00001807 if (!isLexingRawMode() &&
1808 (Kind == tok::utf16_char_constant || Kind == tok::utf32_char_constant))
1809 Diag(BufferPtr, diag::warn_cxx98_compat_unicode_literal);
1810
Reid Spencer5f016e22007-07-11 17:01:13 +00001811 char C = getAndAdvanceChar(CurPtr, Result);
1812 if (C == '\'') {
David Blaikie4e4d0842012-03-11 07:00:24 +00001813 if (!isLexingRawMode() && !LangOpts.AsmPreprocessor)
Chris Lattner74d15df2008-11-22 02:02:22 +00001814 Diag(BufferPtr, diag::err_empty_character);
Chris Lattner9e6293d2008-10-12 04:51:35 +00001815 FormTokenWithChars(Result, CurPtr, tok::unknown);
Reid Spencer5f016e22007-07-11 17:01:13 +00001816 return;
Chris Lattnerd80f7862010-07-07 23:24:27 +00001817 }
1818
1819 while (C != '\'') {
1820 // Skip escaped characters.
1821 if (C == '\\') {
1822 // Skip the escaped character.
1823 // FIXME: UCN's
1824 C = getAndAdvanceChar(CurPtr, Result);
1825 } else if (C == '\n' || C == '\r' || // Newline.
1826 (C == 0 && CurPtr-1 == BufferEnd)) { // End of file.
David Blaikie4e4d0842012-03-11 07:00:24 +00001827 if (!isLexingRawMode() && !LangOpts.AsmPreprocessor)
Argyrios Kyrtzidisff1ed982011-02-15 23:45:31 +00001828 Diag(BufferPtr, diag::warn_unterminated_char);
Chris Lattnerd80f7862010-07-07 23:24:27 +00001829 FormTokenWithChars(Result, CurPtr-1, tok::unknown);
1830 return;
1831 } else if (C == 0) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001832 if (isCodeCompletionPoint(CurPtr-1)) {
1833 PP->CodeCompleteNaturalLanguage();
1834 FormTokenWithChars(Result, CurPtr-1, tok::unknown);
1835 return cutOffLexing();
1836 }
1837
Chris Lattnerd80f7862010-07-07 23:24:27 +00001838 NulCharacter = CurPtr-1;
1839 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001840 C = getAndAdvanceChar(CurPtr, Result);
1841 }
Mike Stump1eb44332009-09-09 15:08:12 +00001842
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001843 // If we are in C++11, lex the optional ud-suffix.
David Blaikie4e4d0842012-03-11 07:00:24 +00001844 if (getLangOpts().CPlusPlus)
Richard Smith5cc2c6e2012-03-05 04:02:15 +00001845 CurPtr = LexUDSuffix(Result, CurPtr);
1846
Chris Lattnerd80f7862010-07-07 23:24:27 +00001847 // If a nul character existed in the character, warn about it.
Chris Lattner74d15df2008-11-22 02:02:22 +00001848 if (NulCharacter && !isLexingRawMode())
1849 Diag(NulCharacter, diag::null_in_char);
Reid Spencer5f016e22007-07-11 17:01:13 +00001850
Reid Spencer5f016e22007-07-11 17:01:13 +00001851 // Update the location of token as well as BufferPtr.
Chris Lattner47246be2009-01-26 19:29:26 +00001852 const char *TokStart = BufferPtr;
Douglas Gregor5cee1192011-07-27 05:40:30 +00001853 FormTokenWithChars(Result, CurPtr, Kind);
Chris Lattner47246be2009-01-26 19:29:26 +00001854 Result.setLiteralData(TokStart);
Reid Spencer5f016e22007-07-11 17:01:13 +00001855}
1856
1857/// SkipWhitespace - Efficiently skip over a series of whitespace characters.
1858/// Update BufferPtr to point to the next non-whitespace character and return.
Chris Lattnerd88dc482008-10-12 04:05:48 +00001859///
1860/// This method forms a token and returns true if KeepWhitespaceMode is enabled.
1861///
1862bool Lexer::SkipWhitespace(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001863 // Whitespace - Skip it, then return the token after the whitespace.
1864 unsigned char Char = *CurPtr; // Skip consequtive spaces efficiently.
1865 while (1) {
1866 // Skip horizontal whitespace very aggressively.
1867 while (isHorizontalWhitespace(Char))
1868 Char = *++CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00001869
Daniel Dunbarddd3e8b2008-11-25 00:20:22 +00001870 // Otherwise if we have something other than whitespace, we're done.
Reid Spencer5f016e22007-07-11 17:01:13 +00001871 if (Char != '\n' && Char != '\r')
1872 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001873
Reid Spencer5f016e22007-07-11 17:01:13 +00001874 if (ParsingPreprocessorDirective) {
1875 // End of preprocessor directive line, let LexTokenInternal handle this.
1876 BufferPtr = CurPtr;
Chris Lattnerd88dc482008-10-12 04:05:48 +00001877 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001878 }
Mike Stump1eb44332009-09-09 15:08:12 +00001879
Reid Spencer5f016e22007-07-11 17:01:13 +00001880 // ok, but handle newline.
1881 // The returned token is at the start of the line.
Chris Lattnerd2177732007-07-20 16:59:19 +00001882 Result.setFlag(Token::StartOfLine);
Reid Spencer5f016e22007-07-11 17:01:13 +00001883 // No leading whitespace seen so far.
Chris Lattnerd2177732007-07-20 16:59:19 +00001884 Result.clearFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00001885 Char = *++CurPtr;
1886 }
1887
1888 // If this isn't immediately after a newline, there is leading space.
1889 char PrevChar = CurPtr[-1];
1890 if (PrevChar != '\n' && PrevChar != '\r')
Chris Lattnerd2177732007-07-20 16:59:19 +00001891 Result.setFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00001892
Chris Lattnerd88dc482008-10-12 04:05:48 +00001893 // If the client wants us to return whitespace, return it now.
1894 if (isKeepWhitespaceMode()) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00001895 FormTokenWithChars(Result, CurPtr, tok::unknown);
Chris Lattnerd88dc482008-10-12 04:05:48 +00001896 return true;
1897 }
Mike Stump1eb44332009-09-09 15:08:12 +00001898
Reid Spencer5f016e22007-07-11 17:01:13 +00001899 BufferPtr = CurPtr;
Chris Lattnerd88dc482008-10-12 04:05:48 +00001900 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001901}
1902
1903// SkipBCPLComment - We have just read the // characters from input. Skip until
1904// we find the newline character thats terminate the comment. Then update
Chris Lattner046c2272010-01-18 22:35:47 +00001905/// BufferPtr and return.
1906///
1907/// If we're in KeepCommentMode or any CommentHandler has inserted
1908/// some tokens, this will store the first token and return true.
Chris Lattnerd2177732007-07-20 16:59:19 +00001909bool Lexer::SkipBCPLComment(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001910 // If BCPL comments aren't explicitly enabled for this language, emit an
1911 // extension warning.
David Blaikie4e4d0842012-03-11 07:00:24 +00001912 if (!LangOpts.BCPLComment && !isLexingRawMode()) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001913 Diag(BufferPtr, diag::ext_bcpl_comment);
Mike Stump1eb44332009-09-09 15:08:12 +00001914
Reid Spencer5f016e22007-07-11 17:01:13 +00001915 // Mark them enabled so we only emit one warning for this translation
1916 // unit.
David Blaikie4e4d0842012-03-11 07:00:24 +00001917 LangOpts.BCPLComment = true;
Reid Spencer5f016e22007-07-11 17:01:13 +00001918 }
Mike Stump1eb44332009-09-09 15:08:12 +00001919
Reid Spencer5f016e22007-07-11 17:01:13 +00001920 // Scan over the body of the comment. The common case, when scanning, is that
1921 // the comment contains normal ascii characters with nothing interesting in
1922 // them. As such, optimize for this case with the inner loop.
1923 char C;
1924 do {
1925 C = *CurPtr;
Reid Spencer5f016e22007-07-11 17:01:13 +00001926 // Skip over characters in the fast loop.
1927 while (C != 0 && // Potentially EOF.
Reid Spencer5f016e22007-07-11 17:01:13 +00001928 C != '\n' && C != '\r') // Newline or DOS-style newline.
1929 C = *++CurPtr;
1930
Benjamin Kramer1daa58e2011-09-05 07:19:39 +00001931 const char *NextLine = CurPtr;
1932 if (C != 0) {
1933 // We found a newline, see if it's escaped.
1934 const char *EscapePtr = CurPtr-1;
1935 while (isHorizontalWhitespace(*EscapePtr)) // Skip whitespace.
1936 --EscapePtr;
1937
1938 if (*EscapePtr == '\\') // Escaped newline.
1939 CurPtr = EscapePtr;
1940 else if (EscapePtr[0] == '/' && EscapePtr[-1] == '?' &&
1941 EscapePtr[-2] == '?') // Trigraph-escaped newline.
1942 CurPtr = EscapePtr-2;
1943 else
1944 break; // This is a newline, we're done.
1945
1946 C = *CurPtr;
1947 }
Mike Stump1eb44332009-09-09 15:08:12 +00001948
Reid Spencer5f016e22007-07-11 17:01:13 +00001949 // Otherwise, this is a hard case. Fall back on getAndAdvanceChar to
Chris Lattnerbc3e9842008-12-12 07:34:39 +00001950 // properly decode the character. Read it in raw mode to avoid emitting
1951 // diagnostics about things like trigraphs. If we see an escaped newline,
1952 // we'll handle it below.
Reid Spencer5f016e22007-07-11 17:01:13 +00001953 const char *OldPtr = CurPtr;
Chris Lattnerbc3e9842008-12-12 07:34:39 +00001954 bool OldRawMode = isLexingRawMode();
1955 LexingRawMode = true;
Reid Spencer5f016e22007-07-11 17:01:13 +00001956 C = getAndAdvanceChar(CurPtr, Result);
Chris Lattnerbc3e9842008-12-12 07:34:39 +00001957 LexingRawMode = OldRawMode;
Chris Lattneread616c2009-04-05 00:26:41 +00001958
Benjamin Kramer1daa58e2011-09-05 07:19:39 +00001959 // If we only read only one character, then no special handling is needed.
1960 // We're done and can skip forward to the newline.
1961 if (C != 0 && CurPtr == OldPtr+1) {
1962 CurPtr = NextLine;
1963 break;
1964 }
1965
Reid Spencer5f016e22007-07-11 17:01:13 +00001966 // If we read multiple characters, and one of those characters was a \r or
1967 // \n, then we had an escaped newline within the comment. Emit diagnostic
1968 // unless the next line is also a // comment.
1969 if (CurPtr != OldPtr+1 && C != '/' && CurPtr[0] != '/') {
1970 for (; OldPtr != CurPtr; ++OldPtr)
1971 if (OldPtr[0] == '\n' || OldPtr[0] == '\r') {
1972 // Okay, we found a // comment that ends in a newline, if the next
1973 // line is also a // comment, but has spaces, don't emit a diagnostic.
Benjamin Kramer5d6ae282011-09-05 07:19:35 +00001974 if (isWhitespace(C)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001975 const char *ForwardPtr = CurPtr;
Benjamin Kramer5d6ae282011-09-05 07:19:35 +00001976 while (isWhitespace(*ForwardPtr)) // Skip whitespace.
Reid Spencer5f016e22007-07-11 17:01:13 +00001977 ++ForwardPtr;
1978 if (ForwardPtr[0] == '/' && ForwardPtr[1] == '/')
1979 break;
1980 }
Mike Stump1eb44332009-09-09 15:08:12 +00001981
Chris Lattner74d15df2008-11-22 02:02:22 +00001982 if (!isLexingRawMode())
1983 Diag(OldPtr-1, diag::ext_multi_line_bcpl_comment);
Reid Spencer5f016e22007-07-11 17:01:13 +00001984 break;
1985 }
1986 }
Mike Stump1eb44332009-09-09 15:08:12 +00001987
Douglas Gregor55817af2010-08-25 17:04:25 +00001988 if (CurPtr == BufferEnd+1) {
Douglas Gregor55817af2010-08-25 17:04:25 +00001989 --CurPtr;
1990 break;
1991 }
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00001992
1993 if (C == '\0' && isCodeCompletionPoint(CurPtr-1)) {
1994 PP->CodeCompleteNaturalLanguage();
1995 cutOffLexing();
1996 return false;
1997 }
1998
Reid Spencer5f016e22007-07-11 17:01:13 +00001999 } while (C != '\n' && C != '\r');
2000
Chris Lattner3d0ad582010-02-03 21:06:21 +00002001 // Found but did not consume the newline. Notify comment handlers about the
2002 // comment unless we're in a #if 0 block.
2003 if (PP && !isLexingRawMode() &&
2004 PP->HandleComment(Result, SourceRange(getSourceLocation(BufferPtr),
2005 getSourceLocation(CurPtr)))) {
Chris Lattner046c2272010-01-18 22:35:47 +00002006 BufferPtr = CurPtr;
2007 return true; // A token has to be returned.
2008 }
Mike Stump1eb44332009-09-09 15:08:12 +00002009
Reid Spencer5f016e22007-07-11 17:01:13 +00002010 // If we are returning comments as tokens, return this comment as a token.
Chris Lattnerfa95a012008-10-12 03:22:02 +00002011 if (inKeepCommentMode())
Reid Spencer5f016e22007-07-11 17:01:13 +00002012 return SaveBCPLComment(Result, CurPtr);
2013
2014 // If we are inside a preprocessor directive and we see the end of line,
Peter Collingbourne84021552011-02-28 02:37:51 +00002015 // return immediately, so that the lexer can return this as an EOD token.
Reid Spencer5f016e22007-07-11 17:01:13 +00002016 if (ParsingPreprocessorDirective || CurPtr == BufferEnd) {
2017 BufferPtr = CurPtr;
Chris Lattner2d381892008-10-12 04:15:42 +00002018 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002019 }
Mike Stump1eb44332009-09-09 15:08:12 +00002020
Reid Spencer5f016e22007-07-11 17:01:13 +00002021 // Otherwise, eat the \n character. We don't care if this is a \n\r or
Chris Lattner7a4f0042008-10-12 00:23:07 +00002022 // \r\n sequence. This is an efficiency hack (because we know the \n can't
Chris Lattnerd88dc482008-10-12 04:05:48 +00002023 // contribute to another token), it isn't needed for correctness. Note that
2024 // this is ok even in KeepWhitespaceMode, because we would have returned the
2025 /// comment above in that mode.
Reid Spencer5f016e22007-07-11 17:01:13 +00002026 ++CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002027
Reid Spencer5f016e22007-07-11 17:01:13 +00002028 // The next returned token is at the start of the line.
Chris Lattnerd2177732007-07-20 16:59:19 +00002029 Result.setFlag(Token::StartOfLine);
Reid Spencer5f016e22007-07-11 17:01:13 +00002030 // No leading whitespace seen so far.
Chris Lattnerd2177732007-07-20 16:59:19 +00002031 Result.clearFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00002032 BufferPtr = CurPtr;
Chris Lattner2d381892008-10-12 04:15:42 +00002033 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002034}
2035
2036/// SaveBCPLComment - If in save-comment mode, package up this BCPL comment in
2037/// an appropriate way and return it.
Chris Lattnerd2177732007-07-20 16:59:19 +00002038bool Lexer::SaveBCPLComment(Token &Result, const char *CurPtr) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002039 // If we're not in a preprocessor directive, just return the // comment
2040 // directly.
2041 FormTokenWithChars(Result, CurPtr, tok::comment);
Mike Stump1eb44332009-09-09 15:08:12 +00002042
David Blaikie8c0b3782012-06-06 18:52:13 +00002043 if (!ParsingPreprocessorDirective || LexingRawMode)
Chris Lattner9e6293d2008-10-12 04:51:35 +00002044 return true;
Mike Stump1eb44332009-09-09 15:08:12 +00002045
Chris Lattner9e6293d2008-10-12 04:51:35 +00002046 // If this BCPL-style comment is in a macro definition, transmogrify it into
2047 // a C-style block comment.
Douglas Gregor453091c2010-03-16 22:30:13 +00002048 bool Invalid = false;
2049 std::string Spelling = PP->getSpelling(Result, &Invalid);
2050 if (Invalid)
2051 return true;
2052
Chris Lattner9e6293d2008-10-12 04:51:35 +00002053 assert(Spelling[0] == '/' && Spelling[1] == '/' && "Not bcpl comment?");
2054 Spelling[1] = '*'; // Change prefix to "/*".
2055 Spelling += "*/"; // add suffix.
Mike Stump1eb44332009-09-09 15:08:12 +00002056
Chris Lattner9e6293d2008-10-12 04:51:35 +00002057 Result.setKind(tok::comment);
Chris Lattner47246be2009-01-26 19:29:26 +00002058 PP->CreateString(&Spelling[0], Spelling.size(), Result,
Abramo Bagnaraa08529c2011-10-03 18:39:03 +00002059 Result.getLocation(), Result.getLocation());
Chris Lattner2d381892008-10-12 04:15:42 +00002060 return true;
Reid Spencer5f016e22007-07-11 17:01:13 +00002061}
2062
2063/// isBlockCommentEndOfEscapedNewLine - Return true if the specified newline
David Blaikie80d7c522012-06-06 18:43:20 +00002064/// character (either \\n or \\r) is part of an escaped newline sequence. Issue
2065/// a diagnostic if so. We know that the newline is inside of a block comment.
Mike Stump1eb44332009-09-09 15:08:12 +00002066static bool isEndOfBlockCommentWithEscapedNewLine(const char *CurPtr,
Reid Spencer5f016e22007-07-11 17:01:13 +00002067 Lexer *L) {
2068 assert(CurPtr[0] == '\n' || CurPtr[0] == '\r');
Mike Stump1eb44332009-09-09 15:08:12 +00002069
Reid Spencer5f016e22007-07-11 17:01:13 +00002070 // Back up off the newline.
2071 --CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002072
Reid Spencer5f016e22007-07-11 17:01:13 +00002073 // If this is a two-character newline sequence, skip the other character.
2074 if (CurPtr[0] == '\n' || CurPtr[0] == '\r') {
2075 // \n\n or \r\r -> not escaped newline.
2076 if (CurPtr[0] == CurPtr[1])
2077 return false;
2078 // \n\r or \r\n -> skip the newline.
2079 --CurPtr;
2080 }
Mike Stump1eb44332009-09-09 15:08:12 +00002081
Reid Spencer5f016e22007-07-11 17:01:13 +00002082 // If we have horizontal whitespace, skip over it. We allow whitespace
2083 // between the slash and newline.
2084 bool HasSpace = false;
2085 while (isHorizontalWhitespace(*CurPtr) || *CurPtr == 0) {
2086 --CurPtr;
2087 HasSpace = true;
2088 }
Mike Stump1eb44332009-09-09 15:08:12 +00002089
Reid Spencer5f016e22007-07-11 17:01:13 +00002090 // If we have a slash, we know this is an escaped newline.
2091 if (*CurPtr == '\\') {
2092 if (CurPtr[-1] != '*') return false;
2093 } else {
2094 // It isn't a slash, is it the ?? / trigraph?
2095 if (CurPtr[0] != '/' || CurPtr[-1] != '?' || CurPtr[-2] != '?' ||
2096 CurPtr[-3] != '*')
2097 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00002098
Reid Spencer5f016e22007-07-11 17:01:13 +00002099 // This is the trigraph ending the comment. Emit a stern warning!
2100 CurPtr -= 2;
2101
2102 // If no trigraphs are enabled, warn that we ignored this trigraph and
2103 // ignore this * character.
David Blaikie4e4d0842012-03-11 07:00:24 +00002104 if (!L->getLangOpts().Trigraphs) {
Chris Lattner74d15df2008-11-22 02:02:22 +00002105 if (!L->isLexingRawMode())
2106 L->Diag(CurPtr, diag::trigraph_ignored_block_comment);
Reid Spencer5f016e22007-07-11 17:01:13 +00002107 return false;
2108 }
Chris Lattner74d15df2008-11-22 02:02:22 +00002109 if (!L->isLexingRawMode())
2110 L->Diag(CurPtr, diag::trigraph_ends_block_comment);
Reid Spencer5f016e22007-07-11 17:01:13 +00002111 }
Mike Stump1eb44332009-09-09 15:08:12 +00002112
Reid Spencer5f016e22007-07-11 17:01:13 +00002113 // Warn about having an escaped newline between the */ characters.
Chris Lattner74d15df2008-11-22 02:02:22 +00002114 if (!L->isLexingRawMode())
2115 L->Diag(CurPtr, diag::escaped_newline_block_comment_end);
Mike Stump1eb44332009-09-09 15:08:12 +00002116
Reid Spencer5f016e22007-07-11 17:01:13 +00002117 // If there was space between the backslash and newline, warn about it.
Chris Lattner74d15df2008-11-22 02:02:22 +00002118 if (HasSpace && !L->isLexingRawMode())
2119 L->Diag(CurPtr, diag::backslash_newline_space);
Mike Stump1eb44332009-09-09 15:08:12 +00002120
Reid Spencer5f016e22007-07-11 17:01:13 +00002121 return true;
2122}
2123
2124#ifdef __SSE2__
2125#include <emmintrin.h>
2126#elif __ALTIVEC__
2127#include <altivec.h>
2128#undef bool
2129#endif
2130
2131/// SkipBlockComment - We have just read the /* characters from input. Read
2132/// until we find the */ characters that terminate the comment. Note that we
2133/// don't bother decoding trigraphs or escaped newlines in block comments,
2134/// because they cannot cause the comment to end. The only thing that can
2135/// happen is the comment could end with an escaped newline between the */ end
2136/// of comment.
Chris Lattner2d381892008-10-12 04:15:42 +00002137///
Chris Lattner046c2272010-01-18 22:35:47 +00002138/// If we're in KeepCommentMode or any CommentHandler has inserted
2139/// some tokens, this will store the first token and return true.
Chris Lattnerd2177732007-07-20 16:59:19 +00002140bool Lexer::SkipBlockComment(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002141 // Scan one character past where we should, looking for a '/' character. Once
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002142 // we find it, check to see if it was preceded by a *. This common
Reid Spencer5f016e22007-07-11 17:01:13 +00002143 // optimization helps people who like to put a lot of * characters in their
2144 // comments.
Chris Lattner8146b682007-07-21 23:43:37 +00002145
2146 // The first character we get with newlines and trigraphs skipped to handle
2147 // the degenerate /*/ case below correctly if the * has an escaped newline
2148 // after it.
2149 unsigned CharSize;
2150 unsigned char C = getCharAndSize(CurPtr, CharSize);
2151 CurPtr += CharSize;
Reid Spencer5f016e22007-07-11 17:01:13 +00002152 if (C == 0 && CurPtr == BufferEnd+1) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002153 if (!isLexingRawMode())
Chris Lattner0af57422008-10-12 01:31:51 +00002154 Diag(BufferPtr, diag::err_unterminated_block_comment);
Chris Lattner31f0eca2008-10-12 04:19:49 +00002155 --CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002156
Chris Lattner31f0eca2008-10-12 04:19:49 +00002157 // KeepWhitespaceMode should return this broken comment as a token. Since
2158 // it isn't a well formed comment, just return it as an 'unknown' token.
2159 if (isKeepWhitespaceMode()) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002160 FormTokenWithChars(Result, CurPtr, tok::unknown);
Chris Lattner31f0eca2008-10-12 04:19:49 +00002161 return true;
2162 }
Mike Stump1eb44332009-09-09 15:08:12 +00002163
Chris Lattner31f0eca2008-10-12 04:19:49 +00002164 BufferPtr = CurPtr;
Chris Lattner2d381892008-10-12 04:15:42 +00002165 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002166 }
Mike Stump1eb44332009-09-09 15:08:12 +00002167
Chris Lattner8146b682007-07-21 23:43:37 +00002168 // Check to see if the first character after the '/*' is another /. If so,
2169 // then this slash does not end the block comment, it is part of it.
2170 if (C == '/')
2171 C = *CurPtr++;
Mike Stump1eb44332009-09-09 15:08:12 +00002172
Reid Spencer5f016e22007-07-11 17:01:13 +00002173 while (1) {
2174 // Skip over all non-interesting characters until we find end of buffer or a
2175 // (probably ending) '/' character.
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002176 if (CurPtr + 24 < BufferEnd &&
2177 // If there is a code-completion point avoid the fast scan because it
2178 // doesn't check for '\0'.
2179 !(PP && PP->getCodeCompletionFileLoc() == FileLoc)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002180 // While not aligned to a 16-byte boundary.
2181 while (C != '/' && ((intptr_t)CurPtr & 0x0F) != 0)
2182 C = *CurPtr++;
Mike Stump1eb44332009-09-09 15:08:12 +00002183
Reid Spencer5f016e22007-07-11 17:01:13 +00002184 if (C == '/') goto FoundSlash;
2185
2186#ifdef __SSE2__
Benjamin Kramer3f6f4e62011-11-22 18:56:46 +00002187 __m128i Slashes = _mm_set1_epi8('/');
2188 while (CurPtr+16 <= BufferEnd) {
2189 int cmp = _mm_movemask_epi8(_mm_cmpeq_epi8(*(__m128i*)CurPtr, Slashes));
2190 if (cmp != 0) {
Benjamin Kramer6300f5b2011-11-22 20:39:31 +00002191 // Adjust the pointer to point directly after the first slash. It's
2192 // not necessary to set C here, it will be overwritten at the end of
2193 // the outer loop.
2194 CurPtr += llvm::CountTrailingZeros_32(cmp) + 1;
Benjamin Kramer3f6f4e62011-11-22 18:56:46 +00002195 goto FoundSlash;
2196 }
Reid Spencer5f016e22007-07-11 17:01:13 +00002197 CurPtr += 16;
Benjamin Kramer3f6f4e62011-11-22 18:56:46 +00002198 }
Reid Spencer5f016e22007-07-11 17:01:13 +00002199#elif __ALTIVEC__
2200 __vector unsigned char Slashes = {
Mike Stump1eb44332009-09-09 15:08:12 +00002201 '/', '/', '/', '/', '/', '/', '/', '/',
Reid Spencer5f016e22007-07-11 17:01:13 +00002202 '/', '/', '/', '/', '/', '/', '/', '/'
2203 };
2204 while (CurPtr+16 <= BufferEnd &&
2205 !vec_any_eq(*(vector unsigned char*)CurPtr, Slashes))
2206 CurPtr += 16;
Mike Stump1eb44332009-09-09 15:08:12 +00002207#else
Reid Spencer5f016e22007-07-11 17:01:13 +00002208 // Scan for '/' quickly. Many block comments are very large.
2209 while (CurPtr[0] != '/' &&
2210 CurPtr[1] != '/' &&
2211 CurPtr[2] != '/' &&
2212 CurPtr[3] != '/' &&
2213 CurPtr+4 < BufferEnd) {
2214 CurPtr += 4;
2215 }
2216#endif
Mike Stump1eb44332009-09-09 15:08:12 +00002217
Reid Spencer5f016e22007-07-11 17:01:13 +00002218 // It has to be one of the bytes scanned, increment to it and read one.
2219 C = *CurPtr++;
2220 }
Mike Stump1eb44332009-09-09 15:08:12 +00002221
Reid Spencer5f016e22007-07-11 17:01:13 +00002222 // Loop to scan the remainder.
2223 while (C != '/' && C != '\0')
2224 C = *CurPtr++;
Mike Stump1eb44332009-09-09 15:08:12 +00002225
Reid Spencer5f016e22007-07-11 17:01:13 +00002226 if (C == '/') {
Benjamin Kramer3f6f4e62011-11-22 18:56:46 +00002227 FoundSlash:
Reid Spencer5f016e22007-07-11 17:01:13 +00002228 if (CurPtr[-2] == '*') // We found the final */. We're done!
2229 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002230
Reid Spencer5f016e22007-07-11 17:01:13 +00002231 if ((CurPtr[-2] == '\n' || CurPtr[-2] == '\r')) {
2232 if (isEndOfBlockCommentWithEscapedNewLine(CurPtr-2, this)) {
2233 // We found the final */, though it had an escaped newline between the
2234 // * and /. We're done!
2235 break;
2236 }
2237 }
2238 if (CurPtr[0] == '*' && CurPtr[1] != '/') {
2239 // If this is a /* inside of the comment, emit a warning. Don't do this
2240 // if this is a /*/, which will end the comment. This misses cases with
2241 // embedded escaped newlines, but oh well.
Chris Lattner74d15df2008-11-22 02:02:22 +00002242 if (!isLexingRawMode())
2243 Diag(CurPtr-1, diag::warn_nested_block_comment);
Reid Spencer5f016e22007-07-11 17:01:13 +00002244 }
2245 } else if (C == 0 && CurPtr == BufferEnd+1) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002246 if (!isLexingRawMode())
Chris Lattner74d15df2008-11-22 02:02:22 +00002247 Diag(BufferPtr, diag::err_unterminated_block_comment);
Reid Spencer5f016e22007-07-11 17:01:13 +00002248 // Note: the user probably forgot a */. We could continue immediately
2249 // after the /*, but this would involve lexing a lot of what really is the
2250 // comment, which surely would confuse the parser.
Chris Lattner31f0eca2008-10-12 04:19:49 +00002251 --CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002252
Chris Lattner31f0eca2008-10-12 04:19:49 +00002253 // KeepWhitespaceMode should return this broken comment as a token. Since
2254 // it isn't a well formed comment, just return it as an 'unknown' token.
2255 if (isKeepWhitespaceMode()) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002256 FormTokenWithChars(Result, CurPtr, tok::unknown);
Chris Lattner31f0eca2008-10-12 04:19:49 +00002257 return true;
2258 }
Mike Stump1eb44332009-09-09 15:08:12 +00002259
Chris Lattner31f0eca2008-10-12 04:19:49 +00002260 BufferPtr = CurPtr;
Chris Lattner2d381892008-10-12 04:15:42 +00002261 return false;
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002262 } else if (C == '\0' && isCodeCompletionPoint(CurPtr-1)) {
2263 PP->CodeCompleteNaturalLanguage();
2264 cutOffLexing();
2265 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002266 }
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002267
Reid Spencer5f016e22007-07-11 17:01:13 +00002268 C = *CurPtr++;
2269 }
Mike Stump1eb44332009-09-09 15:08:12 +00002270
Chris Lattner3d0ad582010-02-03 21:06:21 +00002271 // Notify comment handlers about the comment unless we're in a #if 0 block.
2272 if (PP && !isLexingRawMode() &&
2273 PP->HandleComment(Result, SourceRange(getSourceLocation(BufferPtr),
2274 getSourceLocation(CurPtr)))) {
Chris Lattner046c2272010-01-18 22:35:47 +00002275 BufferPtr = CurPtr;
2276 return true; // A token has to be returned.
2277 }
Douglas Gregor2e222532009-07-02 17:08:52 +00002278
Reid Spencer5f016e22007-07-11 17:01:13 +00002279 // If we are returning comments as tokens, return this comment as a token.
Chris Lattnerfa95a012008-10-12 03:22:02 +00002280 if (inKeepCommentMode()) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002281 FormTokenWithChars(Result, CurPtr, tok::comment);
Chris Lattner2d381892008-10-12 04:15:42 +00002282 return true;
Reid Spencer5f016e22007-07-11 17:01:13 +00002283 }
2284
2285 // It is common for the tokens immediately after a /**/ comment to be
2286 // whitespace. Instead of going through the big switch, handle it
Chris Lattnerd88dc482008-10-12 04:05:48 +00002287 // efficiently now. This is safe even in KeepWhitespaceMode because we would
2288 // have already returned above with the comment as a token.
Reid Spencer5f016e22007-07-11 17:01:13 +00002289 if (isHorizontalWhitespace(*CurPtr)) {
Chris Lattnerd2177732007-07-20 16:59:19 +00002290 Result.setFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00002291 SkipWhitespace(Result, CurPtr+1);
Chris Lattner2d381892008-10-12 04:15:42 +00002292 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002293 }
2294
2295 // Otherwise, just return so that the next character will be lexed as a token.
2296 BufferPtr = CurPtr;
Chris Lattnerd2177732007-07-20 16:59:19 +00002297 Result.setFlag(Token::LeadingSpace);
Chris Lattner2d381892008-10-12 04:15:42 +00002298 return false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002299}
2300
2301//===----------------------------------------------------------------------===//
2302// Primary Lexing Entry Points
2303//===----------------------------------------------------------------------===//
2304
Reid Spencer5f016e22007-07-11 17:01:13 +00002305/// ReadToEndOfLine - Read the rest of the current preprocessor line as an
2306/// uninterpreted string. This switches the lexer out of directive mode.
Benjamin Kramer3093b202012-05-18 19:32:16 +00002307void Lexer::ReadToEndOfLine(SmallVectorImpl<char> *Result) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002308 assert(ParsingPreprocessorDirective && ParsingFilename == false &&
2309 "Must be in a preprocessing directive!");
Chris Lattnerd2177732007-07-20 16:59:19 +00002310 Token Tmp;
Reid Spencer5f016e22007-07-11 17:01:13 +00002311
2312 // CurPtr - Cache BufferPtr in an automatic variable.
2313 const char *CurPtr = BufferPtr;
2314 while (1) {
2315 char Char = getAndAdvanceChar(CurPtr, Tmp);
2316 switch (Char) {
2317 default:
Benjamin Kramer3093b202012-05-18 19:32:16 +00002318 if (Result)
2319 Result->push_back(Char);
Reid Spencer5f016e22007-07-11 17:01:13 +00002320 break;
2321 case 0: // Null.
2322 // Found end of file?
2323 if (CurPtr-1 != BufferEnd) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002324 if (isCodeCompletionPoint(CurPtr-1)) {
2325 PP->CodeCompleteNaturalLanguage();
2326 cutOffLexing();
Benjamin Kramer3093b202012-05-18 19:32:16 +00002327 return;
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002328 }
2329
Reid Spencer5f016e22007-07-11 17:01:13 +00002330 // Nope, normal character, continue.
Benjamin Kramer3093b202012-05-18 19:32:16 +00002331 if (Result)
2332 Result->push_back(Char);
Reid Spencer5f016e22007-07-11 17:01:13 +00002333 break;
2334 }
2335 // FALL THROUGH.
2336 case '\r':
2337 case '\n':
2338 // Okay, we found the end of the line. First, back up past the \0, \r, \n.
2339 assert(CurPtr[-1] == Char && "Trigraphs for newline?");
2340 BufferPtr = CurPtr-1;
Mike Stump1eb44332009-09-09 15:08:12 +00002341
Peter Collingbourne84021552011-02-28 02:37:51 +00002342 // Next, lex the character, which should handle the EOD transition.
Reid Spencer5f016e22007-07-11 17:01:13 +00002343 Lex(Tmp);
Douglas Gregor55817af2010-08-25 17:04:25 +00002344 if (Tmp.is(tok::code_completion)) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002345 if (PP)
2346 PP->CodeCompleteNaturalLanguage();
Douglas Gregor55817af2010-08-25 17:04:25 +00002347 Lex(Tmp);
2348 }
Peter Collingbourne84021552011-02-28 02:37:51 +00002349 assert(Tmp.is(tok::eod) && "Unexpected token!");
Mike Stump1eb44332009-09-09 15:08:12 +00002350
Benjamin Kramer3093b202012-05-18 19:32:16 +00002351 // Finally, we're done;
2352 return;
Reid Spencer5f016e22007-07-11 17:01:13 +00002353 }
2354 }
2355}
2356
2357/// LexEndOfFile - CurPtr points to the end of this file. Handle this
2358/// condition, reporting diagnostics and handling other edge cases as required.
2359/// This returns true if Result contains a token, false if PP.Lex should be
2360/// called again.
Chris Lattnerd2177732007-07-20 16:59:19 +00002361bool Lexer::LexEndOfFile(Token &Result, const char *CurPtr) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002362 // If we hit the end of the file while parsing a preprocessor directive,
2363 // end the preprocessor directive first. The next token returned will
2364 // then be the end of file.
2365 if (ParsingPreprocessorDirective) {
2366 // Done parsing the "line".
2367 ParsingPreprocessorDirective = false;
Reid Spencer5f016e22007-07-11 17:01:13 +00002368 // Update the location of token as well as BufferPtr.
Peter Collingbourne84021552011-02-28 02:37:51 +00002369 FormTokenWithChars(Result, CurPtr, tok::eod);
Mike Stump1eb44332009-09-09 15:08:12 +00002370
Reid Spencer5f016e22007-07-11 17:01:13 +00002371 // Restore comment saving mode, in case it was disabled for directive.
Chris Lattnerf744d132008-10-12 03:27:19 +00002372 SetCommentRetentionState(PP->getCommentRetentionState());
Reid Spencer5f016e22007-07-11 17:01:13 +00002373 return true; // Have a token.
Mike Stump1eb44332009-09-09 15:08:12 +00002374 }
Douglas Gregor86d9a522009-09-21 16:56:56 +00002375
Reid Spencer5f016e22007-07-11 17:01:13 +00002376 // If we are in raw mode, return this event as an EOF token. Let the caller
2377 // that put us in raw mode handle the event.
Chris Lattner74d15df2008-11-22 02:02:22 +00002378 if (isLexingRawMode()) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002379 Result.startToken();
2380 BufferPtr = BufferEnd;
Chris Lattner9e6293d2008-10-12 04:51:35 +00002381 FormTokenWithChars(Result, BufferEnd, tok::eof);
Reid Spencer5f016e22007-07-11 17:01:13 +00002382 return true;
2383 }
Douglas Gregor86d9a522009-09-21 16:56:56 +00002384
Douglas Gregorf44e8542010-08-24 19:08:16 +00002385 // Issue diagnostics for unterminated #if and missing newline.
2386
Reid Spencer5f016e22007-07-11 17:01:13 +00002387 // If we are in a #if directive, emit an error.
2388 while (!ConditionalStack.empty()) {
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002389 if (PP->getCodeCompletionFileLoc() != FileLoc)
Douglas Gregor2d474ba2010-08-12 17:04:55 +00002390 PP->Diag(ConditionalStack.back().IfLoc,
2391 diag::err_pp_unterminated_conditional);
Reid Spencer5f016e22007-07-11 17:01:13 +00002392 ConditionalStack.pop_back();
2393 }
Mike Stump1eb44332009-09-09 15:08:12 +00002394
Chris Lattnerb25e5d72008-04-12 05:54:25 +00002395 // C99 5.1.1.2p2: If the file is non-empty and didn't end in a newline, issue
2396 // a pedwarn.
Seth Cantrell5e6c3f02012-04-13 03:43:23 +00002397 if (CurPtr != BufferStart && (CurPtr[-1] != '\n' && CurPtr[-1] != '\r'))
2398 Diag(BufferEnd, LangOpts.CPlusPlus0x ? // C++11 [lex.phases] 2.2 p2
2399 diag::warn_cxx98_compat_no_newline_eof : diag::ext_no_newline_eof)
2400 << FixItHint::CreateInsertion(getSourceLocation(BufferEnd), "\n");
Mike Stump1eb44332009-09-09 15:08:12 +00002401
Reid Spencer5f016e22007-07-11 17:01:13 +00002402 BufferPtr = CurPtr;
2403
2404 // Finally, let the preprocessor handle this.
Jordan Rose0cdd1fe2012-06-15 23:33:51 +00002405 return PP->HandleEndOfFile(Result, isPragmaLexer());
Reid Spencer5f016e22007-07-11 17:01:13 +00002406}
2407
2408/// isNextPPTokenLParen - Return 1 if the next unexpanded token lexed from
2409/// the specified lexer will return a tok::l_paren token, 0 if it is something
2410/// else and 2 if there are no more tokens in the buffer controlled by the
2411/// lexer.
2412unsigned Lexer::isNextPPTokenLParen() {
2413 assert(!LexingRawMode && "How can we expand a macro from a skipping buffer?");
Mike Stump1eb44332009-09-09 15:08:12 +00002414
Reid Spencer5f016e22007-07-11 17:01:13 +00002415 // Switch to 'skipping' mode. This will ensure that we can lex a token
2416 // without emitting diagnostics, disables macro expansion, and will cause EOF
2417 // to return an EOF token instead of popping the include stack.
2418 LexingRawMode = true;
Mike Stump1eb44332009-09-09 15:08:12 +00002419
Reid Spencer5f016e22007-07-11 17:01:13 +00002420 // Save state that can be changed while lexing so that we can restore it.
2421 const char *TmpBufferPtr = BufferPtr;
Chris Lattnera864cf72009-04-24 07:15:46 +00002422 bool inPPDirectiveMode = ParsingPreprocessorDirective;
Mike Stump1eb44332009-09-09 15:08:12 +00002423
Chris Lattnerd2177732007-07-20 16:59:19 +00002424 Token Tok;
Reid Spencer5f016e22007-07-11 17:01:13 +00002425 Tok.startToken();
2426 LexTokenInternal(Tok);
Mike Stump1eb44332009-09-09 15:08:12 +00002427
Reid Spencer5f016e22007-07-11 17:01:13 +00002428 // Restore state that may have changed.
2429 BufferPtr = TmpBufferPtr;
Chris Lattnera864cf72009-04-24 07:15:46 +00002430 ParsingPreprocessorDirective = inPPDirectiveMode;
Mike Stump1eb44332009-09-09 15:08:12 +00002431
Reid Spencer5f016e22007-07-11 17:01:13 +00002432 // Restore the lexer back to non-skipping mode.
2433 LexingRawMode = false;
Mike Stump1eb44332009-09-09 15:08:12 +00002434
Chris Lattner22f6bbc2007-10-09 18:02:16 +00002435 if (Tok.is(tok::eof))
Reid Spencer5f016e22007-07-11 17:01:13 +00002436 return 2;
Chris Lattner22f6bbc2007-10-09 18:02:16 +00002437 return Tok.is(tok::l_paren);
Reid Spencer5f016e22007-07-11 17:01:13 +00002438}
2439
Chris Lattner34f349d2009-12-14 06:16:57 +00002440/// FindConflictEnd - Find the end of a version control conflict marker.
Richard Smithd5e1d602011-10-12 00:37:51 +00002441static const char *FindConflictEnd(const char *CurPtr, const char *BufferEnd,
2442 ConflictMarkerKind CMK) {
2443 const char *Terminator = CMK == CMK_Perforce ? "<<<<\n" : ">>>>>>>";
2444 size_t TermLen = CMK == CMK_Perforce ? 5 : 7;
2445 StringRef RestOfBuffer(CurPtr+TermLen, BufferEnd-CurPtr-TermLen);
2446 size_t Pos = RestOfBuffer.find(Terminator);
Chris Lattner5f9e2722011-07-23 10:55:15 +00002447 while (Pos != StringRef::npos) {
Chris Lattner34f349d2009-12-14 06:16:57 +00002448 // Must occur at start of line.
2449 if (RestOfBuffer[Pos-1] != '\r' &&
2450 RestOfBuffer[Pos-1] != '\n') {
Richard Smithd5e1d602011-10-12 00:37:51 +00002451 RestOfBuffer = RestOfBuffer.substr(Pos+TermLen);
2452 Pos = RestOfBuffer.find(Terminator);
Chris Lattner34f349d2009-12-14 06:16:57 +00002453 continue;
2454 }
2455 return RestOfBuffer.data()+Pos;
2456 }
2457 return 0;
2458}
2459
2460/// IsStartOfConflictMarker - If the specified pointer is the start of a version
2461/// control conflict marker like '<<<<<<<', recognize it as such, emit an error
2462/// and recover nicely. This returns true if it is a conflict marker and false
2463/// if not.
2464bool Lexer::IsStartOfConflictMarker(const char *CurPtr) {
2465 // Only a conflict marker if it starts at the beginning of a line.
2466 if (CurPtr != BufferStart &&
2467 CurPtr[-1] != '\n' && CurPtr[-1] != '\r')
2468 return false;
2469
Richard Smithd5e1d602011-10-12 00:37:51 +00002470 // Check to see if we have <<<<<<< or >>>>.
2471 if ((BufferEnd-CurPtr < 8 || StringRef(CurPtr, 7) != "<<<<<<<") &&
2472 (BufferEnd-CurPtr < 6 || StringRef(CurPtr, 5) != ">>>> "))
Chris Lattner34f349d2009-12-14 06:16:57 +00002473 return false;
2474
2475 // If we have a situation where we don't care about conflict markers, ignore
2476 // it.
Richard Smithd5e1d602011-10-12 00:37:51 +00002477 if (CurrentConflictMarkerState || isLexingRawMode())
Chris Lattner34f349d2009-12-14 06:16:57 +00002478 return false;
2479
Richard Smithd5e1d602011-10-12 00:37:51 +00002480 ConflictMarkerKind Kind = *CurPtr == '<' ? CMK_Normal : CMK_Perforce;
2481
2482 // Check to see if there is an ending marker somewhere in the buffer at the
2483 // start of a line to terminate this conflict marker.
2484 if (FindConflictEnd(CurPtr, BufferEnd, Kind)) {
Chris Lattner34f349d2009-12-14 06:16:57 +00002485 // We found a match. We are really in a conflict marker.
2486 // Diagnose this, and ignore to the end of line.
2487 Diag(CurPtr, diag::err_conflict_marker);
Richard Smithd5e1d602011-10-12 00:37:51 +00002488 CurrentConflictMarkerState = Kind;
Chris Lattner34f349d2009-12-14 06:16:57 +00002489
2490 // Skip ahead to the end of line. We know this exists because the
2491 // end-of-conflict marker starts with \r or \n.
2492 while (*CurPtr != '\r' && *CurPtr != '\n') {
2493 assert(CurPtr != BufferEnd && "Didn't find end of line");
2494 ++CurPtr;
2495 }
2496 BufferPtr = CurPtr;
2497 return true;
2498 }
2499
2500 // No end of conflict marker found.
2501 return false;
2502}
2503
2504
Richard Smithd5e1d602011-10-12 00:37:51 +00002505/// HandleEndOfConflictMarker - If this is a '====' or '||||' or '>>>>', or if
2506/// it is '<<<<' and the conflict marker started with a '>>>>' marker, then it
2507/// is the end of a conflict marker. Handle it by ignoring up until the end of
2508/// the line. This returns true if it is a conflict marker and false if not.
Chris Lattner34f349d2009-12-14 06:16:57 +00002509bool Lexer::HandleEndOfConflictMarker(const char *CurPtr) {
2510 // Only a conflict marker if it starts at the beginning of a line.
2511 if (CurPtr != BufferStart &&
2512 CurPtr[-1] != '\n' && CurPtr[-1] != '\r')
2513 return false;
2514
2515 // If we have a situation where we don't care about conflict markers, ignore
2516 // it.
Richard Smithd5e1d602011-10-12 00:37:51 +00002517 if (!CurrentConflictMarkerState || isLexingRawMode())
Chris Lattner34f349d2009-12-14 06:16:57 +00002518 return false;
2519
Richard Smithd5e1d602011-10-12 00:37:51 +00002520 // Check to see if we have the marker (4 characters in a row).
2521 for (unsigned i = 1; i != 4; ++i)
Chris Lattner34f349d2009-12-14 06:16:57 +00002522 if (CurPtr[i] != CurPtr[0])
2523 return false;
2524
2525 // If we do have it, search for the end of the conflict marker. This could
2526 // fail if it got skipped with a '#if 0' or something. Note that CurPtr might
2527 // be the end of conflict marker.
Richard Smithd5e1d602011-10-12 00:37:51 +00002528 if (const char *End = FindConflictEnd(CurPtr, BufferEnd,
2529 CurrentConflictMarkerState)) {
Chris Lattner34f349d2009-12-14 06:16:57 +00002530 CurPtr = End;
2531
2532 // Skip ahead to the end of line.
2533 while (CurPtr != BufferEnd && *CurPtr != '\r' && *CurPtr != '\n')
2534 ++CurPtr;
2535
2536 BufferPtr = CurPtr;
2537
2538 // No longer in the conflict marker.
Richard Smithd5e1d602011-10-12 00:37:51 +00002539 CurrentConflictMarkerState = CMK_None;
Chris Lattner34f349d2009-12-14 06:16:57 +00002540 return true;
2541 }
2542
2543 return false;
2544}
2545
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002546bool Lexer::isCodeCompletionPoint(const char *CurPtr) const {
2547 if (PP && PP->isCodeCompletionEnabled()) {
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00002548 SourceLocation Loc = FileLoc.getLocWithOffset(CurPtr-BufferStart);
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002549 return Loc == PP->getCodeCompletionLoc();
2550 }
2551
2552 return false;
2553}
2554
Reid Spencer5f016e22007-07-11 17:01:13 +00002555
2556/// LexTokenInternal - This implements a simple C family lexer. It is an
2557/// extremely performance critical piece of code. This assumes that the buffer
Chris Lattnerefb173d2009-07-07 05:05:42 +00002558/// has a null character at the end of the file. This returns a preprocessing
2559/// token, not a normal token, as such, it is an internal interface. It assumes
2560/// that the Flags of result have been cleared before calling this.
Chris Lattnerd2177732007-07-20 16:59:19 +00002561void Lexer::LexTokenInternal(Token &Result) {
Reid Spencer5f016e22007-07-11 17:01:13 +00002562LexNextToken:
2563 // New token, can't need cleaning yet.
Chris Lattnerd2177732007-07-20 16:59:19 +00002564 Result.clearFlag(Token::NeedsCleaning);
Reid Spencer5f016e22007-07-11 17:01:13 +00002565 Result.setIdentifierInfo(0);
Mike Stump1eb44332009-09-09 15:08:12 +00002566
Reid Spencer5f016e22007-07-11 17:01:13 +00002567 // CurPtr - Cache BufferPtr in an automatic variable.
2568 const char *CurPtr = BufferPtr;
2569
2570 // Small amounts of horizontal whitespace is very common between tokens.
2571 if ((*CurPtr == ' ') || (*CurPtr == '\t')) {
2572 ++CurPtr;
2573 while ((*CurPtr == ' ') || (*CurPtr == '\t'))
2574 ++CurPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002575
Chris Lattnerd88dc482008-10-12 04:05:48 +00002576 // If we are keeping whitespace and other tokens, just return what we just
2577 // skipped. The next lexer invocation will return the token after the
2578 // whitespace.
2579 if (isKeepWhitespaceMode()) {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002580 FormTokenWithChars(Result, CurPtr, tok::unknown);
Chris Lattnerd88dc482008-10-12 04:05:48 +00002581 return;
2582 }
Mike Stump1eb44332009-09-09 15:08:12 +00002583
Reid Spencer5f016e22007-07-11 17:01:13 +00002584 BufferPtr = CurPtr;
Chris Lattnerd2177732007-07-20 16:59:19 +00002585 Result.setFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00002586 }
Mike Stump1eb44332009-09-09 15:08:12 +00002587
Reid Spencer5f016e22007-07-11 17:01:13 +00002588 unsigned SizeTmp, SizeTmp2; // Temporaries for use in cases below.
Mike Stump1eb44332009-09-09 15:08:12 +00002589
Reid Spencer5f016e22007-07-11 17:01:13 +00002590 // Read a character, advancing over it.
2591 char Char = getAndAdvanceChar(CurPtr, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002592 tok::TokenKind Kind;
Mike Stump1eb44332009-09-09 15:08:12 +00002593
Reid Spencer5f016e22007-07-11 17:01:13 +00002594 switch (Char) {
2595 case 0: // Null.
2596 // Found end of file?
2597 if (CurPtr-1 == BufferEnd) {
2598 // Read the PP instance variable into an automatic variable, because
2599 // LexEndOfFile will often delete 'this'.
Chris Lattner168ae2d2007-10-17 20:41:00 +00002600 Preprocessor *PPCache = PP;
Reid Spencer5f016e22007-07-11 17:01:13 +00002601 if (LexEndOfFile(Result, CurPtr-1)) // Retreat back into the file.
2602 return; // Got a token to return.
Chris Lattner168ae2d2007-10-17 20:41:00 +00002603 assert(PPCache && "Raw buffer::LexEndOfFile should return a token");
2604 return PPCache->Lex(Result);
Reid Spencer5f016e22007-07-11 17:01:13 +00002605 }
Mike Stump1eb44332009-09-09 15:08:12 +00002606
Argyrios Kyrtzidis7d100872011-09-04 03:32:15 +00002607 // Check if we are performing code completion.
2608 if (isCodeCompletionPoint(CurPtr-1)) {
2609 // Return the code-completion token.
2610 Result.startToken();
2611 FormTokenWithChars(Result, CurPtr, tok::code_completion);
2612 return;
2613 }
2614
Chris Lattner74d15df2008-11-22 02:02:22 +00002615 if (!isLexingRawMode())
2616 Diag(CurPtr-1, diag::null_in_file);
Chris Lattnerd2177732007-07-20 16:59:19 +00002617 Result.setFlag(Token::LeadingSpace);
Chris Lattnerd88dc482008-10-12 04:05:48 +00002618 if (SkipWhitespace(Result, CurPtr))
2619 return; // KeepWhitespaceMode
Mike Stump1eb44332009-09-09 15:08:12 +00002620
Reid Spencer5f016e22007-07-11 17:01:13 +00002621 goto LexNextToken; // GCC isn't tail call eliminating.
Chris Lattnera2bf1052009-12-17 05:29:40 +00002622
2623 case 26: // DOS & CP/M EOF: "^Z".
2624 // If we're in Microsoft extensions mode, treat this as end of file.
David Blaikie4e4d0842012-03-11 07:00:24 +00002625 if (LangOpts.MicrosoftExt) {
Chris Lattnera2bf1052009-12-17 05:29:40 +00002626 // Read the PP instance variable into an automatic variable, because
2627 // LexEndOfFile will often delete 'this'.
2628 Preprocessor *PPCache = PP;
2629 if (LexEndOfFile(Result, CurPtr-1)) // Retreat back into the file.
2630 return; // Got a token to return.
2631 assert(PPCache && "Raw buffer::LexEndOfFile should return a token");
2632 return PPCache->Lex(Result);
2633 }
2634 // If Microsoft extensions are disabled, this is just random garbage.
2635 Kind = tok::unknown;
2636 break;
2637
Reid Spencer5f016e22007-07-11 17:01:13 +00002638 case '\n':
2639 case '\r':
2640 // If we are inside a preprocessor directive and we see the end of line,
Peter Collingbourne84021552011-02-28 02:37:51 +00002641 // we know we are done with the directive, so return an EOD token.
Reid Spencer5f016e22007-07-11 17:01:13 +00002642 if (ParsingPreprocessorDirective) {
2643 // Done parsing the "line".
2644 ParsingPreprocessorDirective = false;
Mike Stump1eb44332009-09-09 15:08:12 +00002645
Reid Spencer5f016e22007-07-11 17:01:13 +00002646 // Restore comment saving mode, in case it was disabled for directive.
David Blaikie1a835462012-06-15 00:47:13 +00002647 if (PP)
David Blaikie8c0b3782012-06-06 18:52:13 +00002648 SetCommentRetentionState(PP->getCommentRetentionState());
Mike Stump1eb44332009-09-09 15:08:12 +00002649
Reid Spencer5f016e22007-07-11 17:01:13 +00002650 // Since we consumed a newline, we are back at the start of a line.
2651 IsAtStartOfLine = true;
Mike Stump1eb44332009-09-09 15:08:12 +00002652
Peter Collingbourne84021552011-02-28 02:37:51 +00002653 Kind = tok::eod;
Reid Spencer5f016e22007-07-11 17:01:13 +00002654 break;
2655 }
2656 // The returned token is at the start of the line.
Chris Lattnerd2177732007-07-20 16:59:19 +00002657 Result.setFlag(Token::StartOfLine);
Reid Spencer5f016e22007-07-11 17:01:13 +00002658 // No leading whitespace seen so far.
Chris Lattnerd2177732007-07-20 16:59:19 +00002659 Result.clearFlag(Token::LeadingSpace);
Mike Stump1eb44332009-09-09 15:08:12 +00002660
Chris Lattnerd88dc482008-10-12 04:05:48 +00002661 if (SkipWhitespace(Result, CurPtr))
2662 return; // KeepWhitespaceMode
Reid Spencer5f016e22007-07-11 17:01:13 +00002663 goto LexNextToken; // GCC isn't tail call eliminating.
2664 case ' ':
2665 case '\t':
2666 case '\f':
2667 case '\v':
Chris Lattner8133cfc2007-07-22 06:29:05 +00002668 SkipHorizontalWhitespace:
Chris Lattnerd2177732007-07-20 16:59:19 +00002669 Result.setFlag(Token::LeadingSpace);
Chris Lattnerd88dc482008-10-12 04:05:48 +00002670 if (SkipWhitespace(Result, CurPtr))
2671 return; // KeepWhitespaceMode
Chris Lattner8133cfc2007-07-22 06:29:05 +00002672
2673 SkipIgnoredUnits:
2674 CurPtr = BufferPtr;
Mike Stump1eb44332009-09-09 15:08:12 +00002675
Chris Lattner8133cfc2007-07-22 06:29:05 +00002676 // If the next token is obviously a // or /* */ comment, skip it efficiently
2677 // too (without going through the big switch stmt).
Chris Lattner8402c732009-01-16 22:39:25 +00002678 if (CurPtr[0] == '/' && CurPtr[1] == '/' && !inKeepCommentMode() &&
David Blaikie4e4d0842012-03-11 07:00:24 +00002679 LangOpts.BCPLComment && !LangOpts.TraditionalCPP) {
Chris Lattner046c2272010-01-18 22:35:47 +00002680 if (SkipBCPLComment(Result, CurPtr+2))
2681 return; // There is a token to return.
Chris Lattner8133cfc2007-07-22 06:29:05 +00002682 goto SkipIgnoredUnits;
Chris Lattnerfa95a012008-10-12 03:22:02 +00002683 } else if (CurPtr[0] == '/' && CurPtr[1] == '*' && !inKeepCommentMode()) {
Chris Lattner046c2272010-01-18 22:35:47 +00002684 if (SkipBlockComment(Result, CurPtr+2))
2685 return; // There is a token to return.
Chris Lattner8133cfc2007-07-22 06:29:05 +00002686 goto SkipIgnoredUnits;
2687 } else if (isHorizontalWhitespace(*CurPtr)) {
2688 goto SkipHorizontalWhitespace;
2689 }
Reid Spencer5f016e22007-07-11 17:01:13 +00002690 goto LexNextToken; // GCC isn't tail call eliminating.
Chris Lattnera2bf1052009-12-17 05:29:40 +00002691
Chris Lattner3a570772008-01-03 17:58:54 +00002692 // C99 6.4.4.1: Integer Constants.
2693 // C99 6.4.4.2: Floating Constants.
2694 case '0': case '1': case '2': case '3': case '4':
2695 case '5': case '6': case '7': case '8': case '9':
2696 // Notify MIOpt that we read a non-whitespace/non-comment token.
2697 MIOpt.ReadToken();
2698 return LexNumericConstant(Result, CurPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00002699
Douglas Gregor5cee1192011-07-27 05:40:30 +00002700 case 'u': // Identifier (uber) or C++0x UTF-8 or UTF-16 string literal
2701 // Notify MIOpt that we read a non-whitespace/non-comment token.
2702 MIOpt.ReadToken();
2703
David Blaikie4e4d0842012-03-11 07:00:24 +00002704 if (LangOpts.CPlusPlus0x) {
Douglas Gregor5cee1192011-07-27 05:40:30 +00002705 Char = getCharAndSize(CurPtr, SizeTmp);
2706
2707 // UTF-16 string literal
2708 if (Char == '"')
2709 return LexStringLiteral(Result, ConsumeChar(CurPtr, SizeTmp, Result),
2710 tok::utf16_string_literal);
2711
2712 // UTF-16 character constant
2713 if (Char == '\'')
2714 return LexCharConstant(Result, ConsumeChar(CurPtr, SizeTmp, Result),
2715 tok::utf16_char_constant);
2716
Craig Topper2fa4e862011-08-11 04:06:15 +00002717 // UTF-16 raw string literal
2718 if (Char == 'R' && getCharAndSize(CurPtr + SizeTmp, SizeTmp2) == '"')
2719 return LexRawStringLiteral(Result,
2720 ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2721 SizeTmp2, Result),
2722 tok::utf16_string_literal);
2723
2724 if (Char == '8') {
2725 char Char2 = getCharAndSize(CurPtr + SizeTmp, SizeTmp2);
2726
2727 // UTF-8 string literal
2728 if (Char2 == '"')
2729 return LexStringLiteral(Result,
2730 ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2731 SizeTmp2, Result),
2732 tok::utf8_string_literal);
2733
2734 if (Char2 == 'R') {
2735 unsigned SizeTmp3;
2736 char Char3 = getCharAndSize(CurPtr + SizeTmp + SizeTmp2, SizeTmp3);
2737 // UTF-8 raw string literal
2738 if (Char3 == '"') {
2739 return LexRawStringLiteral(Result,
2740 ConsumeChar(ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2741 SizeTmp2, Result),
2742 SizeTmp3, Result),
2743 tok::utf8_string_literal);
2744 }
2745 }
2746 }
Douglas Gregor5cee1192011-07-27 05:40:30 +00002747 }
2748
2749 // treat u like the start of an identifier.
2750 return LexIdentifier(Result, CurPtr);
2751
2752 case 'U': // Identifier (Uber) or C++0x UTF-32 string literal
2753 // Notify MIOpt that we read a non-whitespace/non-comment token.
2754 MIOpt.ReadToken();
2755
David Blaikie4e4d0842012-03-11 07:00:24 +00002756 if (LangOpts.CPlusPlus0x) {
Douglas Gregor5cee1192011-07-27 05:40:30 +00002757 Char = getCharAndSize(CurPtr, SizeTmp);
2758
2759 // UTF-32 string literal
2760 if (Char == '"')
2761 return LexStringLiteral(Result, ConsumeChar(CurPtr, SizeTmp, Result),
2762 tok::utf32_string_literal);
2763
2764 // UTF-32 character constant
2765 if (Char == '\'')
2766 return LexCharConstant(Result, ConsumeChar(CurPtr, SizeTmp, Result),
2767 tok::utf32_char_constant);
Craig Topper2fa4e862011-08-11 04:06:15 +00002768
2769 // UTF-32 raw string literal
2770 if (Char == 'R' && getCharAndSize(CurPtr + SizeTmp, SizeTmp2) == '"')
2771 return LexRawStringLiteral(Result,
2772 ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2773 SizeTmp2, Result),
2774 tok::utf32_string_literal);
Douglas Gregor5cee1192011-07-27 05:40:30 +00002775 }
2776
2777 // treat U like the start of an identifier.
2778 return LexIdentifier(Result, CurPtr);
2779
Craig Topper2fa4e862011-08-11 04:06:15 +00002780 case 'R': // Identifier or C++0x raw string literal
2781 // Notify MIOpt that we read a non-whitespace/non-comment token.
2782 MIOpt.ReadToken();
2783
David Blaikie4e4d0842012-03-11 07:00:24 +00002784 if (LangOpts.CPlusPlus0x) {
Craig Topper2fa4e862011-08-11 04:06:15 +00002785 Char = getCharAndSize(CurPtr, SizeTmp);
2786
2787 if (Char == '"')
2788 return LexRawStringLiteral(Result,
2789 ConsumeChar(CurPtr, SizeTmp, Result),
2790 tok::string_literal);
2791 }
2792
2793 // treat R like the start of an identifier.
2794 return LexIdentifier(Result, CurPtr);
2795
Chris Lattner3a570772008-01-03 17:58:54 +00002796 case 'L': // Identifier (Loony) or wide literal (L'x' or L"xyz").
Reid Spencer5f016e22007-07-11 17:01:13 +00002797 // Notify MIOpt that we read a non-whitespace/non-comment token.
2798 MIOpt.ReadToken();
2799 Char = getCharAndSize(CurPtr, SizeTmp);
2800
2801 // Wide string literal.
2802 if (Char == '"')
2803 return LexStringLiteral(Result, ConsumeChar(CurPtr, SizeTmp, Result),
Douglas Gregor5cee1192011-07-27 05:40:30 +00002804 tok::wide_string_literal);
Reid Spencer5f016e22007-07-11 17:01:13 +00002805
Craig Topper2fa4e862011-08-11 04:06:15 +00002806 // Wide raw string literal.
David Blaikie4e4d0842012-03-11 07:00:24 +00002807 if (LangOpts.CPlusPlus0x && Char == 'R' &&
Craig Topper2fa4e862011-08-11 04:06:15 +00002808 getCharAndSize(CurPtr + SizeTmp, SizeTmp2) == '"')
2809 return LexRawStringLiteral(Result,
2810 ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2811 SizeTmp2, Result),
2812 tok::wide_string_literal);
2813
Reid Spencer5f016e22007-07-11 17:01:13 +00002814 // Wide character constant.
2815 if (Char == '\'')
Douglas Gregor5cee1192011-07-27 05:40:30 +00002816 return LexCharConstant(Result, ConsumeChar(CurPtr, SizeTmp, Result),
2817 tok::wide_char_constant);
Reid Spencer5f016e22007-07-11 17:01:13 +00002818 // FALL THROUGH, treating L like the start of an identifier.
Mike Stump1eb44332009-09-09 15:08:12 +00002819
Reid Spencer5f016e22007-07-11 17:01:13 +00002820 // C99 6.4.2: Identifiers.
2821 case 'A': case 'B': case 'C': case 'D': case 'E': case 'F': case 'G':
2822 case 'H': case 'I': case 'J': case 'K': /*'L'*/case 'M': case 'N':
Craig Topper2fa4e862011-08-11 04:06:15 +00002823 case 'O': case 'P': case 'Q': /*'R'*/case 'S': case 'T': /*'U'*/
Reid Spencer5f016e22007-07-11 17:01:13 +00002824 case 'V': case 'W': case 'X': case 'Y': case 'Z':
2825 case 'a': case 'b': case 'c': case 'd': case 'e': case 'f': case 'g':
2826 case 'h': case 'i': case 'j': case 'k': case 'l': case 'm': case 'n':
Douglas Gregor5cee1192011-07-27 05:40:30 +00002827 case 'o': case 'p': case 'q': case 'r': case 's': case 't': /*'u'*/
Reid Spencer5f016e22007-07-11 17:01:13 +00002828 case 'v': case 'w': case 'x': case 'y': case 'z':
2829 case '_':
2830 // Notify MIOpt that we read a non-whitespace/non-comment token.
2831 MIOpt.ReadToken();
2832 return LexIdentifier(Result, CurPtr);
Chris Lattner3a570772008-01-03 17:58:54 +00002833
2834 case '$': // $ in identifiers.
David Blaikie4e4d0842012-03-11 07:00:24 +00002835 if (LangOpts.DollarIdents) {
Chris Lattner74d15df2008-11-22 02:02:22 +00002836 if (!isLexingRawMode())
2837 Diag(CurPtr-1, diag::ext_dollar_in_identifier);
Chris Lattner3a570772008-01-03 17:58:54 +00002838 // Notify MIOpt that we read a non-whitespace/non-comment token.
2839 MIOpt.ReadToken();
2840 return LexIdentifier(Result, CurPtr);
2841 }
Mike Stump1eb44332009-09-09 15:08:12 +00002842
Chris Lattner9e6293d2008-10-12 04:51:35 +00002843 Kind = tok::unknown;
Chris Lattner3a570772008-01-03 17:58:54 +00002844 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002845
Reid Spencer5f016e22007-07-11 17:01:13 +00002846 // C99 6.4.4: Character Constants.
2847 case '\'':
2848 // Notify MIOpt that we read a non-whitespace/non-comment token.
2849 MIOpt.ReadToken();
Douglas Gregor5cee1192011-07-27 05:40:30 +00002850 return LexCharConstant(Result, CurPtr, tok::char_constant);
Reid Spencer5f016e22007-07-11 17:01:13 +00002851
2852 // C99 6.4.5: String Literals.
2853 case '"':
2854 // Notify MIOpt that we read a non-whitespace/non-comment token.
2855 MIOpt.ReadToken();
Douglas Gregor5cee1192011-07-27 05:40:30 +00002856 return LexStringLiteral(Result, CurPtr, tok::string_literal);
Reid Spencer5f016e22007-07-11 17:01:13 +00002857
2858 // C99 6.4.6: Punctuators.
2859 case '?':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002860 Kind = tok::question;
Reid Spencer5f016e22007-07-11 17:01:13 +00002861 break;
2862 case '[':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002863 Kind = tok::l_square;
Reid Spencer5f016e22007-07-11 17:01:13 +00002864 break;
2865 case ']':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002866 Kind = tok::r_square;
Reid Spencer5f016e22007-07-11 17:01:13 +00002867 break;
2868 case '(':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002869 Kind = tok::l_paren;
Reid Spencer5f016e22007-07-11 17:01:13 +00002870 break;
2871 case ')':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002872 Kind = tok::r_paren;
Reid Spencer5f016e22007-07-11 17:01:13 +00002873 break;
2874 case '{':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002875 Kind = tok::l_brace;
Reid Spencer5f016e22007-07-11 17:01:13 +00002876 break;
2877 case '}':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002878 Kind = tok::r_brace;
Reid Spencer5f016e22007-07-11 17:01:13 +00002879 break;
2880 case '.':
2881 Char = getCharAndSize(CurPtr, SizeTmp);
2882 if (Char >= '0' && Char <= '9') {
2883 // Notify MIOpt that we read a non-whitespace/non-comment token.
2884 MIOpt.ReadToken();
2885
2886 return LexNumericConstant(Result, ConsumeChar(CurPtr, SizeTmp, Result));
David Blaikie4e4d0842012-03-11 07:00:24 +00002887 } else if (LangOpts.CPlusPlus && Char == '*') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002888 Kind = tok::periodstar;
Reid Spencer5f016e22007-07-11 17:01:13 +00002889 CurPtr += SizeTmp;
2890 } else if (Char == '.' &&
2891 getCharAndSize(CurPtr+SizeTmp, SizeTmp2) == '.') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002892 Kind = tok::ellipsis;
Reid Spencer5f016e22007-07-11 17:01:13 +00002893 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2894 SizeTmp2, Result);
2895 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002896 Kind = tok::period;
Reid Spencer5f016e22007-07-11 17:01:13 +00002897 }
2898 break;
2899 case '&':
2900 Char = getCharAndSize(CurPtr, SizeTmp);
2901 if (Char == '&') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002902 Kind = tok::ampamp;
Reid Spencer5f016e22007-07-11 17:01:13 +00002903 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
2904 } else if (Char == '=') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002905 Kind = tok::ampequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002906 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
2907 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002908 Kind = tok::amp;
Reid Spencer5f016e22007-07-11 17:01:13 +00002909 }
2910 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002911 case '*':
Reid Spencer5f016e22007-07-11 17:01:13 +00002912 if (getCharAndSize(CurPtr, SizeTmp) == '=') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002913 Kind = tok::starequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002914 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
2915 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002916 Kind = tok::star;
Reid Spencer5f016e22007-07-11 17:01:13 +00002917 }
2918 break;
2919 case '+':
2920 Char = getCharAndSize(CurPtr, SizeTmp);
2921 if (Char == '+') {
Reid Spencer5f016e22007-07-11 17:01:13 +00002922 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002923 Kind = tok::plusplus;
Reid Spencer5f016e22007-07-11 17:01:13 +00002924 } else if (Char == '=') {
Reid Spencer5f016e22007-07-11 17:01:13 +00002925 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002926 Kind = tok::plusequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002927 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002928 Kind = tok::plus;
Reid Spencer5f016e22007-07-11 17:01:13 +00002929 }
2930 break;
2931 case '-':
2932 Char = getCharAndSize(CurPtr, SizeTmp);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002933 if (Char == '-') { // --
Reid Spencer5f016e22007-07-11 17:01:13 +00002934 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002935 Kind = tok::minusminus;
David Blaikie4e4d0842012-03-11 07:00:24 +00002936 } else if (Char == '>' && LangOpts.CPlusPlus &&
Chris Lattner9e6293d2008-10-12 04:51:35 +00002937 getCharAndSize(CurPtr+SizeTmp, SizeTmp2) == '*') { // C++ ->*
Reid Spencer5f016e22007-07-11 17:01:13 +00002938 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
2939 SizeTmp2, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002940 Kind = tok::arrowstar;
2941 } else if (Char == '>') { // ->
Reid Spencer5f016e22007-07-11 17:01:13 +00002942 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002943 Kind = tok::arrow;
2944 } else if (Char == '=') { // -=
Reid Spencer5f016e22007-07-11 17:01:13 +00002945 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002946 Kind = tok::minusequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002947 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002948 Kind = tok::minus;
Reid Spencer5f016e22007-07-11 17:01:13 +00002949 }
2950 break;
2951 case '~':
Chris Lattner9e6293d2008-10-12 04:51:35 +00002952 Kind = tok::tilde;
Reid Spencer5f016e22007-07-11 17:01:13 +00002953 break;
2954 case '!':
2955 if (getCharAndSize(CurPtr, SizeTmp) == '=') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002956 Kind = tok::exclaimequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002957 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
2958 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002959 Kind = tok::exclaim;
Reid Spencer5f016e22007-07-11 17:01:13 +00002960 }
2961 break;
2962 case '/':
2963 // 6.4.9: Comments
2964 Char = getCharAndSize(CurPtr, SizeTmp);
2965 if (Char == '/') { // BCPL comment.
Chris Lattner8402c732009-01-16 22:39:25 +00002966 // Even if BCPL comments are disabled (e.g. in C89 mode), we generally
2967 // want to lex this as a comment. There is one problem with this though,
2968 // that in one particular corner case, this can change the behavior of the
2969 // resultant program. For example, In "foo //**/ bar", C89 would lex
2970 // this as "foo / bar" and langauges with BCPL comments would lex it as
2971 // "foo". Check to see if the character after the second slash is a '*'.
2972 // If so, we will lex that as a "/" instead of the start of a comment.
Daniel Dunbar2ed42282011-03-18 21:23:38 +00002973 // However, we never do this in -traditional-cpp mode.
David Blaikie4e4d0842012-03-11 07:00:24 +00002974 if ((LangOpts.BCPLComment ||
Daniel Dunbar2ed42282011-03-18 21:23:38 +00002975 getCharAndSize(CurPtr+SizeTmp, SizeTmp2) != '*') &&
David Blaikie4e4d0842012-03-11 07:00:24 +00002976 !LangOpts.TraditionalCPP) {
Chris Lattner8402c732009-01-16 22:39:25 +00002977 if (SkipBCPLComment(Result, ConsumeChar(CurPtr, SizeTmp, Result)))
Chris Lattner046c2272010-01-18 22:35:47 +00002978 return; // There is a token to return.
Mike Stump1eb44332009-09-09 15:08:12 +00002979
Chris Lattner8402c732009-01-16 22:39:25 +00002980 // It is common for the tokens immediately after a // comment to be
2981 // whitespace (indentation for the next line). Instead of going through
2982 // the big switch, handle it efficiently now.
2983 goto SkipIgnoredUnits;
2984 }
2985 }
Mike Stump1eb44332009-09-09 15:08:12 +00002986
Chris Lattner8402c732009-01-16 22:39:25 +00002987 if (Char == '*') { // /**/ comment.
Reid Spencer5f016e22007-07-11 17:01:13 +00002988 if (SkipBlockComment(Result, ConsumeChar(CurPtr, SizeTmp, Result)))
Chris Lattner046c2272010-01-18 22:35:47 +00002989 return; // There is a token to return.
Chris Lattner2d381892008-10-12 04:15:42 +00002990 goto LexNextToken; // GCC isn't tail call eliminating.
Chris Lattner8402c732009-01-16 22:39:25 +00002991 }
Mike Stump1eb44332009-09-09 15:08:12 +00002992
Chris Lattner8402c732009-01-16 22:39:25 +00002993 if (Char == '=') {
Reid Spencer5f016e22007-07-11 17:01:13 +00002994 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00002995 Kind = tok::slashequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00002996 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00002997 Kind = tok::slash;
Reid Spencer5f016e22007-07-11 17:01:13 +00002998 }
2999 break;
3000 case '%':
3001 Char = getCharAndSize(CurPtr, SizeTmp);
3002 if (Char == '=') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003003 Kind = tok::percentequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003004 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
David Blaikie4e4d0842012-03-11 07:00:24 +00003005 } else if (LangOpts.Digraphs && Char == '>') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003006 Kind = tok::r_brace; // '%>' -> '}'
Reid Spencer5f016e22007-07-11 17:01:13 +00003007 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
David Blaikie4e4d0842012-03-11 07:00:24 +00003008 } else if (LangOpts.Digraphs && Char == ':') {
Reid Spencer5f016e22007-07-11 17:01:13 +00003009 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3010 Char = getCharAndSize(CurPtr, SizeTmp);
3011 if (Char == '%' && getCharAndSize(CurPtr+SizeTmp, SizeTmp2) == ':') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003012 Kind = tok::hashhash; // '%:%:' -> '##'
Reid Spencer5f016e22007-07-11 17:01:13 +00003013 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
3014 SizeTmp2, Result);
David Blaikie4e4d0842012-03-11 07:00:24 +00003015 } else if (Char == '@' && LangOpts.MicrosoftExt) {// %:@ -> #@ -> Charize
Reid Spencer5f016e22007-07-11 17:01:13 +00003016 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner74d15df2008-11-22 02:02:22 +00003017 if (!isLexingRawMode())
Ted Kremenek66d5ce12011-10-17 21:47:53 +00003018 Diag(BufferPtr, diag::ext_charize_microsoft);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003019 Kind = tok::hashat;
Chris Lattnere91e9322009-03-18 20:58:27 +00003020 } else { // '%:' -> '#'
Reid Spencer5f016e22007-07-11 17:01:13 +00003021 // We parsed a # character. If this occurs at the start of the line,
3022 // it's actually the start of a preprocessing directive. Callback to
3023 // the preprocessor to handle it.
3024 // FIXME: -fpreprocessed mode??
Chris Lattner766703b2009-05-13 06:10:29 +00003025 if (Result.isAtStartOfLine() && !LexingRawMode && !Is_PragmaLexer) {
Chris Lattnere91e9322009-03-18 20:58:27 +00003026 FormTokenWithChars(Result, CurPtr, tok::hash);
Chris Lattner168ae2d2007-10-17 20:41:00 +00003027 PP->HandleDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +00003028
Reid Spencer5f016e22007-07-11 17:01:13 +00003029 // As an optimization, if the preprocessor didn't switch lexers, tail
3030 // recurse.
Chris Lattner168ae2d2007-10-17 20:41:00 +00003031 if (PP->isCurrentLexer(this)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00003032 // Start a new token. If this is a #include or something, the PP may
3033 // want us starting at the beginning of the line again. If so, set
Chris Lattner515f43f2010-04-12 23:04:41 +00003034 // the StartOfLine flag and clear LeadingSpace.
Reid Spencer5f016e22007-07-11 17:01:13 +00003035 if (IsAtStartOfLine) {
Chris Lattnerd2177732007-07-20 16:59:19 +00003036 Result.setFlag(Token::StartOfLine);
Chris Lattner515f43f2010-04-12 23:04:41 +00003037 Result.clearFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00003038 IsAtStartOfLine = false;
3039 }
3040 goto LexNextToken; // GCC isn't tail call eliminating.
3041 }
Mike Stump1eb44332009-09-09 15:08:12 +00003042
Chris Lattner168ae2d2007-10-17 20:41:00 +00003043 return PP->Lex(Result);
Reid Spencer5f016e22007-07-11 17:01:13 +00003044 }
Mike Stump1eb44332009-09-09 15:08:12 +00003045
Chris Lattnere91e9322009-03-18 20:58:27 +00003046 Kind = tok::hash;
Reid Spencer5f016e22007-07-11 17:01:13 +00003047 }
3048 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003049 Kind = tok::percent;
Reid Spencer5f016e22007-07-11 17:01:13 +00003050 }
3051 break;
3052 case '<':
3053 Char = getCharAndSize(CurPtr, SizeTmp);
3054 if (ParsingFilename) {
Chris Lattner9cb51ce2009-04-17 23:56:52 +00003055 return LexAngledStringLiteral(Result, CurPtr);
Reid Spencer5f016e22007-07-11 17:01:13 +00003056 } else if (Char == '<') {
Chris Lattner34f349d2009-12-14 06:16:57 +00003057 char After = getCharAndSize(CurPtr+SizeTmp, SizeTmp2);
3058 if (After == '=') {
3059 Kind = tok::lesslessequal;
3060 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
3061 SizeTmp2, Result);
3062 } else if (After == '<' && IsStartOfConflictMarker(CurPtr-1)) {
3063 // If this is actually a '<<<<<<<' version control conflict marker,
3064 // recognize it as such and recover nicely.
3065 goto LexNextToken;
Richard Smithd5e1d602011-10-12 00:37:51 +00003066 } else if (After == '<' && HandleEndOfConflictMarker(CurPtr-1)) {
3067 // If this is '<<<<' and we're in a Perforce-style conflict marker,
3068 // ignore it.
3069 goto LexNextToken;
David Blaikie4e4d0842012-03-11 07:00:24 +00003070 } else if (LangOpts.CUDA && After == '<') {
Peter Collingbourne1b791d62011-02-09 21:08:21 +00003071 Kind = tok::lesslessless;
3072 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
3073 SizeTmp2, Result);
Chris Lattner34f349d2009-12-14 06:16:57 +00003074 } else {
3075 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3076 Kind = tok::lessless;
3077 }
Reid Spencer5f016e22007-07-11 17:01:13 +00003078 } else if (Char == '=') {
Reid Spencer5f016e22007-07-11 17:01:13 +00003079 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003080 Kind = tok::lessequal;
David Blaikie4e4d0842012-03-11 07:00:24 +00003081 } else if (LangOpts.Digraphs && Char == ':') { // '<:' -> '['
3082 if (LangOpts.CPlusPlus0x &&
Richard Smith87a1e192011-04-14 18:36:27 +00003083 getCharAndSize(CurPtr + SizeTmp, SizeTmp2) == ':') {
3084 // C++0x [lex.pptoken]p3:
3085 // Otherwise, if the next three characters are <:: and the subsequent
3086 // character is neither : nor >, the < is treated as a preprocessor
3087 // token by itself and not as the first character of the alternative
3088 // token <:.
3089 unsigned SizeTmp3;
3090 char After = getCharAndSize(CurPtr + SizeTmp + SizeTmp2, SizeTmp3);
3091 if (After != ':' && After != '>') {
3092 Kind = tok::less;
Richard Smith661a9962011-10-15 01:18:56 +00003093 if (!isLexingRawMode())
3094 Diag(BufferPtr, diag::warn_cxx98_compat_less_colon_colon);
Richard Smith87a1e192011-04-14 18:36:27 +00003095 break;
3096 }
3097 }
3098
Reid Spencer5f016e22007-07-11 17:01:13 +00003099 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003100 Kind = tok::l_square;
David Blaikie4e4d0842012-03-11 07:00:24 +00003101 } else if (LangOpts.Digraphs && Char == '%') { // '<%' -> '{'
Reid Spencer5f016e22007-07-11 17:01:13 +00003102 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003103 Kind = tok::l_brace;
Reid Spencer5f016e22007-07-11 17:01:13 +00003104 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003105 Kind = tok::less;
Reid Spencer5f016e22007-07-11 17:01:13 +00003106 }
3107 break;
3108 case '>':
3109 Char = getCharAndSize(CurPtr, SizeTmp);
3110 if (Char == '=') {
Reid Spencer5f016e22007-07-11 17:01:13 +00003111 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003112 Kind = tok::greaterequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003113 } else if (Char == '>') {
Chris Lattner34f349d2009-12-14 06:16:57 +00003114 char After = getCharAndSize(CurPtr+SizeTmp, SizeTmp2);
3115 if (After == '=') {
3116 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
3117 SizeTmp2, Result);
3118 Kind = tok::greatergreaterequal;
Richard Smithd5e1d602011-10-12 00:37:51 +00003119 } else if (After == '>' && IsStartOfConflictMarker(CurPtr-1)) {
3120 // If this is actually a '>>>>' conflict marker, recognize it as such
3121 // and recover nicely.
3122 goto LexNextToken;
Chris Lattner34f349d2009-12-14 06:16:57 +00003123 } else if (After == '>' && HandleEndOfConflictMarker(CurPtr-1)) {
3124 // If this is '>>>>>>>' and we're in a conflict marker, ignore it.
3125 goto LexNextToken;
David Blaikie4e4d0842012-03-11 07:00:24 +00003126 } else if (LangOpts.CUDA && After == '>') {
Peter Collingbourne1b791d62011-02-09 21:08:21 +00003127 Kind = tok::greatergreatergreater;
3128 CurPtr = ConsumeChar(ConsumeChar(CurPtr, SizeTmp, Result),
3129 SizeTmp2, Result);
Chris Lattner34f349d2009-12-14 06:16:57 +00003130 } else {
3131 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3132 Kind = tok::greatergreater;
3133 }
3134
Reid Spencer5f016e22007-07-11 17:01:13 +00003135 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003136 Kind = tok::greater;
Reid Spencer5f016e22007-07-11 17:01:13 +00003137 }
3138 break;
3139 case '^':
3140 Char = getCharAndSize(CurPtr, SizeTmp);
3141 if (Char == '=') {
Reid Spencer5f016e22007-07-11 17:01:13 +00003142 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Chris Lattner9e6293d2008-10-12 04:51:35 +00003143 Kind = tok::caretequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003144 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003145 Kind = tok::caret;
Reid Spencer5f016e22007-07-11 17:01:13 +00003146 }
3147 break;
3148 case '|':
3149 Char = getCharAndSize(CurPtr, SizeTmp);
3150 if (Char == '=') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003151 Kind = tok::pipeequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003152 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3153 } else if (Char == '|') {
Chris Lattner34f349d2009-12-14 06:16:57 +00003154 // If this is '|||||||' and we're in a conflict marker, ignore it.
3155 if (CurPtr[1] == '|' && HandleEndOfConflictMarker(CurPtr-1))
3156 goto LexNextToken;
Chris Lattner9e6293d2008-10-12 04:51:35 +00003157 Kind = tok::pipepipe;
Reid Spencer5f016e22007-07-11 17:01:13 +00003158 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3159 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003160 Kind = tok::pipe;
Reid Spencer5f016e22007-07-11 17:01:13 +00003161 }
3162 break;
3163 case ':':
3164 Char = getCharAndSize(CurPtr, SizeTmp);
David Blaikie4e4d0842012-03-11 07:00:24 +00003165 if (LangOpts.Digraphs && Char == '>') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003166 Kind = tok::r_square; // ':>' -> ']'
Reid Spencer5f016e22007-07-11 17:01:13 +00003167 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
David Blaikie4e4d0842012-03-11 07:00:24 +00003168 } else if (LangOpts.CPlusPlus && Char == ':') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003169 Kind = tok::coloncolon;
Reid Spencer5f016e22007-07-11 17:01:13 +00003170 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Mike Stump1eb44332009-09-09 15:08:12 +00003171 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003172 Kind = tok::colon;
Reid Spencer5f016e22007-07-11 17:01:13 +00003173 }
3174 break;
3175 case ';':
Chris Lattner9e6293d2008-10-12 04:51:35 +00003176 Kind = tok::semi;
Reid Spencer5f016e22007-07-11 17:01:13 +00003177 break;
3178 case '=':
3179 Char = getCharAndSize(CurPtr, SizeTmp);
3180 if (Char == '=') {
Richard Smithd5e1d602011-10-12 00:37:51 +00003181 // If this is '====' and we're in a conflict marker, ignore it.
Chris Lattner34f349d2009-12-14 06:16:57 +00003182 if (CurPtr[1] == '=' && HandleEndOfConflictMarker(CurPtr-1))
3183 goto LexNextToken;
3184
Chris Lattner9e6293d2008-10-12 04:51:35 +00003185 Kind = tok::equalequal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003186 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
Mike Stump1eb44332009-09-09 15:08:12 +00003187 } else {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003188 Kind = tok::equal;
Reid Spencer5f016e22007-07-11 17:01:13 +00003189 }
3190 break;
3191 case ',':
Chris Lattner9e6293d2008-10-12 04:51:35 +00003192 Kind = tok::comma;
Reid Spencer5f016e22007-07-11 17:01:13 +00003193 break;
3194 case '#':
3195 Char = getCharAndSize(CurPtr, SizeTmp);
3196 if (Char == '#') {
Chris Lattner9e6293d2008-10-12 04:51:35 +00003197 Kind = tok::hashhash;
Reid Spencer5f016e22007-07-11 17:01:13 +00003198 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
David Blaikie4e4d0842012-03-11 07:00:24 +00003199 } else if (Char == '@' && LangOpts.MicrosoftExt) { // #@ -> Charize
Chris Lattner9e6293d2008-10-12 04:51:35 +00003200 Kind = tok::hashat;
Chris Lattner74d15df2008-11-22 02:02:22 +00003201 if (!isLexingRawMode())
Ted Kremenek66d5ce12011-10-17 21:47:53 +00003202 Diag(BufferPtr, diag::ext_charize_microsoft);
Reid Spencer5f016e22007-07-11 17:01:13 +00003203 CurPtr = ConsumeChar(CurPtr, SizeTmp, Result);
3204 } else {
Reid Spencer5f016e22007-07-11 17:01:13 +00003205 // We parsed a # character. If this occurs at the start of the line,
3206 // it's actually the start of a preprocessing directive. Callback to
3207 // the preprocessor to handle it.
3208 // FIXME: -fpreprocessed mode??
Chris Lattner766703b2009-05-13 06:10:29 +00003209 if (Result.isAtStartOfLine() && !LexingRawMode && !Is_PragmaLexer) {
Chris Lattnere91e9322009-03-18 20:58:27 +00003210 FormTokenWithChars(Result, CurPtr, tok::hash);
Chris Lattner168ae2d2007-10-17 20:41:00 +00003211 PP->HandleDirective(Result);
Mike Stump1eb44332009-09-09 15:08:12 +00003212
Reid Spencer5f016e22007-07-11 17:01:13 +00003213 // As an optimization, if the preprocessor didn't switch lexers, tail
3214 // recurse.
Chris Lattner168ae2d2007-10-17 20:41:00 +00003215 if (PP->isCurrentLexer(this)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00003216 // Start a new token. If this is a #include or something, the PP may
3217 // want us starting at the beginning of the line again. If so, set
Chris Lattner515f43f2010-04-12 23:04:41 +00003218 // the StartOfLine flag and clear LeadingSpace.
Reid Spencer5f016e22007-07-11 17:01:13 +00003219 if (IsAtStartOfLine) {
Chris Lattnerd2177732007-07-20 16:59:19 +00003220 Result.setFlag(Token::StartOfLine);
Chris Lattner515f43f2010-04-12 23:04:41 +00003221 Result.clearFlag(Token::LeadingSpace);
Reid Spencer5f016e22007-07-11 17:01:13 +00003222 IsAtStartOfLine = false;
3223 }
3224 goto LexNextToken; // GCC isn't tail call eliminating.
3225 }
Chris Lattner168ae2d2007-10-17 20:41:00 +00003226 return PP->Lex(Result);
Reid Spencer5f016e22007-07-11 17:01:13 +00003227 }
Mike Stump1eb44332009-09-09 15:08:12 +00003228
Chris Lattnere91e9322009-03-18 20:58:27 +00003229 Kind = tok::hash;
Reid Spencer5f016e22007-07-11 17:01:13 +00003230 }
3231 break;
3232
Chris Lattner3a570772008-01-03 17:58:54 +00003233 case '@':
3234 // Objective C support.
David Blaikie4e4d0842012-03-11 07:00:24 +00003235 if (CurPtr[-1] == '@' && LangOpts.ObjC1)
Chris Lattner9e6293d2008-10-12 04:51:35 +00003236 Kind = tok::at;
Chris Lattner3a570772008-01-03 17:58:54 +00003237 else
Chris Lattner9e6293d2008-10-12 04:51:35 +00003238 Kind = tok::unknown;
Chris Lattner3a570772008-01-03 17:58:54 +00003239 break;
Mike Stump1eb44332009-09-09 15:08:12 +00003240
Reid Spencer5f016e22007-07-11 17:01:13 +00003241 case '\\':
3242 // FIXME: UCN's.
3243 // FALL THROUGH.
3244 default:
Chris Lattner9e6293d2008-10-12 04:51:35 +00003245 Kind = tok::unknown;
Reid Spencer5f016e22007-07-11 17:01:13 +00003246 break;
3247 }
Mike Stump1eb44332009-09-09 15:08:12 +00003248
Reid Spencer5f016e22007-07-11 17:01:13 +00003249 // Notify MIOpt that we read a non-whitespace/non-comment token.
3250 MIOpt.ReadToken();
3251
3252 // Update the location of token as well as BufferPtr.
Chris Lattner9e6293d2008-10-12 04:51:35 +00003253 FormTokenWithChars(Result, CurPtr, Kind);
Reid Spencer5f016e22007-07-11 17:01:13 +00003254}