1 //===--- LiteralSupport.cpp - Code to parse and process literals ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the NumericLiteralParser, CharLiteralParser, and
11 // StringLiteralParser interfaces.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/Lex/LiteralSupport.h"
16 #include "clang/Basic/CharInfo.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "clang/Lex/LexDiagnostic.h"
19 #include "clang/Lex/Preprocessor.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/Support/ConvertUTF.h"
22 #include "llvm/Support/ErrorHandling.h"
23 
24 using namespace clang;
25 
26 static unsigned getCharWidth(tok::TokenKind kind, const TargetInfo &Target) {
27   switch (kind) {
28   default: llvm_unreachable("Unknown token type!");
29   case tok::char_constant:
30   case tok::string_literal:
31   case tok::utf8_string_literal:
32     return Target.getCharWidth();
33   case tok::wide_char_constant:
34   case tok::wide_string_literal:
35     return Target.getWCharWidth();
36   case tok::utf16_char_constant:
37   case tok::utf16_string_literal:
38     return Target.getChar16Width();
39   case tok::utf32_char_constant:
40   case tok::utf32_string_literal:
41     return Target.getChar32Width();
42   }
43 }
44 
45 static CharSourceRange MakeCharSourceRange(const LangOptions &Features,
46                                            FullSourceLoc TokLoc,
47                                            const char *TokBegin,
48                                            const char *TokRangeBegin,
49                                            const char *TokRangeEnd) {
50   SourceLocation Begin =
51     Lexer::AdvanceToTokenCharacter(TokLoc, TokRangeBegin - TokBegin,
52                                    TokLoc.getManager(), Features);
53   SourceLocation End =
54     Lexer::AdvanceToTokenCharacter(Begin, TokRangeEnd - TokRangeBegin,
55                                    TokLoc.getManager(), Features);
56   return CharSourceRange::getCharRange(Begin, End);
57 }
58 
59 /// \brief Produce a diagnostic highlighting some portion of a literal.
60 ///
61 /// Emits the diagnostic \p DiagID, highlighting the range of characters from
62 /// \p TokRangeBegin (inclusive) to \p TokRangeEnd (exclusive), which must be
63 /// a substring of a spelling buffer for the token beginning at \p TokBegin.
64 static DiagnosticBuilder Diag(DiagnosticsEngine *Diags,
65                               const LangOptions &Features, FullSourceLoc TokLoc,
66                               const char *TokBegin, const char *TokRangeBegin,
67                               const char *TokRangeEnd, unsigned DiagID) {
68   SourceLocation Begin =
69     Lexer::AdvanceToTokenCharacter(TokLoc, TokRangeBegin - TokBegin,
70                                    TokLoc.getManager(), Features);
71   return Diags->Report(Begin, DiagID) <<
72     MakeCharSourceRange(Features, TokLoc, TokBegin, TokRangeBegin, TokRangeEnd);
73 }
74 
75 /// ProcessCharEscape - Parse a standard C escape sequence, which can occur in
76 /// either a character or a string literal.
77 static unsigned ProcessCharEscape(const char *ThisTokBegin,
78                                   const char *&ThisTokBuf,
79                                   const char *ThisTokEnd, bool &HadError,
80                                   FullSourceLoc Loc, unsigned CharWidth,
81                                   DiagnosticsEngine *Diags,
82                                   const LangOptions &Features) {
83   const char *EscapeBegin = ThisTokBuf;
84 
85   // Skip the '\' char.
86   ++ThisTokBuf;
87 
88   // We know that this character can't be off the end of the buffer, because
89   // that would have been \", which would not have been the end of string.
90   unsigned ResultChar = *ThisTokBuf++;
91   switch (ResultChar) {
92   // These map to themselves.
93   case '\\': case '\'': case '"': case '?': break;
94 
95     // These have fixed mappings.
96   case 'a':
97     // TODO: K&R: the meaning of '\\a' is different in traditional C
98     ResultChar = 7;
99     break;
100   case 'b':
101     ResultChar = 8;
102     break;
103   case 'e':
104     if (Diags)
105       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
106            diag::ext_nonstandard_escape) << "e";
107     ResultChar = 27;
108     break;
109   case 'E':
110     if (Diags)
111       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
112            diag::ext_nonstandard_escape) << "E";
113     ResultChar = 27;
114     break;
115   case 'f':
116     ResultChar = 12;
117     break;
118   case 'n':
119     ResultChar = 10;
120     break;
121   case 'r':
122     ResultChar = 13;
123     break;
124   case 't':
125     ResultChar = 9;
126     break;
127   case 'v':
128     ResultChar = 11;
129     break;
130   case 'x': { // Hex escape.
131     ResultChar = 0;
132     if (ThisTokBuf == ThisTokEnd || !isHexDigit(*ThisTokBuf)) {
133       if (Diags)
134         Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
135              diag::err_hex_escape_no_digits) << "x";
136       HadError = 1;
137       break;
138     }
139 
140     // Hex escapes are a maximal series of hex digits.
141     bool Overflow = false;
142     for (; ThisTokBuf != ThisTokEnd; ++ThisTokBuf) {
143       int CharVal = llvm::hexDigitValue(ThisTokBuf[0]);
144       if (CharVal == -1) break;
145       // About to shift out a digit?
146       Overflow |= (ResultChar & 0xF0000000) ? true : false;
147       ResultChar <<= 4;
148       ResultChar |= CharVal;
149     }
150 
151     // See if any bits will be truncated when evaluated as a character.
152     if (CharWidth != 32 && (ResultChar >> CharWidth) != 0) {
153       Overflow = true;
154       ResultChar &= ~0U >> (32-CharWidth);
155     }
156 
157     // Check for overflow.
158     if (Overflow && Diags)   // Too many digits to fit in
159       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
160            diag::err_hex_escape_too_large);
161     break;
162   }
163   case '0': case '1': case '2': case '3':
164   case '4': case '5': case '6': case '7': {
165     // Octal escapes.
166     --ThisTokBuf;
167     ResultChar = 0;
168 
169     // Octal escapes are a series of octal digits with maximum length 3.
170     // "\0123" is a two digit sequence equal to "\012" "3".
171     unsigned NumDigits = 0;
172     do {
173       ResultChar <<= 3;
174       ResultChar |= *ThisTokBuf++ - '0';
175       ++NumDigits;
176     } while (ThisTokBuf != ThisTokEnd && NumDigits < 3 &&
177              ThisTokBuf[0] >= '0' && ThisTokBuf[0] <= '7');
178 
179     // Check for overflow.  Reject '\777', but not L'\777'.
180     if (CharWidth != 32 && (ResultChar >> CharWidth) != 0) {
181       if (Diags)
182         Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
183              diag::err_octal_escape_too_large);
184       ResultChar &= ~0U >> (32-CharWidth);
185     }
186     break;
187   }
188 
189     // Otherwise, these are not valid escapes.
190   case '(': case '{': case '[': case '%':
191     // GCC accepts these as extensions.  We warn about them as such though.
192     if (Diags)
193       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
194            diag::ext_nonstandard_escape)
195         << std::string(1, ResultChar);
196     break;
197   default:
198     if (!Diags)
199       break;
200 
201     if (isPrintable(ResultChar))
202       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
203            diag::ext_unknown_escape)
204         << std::string(1, ResultChar);
205     else
206       Diag(Diags, Features, Loc, ThisTokBegin, EscapeBegin, ThisTokBuf,
207            diag::ext_unknown_escape)
208         << "x" + llvm::utohexstr(ResultChar);
209     break;
210   }
211 
212   return ResultChar;
213 }
214 
215 static void appendCodePoint(unsigned Codepoint,
216                             llvm::SmallVectorImpl<char> &Str) {
217   char ResultBuf[4];
218   char *ResultPtr = ResultBuf;
219   bool Res = llvm::ConvertCodePointToUTF8(Codepoint, ResultPtr);
220   (void)Res;
221   assert(Res && "Unexpected conversion failure");
222   Str.append(ResultBuf, ResultPtr);
223 }
224 
225 void clang::expandUCNs(SmallVectorImpl<char> &Buf, StringRef Input) {
226   for (StringRef::iterator I = Input.begin(), E = Input.end(); I != E; ++I) {
227     if (*I != '\\') {
228       Buf.push_back(*I);
229       continue;
230     }
231 
232     ++I;
233     assert(*I == 'u' || *I == 'U');
234 
235     unsigned NumHexDigits;
236     if (*I == 'u')
237       NumHexDigits = 4;
238     else
239       NumHexDigits = 8;
240 
241     assert(I + NumHexDigits <= E);
242 
243     uint32_t CodePoint = 0;
244     for (++I; NumHexDigits != 0; ++I, --NumHexDigits) {
245       unsigned Value = llvm::hexDigitValue(*I);
246       assert(Value != -1U);
247 
248       CodePoint <<= 4;
249       CodePoint += Value;
250     }
251 
252     appendCodePoint(CodePoint, Buf);
253     --I;
254   }
255 }
256 
257 /// ProcessUCNEscape - Read the Universal Character Name, check constraints and
258 /// return the UTF32.
259 static bool ProcessUCNEscape(const char *ThisTokBegin, const char *&ThisTokBuf,
260                              const char *ThisTokEnd,
261                              uint32_t &UcnVal, unsigned short &UcnLen,
262                              FullSourceLoc Loc, DiagnosticsEngine *Diags,
263                              const LangOptions &Features,
264                              bool in_char_string_literal = false) {
265   const char *UcnBegin = ThisTokBuf;
266 
267   // Skip the '\u' char's.
268   ThisTokBuf += 2;
269 
270   if (ThisTokBuf == ThisTokEnd || !isHexDigit(*ThisTokBuf)) {
271     if (Diags)
272       Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
273            diag::err_hex_escape_no_digits) << StringRef(&ThisTokBuf[-1], 1);
274     return false;
275   }
276   UcnLen = (ThisTokBuf[-1] == 'u' ? 4 : 8);
277   unsigned short UcnLenSave = UcnLen;
278   for (; ThisTokBuf != ThisTokEnd && UcnLenSave; ++ThisTokBuf, UcnLenSave--) {
279     int CharVal = llvm::hexDigitValue(ThisTokBuf[0]);
280     if (CharVal == -1) break;
281     UcnVal <<= 4;
282     UcnVal |= CharVal;
283   }
284   // If we didn't consume the proper number of digits, there is a problem.
285   if (UcnLenSave) {
286     if (Diags)
287       Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
288            diag::err_ucn_escape_incomplete);
289     return false;
290   }
291 
292   // Check UCN constraints (C99 6.4.3p2) [C++11 lex.charset p2]
293   if ((0xD800 <= UcnVal && UcnVal <= 0xDFFF) || // surrogate codepoints
294       UcnVal > 0x10FFFF) {                      // maximum legal UTF32 value
295     if (Diags)
296       Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
297            diag::err_ucn_escape_invalid);
298     return false;
299   }
300 
301   // C++11 allows UCNs that refer to control characters and basic source
302   // characters inside character and string literals
303   if (UcnVal < 0xa0 &&
304       (UcnVal != 0x24 && UcnVal != 0x40 && UcnVal != 0x60)) {  // $, @, `
305     bool IsError = (!Features.CPlusPlus11 || !in_char_string_literal);
306     if (Diags) {
307       char BasicSCSChar = UcnVal;
308       if (UcnVal >= 0x20 && UcnVal < 0x7f)
309         Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
310              IsError ? diag::err_ucn_escape_basic_scs :
311                        diag::warn_cxx98_compat_literal_ucn_escape_basic_scs)
312             << StringRef(&BasicSCSChar, 1);
313       else
314         Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
315              IsError ? diag::err_ucn_control_character :
316                        diag::warn_cxx98_compat_literal_ucn_control_character);
317     }
318     if (IsError)
319       return false;
320   }
321 
322   if (!Features.CPlusPlus && !Features.C99 && Diags)
323     Diag(Diags, Features, Loc, ThisTokBegin, UcnBegin, ThisTokBuf,
324          diag::warn_ucn_not_valid_in_c89_literal);
325 
326   return true;
327 }
328 
329 /// MeasureUCNEscape - Determine the number of bytes within the resulting string
330 /// which this UCN will occupy.
331 static int MeasureUCNEscape(const char *ThisTokBegin, const char *&ThisTokBuf,
332                             const char *ThisTokEnd, unsigned CharByteWidth,
333                             const LangOptions &Features, bool &HadError) {
334   // UTF-32: 4 bytes per escape.
335   if (CharByteWidth == 4)
336     return 4;
337 
338   uint32_t UcnVal = 0;
339   unsigned short UcnLen = 0;
340   FullSourceLoc Loc;
341 
342   if (!ProcessUCNEscape(ThisTokBegin, ThisTokBuf, ThisTokEnd, UcnVal,
343                         UcnLen, Loc, nullptr, Features, true)) {
344     HadError = true;
345     return 0;
346   }
347 
348   // UTF-16: 2 bytes for BMP, 4 bytes otherwise.
349   if (CharByteWidth == 2)
350     return UcnVal <= 0xFFFF ? 2 : 4;
351 
352   // UTF-8.
353   if (UcnVal < 0x80)
354     return 1;
355   if (UcnVal < 0x800)
356     return 2;
357   if (UcnVal < 0x10000)
358     return 3;
359   return 4;
360 }
361 
362 /// EncodeUCNEscape - Read the Universal Character Name, check constraints and
363 /// convert the UTF32 to UTF8 or UTF16. This is a subroutine of
364 /// StringLiteralParser. When we decide to implement UCN's for identifiers,
365 /// we will likely rework our support for UCN's.
366 static void EncodeUCNEscape(const char *ThisTokBegin, const char *&ThisTokBuf,
367                             const char *ThisTokEnd,
368                             char *&ResultBuf, bool &HadError,
369                             FullSourceLoc Loc, unsigned CharByteWidth,
370                             DiagnosticsEngine *Diags,
371                             const LangOptions &Features) {
372   typedef uint32_t UTF32;
373   UTF32 UcnVal = 0;
374   unsigned short UcnLen = 0;
375   if (!ProcessUCNEscape(ThisTokBegin, ThisTokBuf, ThisTokEnd, UcnVal, UcnLen,
376                         Loc, Diags, Features, true)) {
377     HadError = true;
378     return;
379   }
380 
381   assert((CharByteWidth == 1 || CharByteWidth == 2 || CharByteWidth == 4) &&
382          "only character widths of 1, 2, or 4 bytes supported");
383 
384   (void)UcnLen;
385   assert((UcnLen== 4 || UcnLen== 8) && "only ucn length of 4 or 8 supported");
386 
387   if (CharByteWidth == 4) {
388     // FIXME: Make the type of the result buffer correct instead of
389     // using reinterpret_cast.
390     UTF32 *ResultPtr = reinterpret_cast<UTF32*>(ResultBuf);
391     *ResultPtr = UcnVal;
392     ResultBuf += 4;
393     return;
394   }
395 
396   if (CharByteWidth == 2) {
397     // FIXME: Make the type of the result buffer correct instead of
398     // using reinterpret_cast.
399     UTF16 *ResultPtr = reinterpret_cast<UTF16*>(ResultBuf);
400 
401     if (UcnVal <= (UTF32)0xFFFF) {
402       *ResultPtr = UcnVal;
403       ResultBuf += 2;
404       return;
405     }
406 
407     // Convert to UTF16.
408     UcnVal -= 0x10000;
409     *ResultPtr     = 0xD800 + (UcnVal >> 10);
410     *(ResultPtr+1) = 0xDC00 + (UcnVal & 0x3FF);
411     ResultBuf += 4;
412     return;
413   }
414 
415   assert(CharByteWidth == 1 && "UTF-8 encoding is only for 1 byte characters");
416 
417   // Now that we've parsed/checked the UCN, we convert from UTF32->UTF8.
418   // The conversion below was inspired by:
419   //   http://www.unicode.org/Public/PROGRAMS/CVTUTF/ConvertUTF.c
420   // First, we determine how many bytes the result will require.
421   typedef uint8_t UTF8;
422 
423   unsigned short bytesToWrite = 0;
424   if (UcnVal < (UTF32)0x80)
425     bytesToWrite = 1;
426   else if (UcnVal < (UTF32)0x800)
427     bytesToWrite = 2;
428   else if (UcnVal < (UTF32)0x10000)
429     bytesToWrite = 3;
430   else
431     bytesToWrite = 4;
432 
433   const unsigned byteMask = 0xBF;
434   const unsigned byteMark = 0x80;
435 
436   // Once the bits are split out into bytes of UTF8, this is a mask OR-ed
437   // into the first byte, depending on how many bytes follow.
438   static const UTF8 firstByteMark[5] = {
439     0x00, 0x00, 0xC0, 0xE0, 0xF0
440   };
441   // Finally, we write the bytes into ResultBuf.
442   ResultBuf += bytesToWrite;
443   switch (bytesToWrite) { // note: everything falls through.
444   case 4: *--ResultBuf = (UTF8)((UcnVal | byteMark) & byteMask); UcnVal >>= 6;
445   case 3: *--ResultBuf = (UTF8)((UcnVal | byteMark) & byteMask); UcnVal >>= 6;
446   case 2: *--ResultBuf = (UTF8)((UcnVal | byteMark) & byteMask); UcnVal >>= 6;
447   case 1: *--ResultBuf = (UTF8) (UcnVal | firstByteMark[bytesToWrite]);
448   }
449   // Update the buffer.
450   ResultBuf += bytesToWrite;
451 }
452 
453 
454 ///       integer-constant: [C99 6.4.4.1]
455 ///         decimal-constant integer-suffix
456 ///         octal-constant integer-suffix
457 ///         hexadecimal-constant integer-suffix
458 ///         binary-literal integer-suffix [GNU, C++1y]
459 ///       user-defined-integer-literal: [C++11 lex.ext]
460 ///         decimal-literal ud-suffix
461 ///         octal-literal ud-suffix
462 ///         hexadecimal-literal ud-suffix
463 ///         binary-literal ud-suffix [GNU, C++1y]
464 ///       decimal-constant:
465 ///         nonzero-digit
466 ///         decimal-constant digit
467 ///       octal-constant:
468 ///         0
469 ///         octal-constant octal-digit
470 ///       hexadecimal-constant:
471 ///         hexadecimal-prefix hexadecimal-digit
472 ///         hexadecimal-constant hexadecimal-digit
473 ///       hexadecimal-prefix: one of
474 ///         0x 0X
475 ///       binary-literal:
476 ///         0b binary-digit
477 ///         0B binary-digit
478 ///         binary-literal binary-digit
479 ///       integer-suffix:
480 ///         unsigned-suffix [long-suffix]
481 ///         unsigned-suffix [long-long-suffix]
482 ///         long-suffix [unsigned-suffix]
483 ///         long-long-suffix [unsigned-sufix]
484 ///       nonzero-digit:
485 ///         1 2 3 4 5 6 7 8 9
486 ///       octal-digit:
487 ///         0 1 2 3 4 5 6 7
488 ///       hexadecimal-digit:
489 ///         0 1 2 3 4 5 6 7 8 9
490 ///         a b c d e f
491 ///         A B C D E F
492 ///       binary-digit:
493 ///         0
494 ///         1
495 ///       unsigned-suffix: one of
496 ///         u U
497 ///       long-suffix: one of
498 ///         l L
499 ///       long-long-suffix: one of
500 ///         ll LL
501 ///
502 ///       floating-constant: [C99 6.4.4.2]
503 ///         TODO: add rules...
504 ///
505 NumericLiteralParser::NumericLiteralParser(StringRef TokSpelling,
506                                            SourceLocation TokLoc,
507                                            Preprocessor &PP)
508   : PP(PP), ThisTokBegin(TokSpelling.begin()), ThisTokEnd(TokSpelling.end()) {
509 
510   // This routine assumes that the range begin/end matches the regex for integer
511   // and FP constants (specifically, the 'pp-number' regex), and assumes that
512   // the byte at "*end" is both valid and not part of the regex.  Because of
513   // this, it doesn't have to check for 'overscan' in various places.
514   assert(!isPreprocessingNumberBody(*ThisTokEnd) && "didn't maximally munch?");
515 
516   s = DigitsBegin = ThisTokBegin;
517   saw_exponent = false;
518   saw_period = false;
519   saw_ud_suffix = false;
520   isLong = false;
521   isUnsigned = false;
522   isLongLong = false;
523   isFloat = false;
524   isImaginary = false;
525   isMicrosoftInteger = false;
526   hadError = false;
527 
528   if (*s == '0') { // parse radix
529     ParseNumberStartingWithZero(TokLoc);
530     if (hadError)
531       return;
532   } else { // the first digit is non-zero
533     radix = 10;
534     s = SkipDigits(s);
535     if (s == ThisTokEnd) {
536       // Done.
537     } else if (isHexDigit(*s) && !(*s == 'e' || *s == 'E')) {
538       PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, s - ThisTokBegin),
539               diag::err_invalid_decimal_digit) << StringRef(s, 1);
540       hadError = true;
541       return;
542     } else if (*s == '.') {
543       checkSeparator(TokLoc, s, CSK_AfterDigits);
544       s++;
545       saw_period = true;
546       checkSeparator(TokLoc, s, CSK_BeforeDigits);
547       s = SkipDigits(s);
548     }
549     if ((*s == 'e' || *s == 'E')) { // exponent
550       checkSeparator(TokLoc, s, CSK_AfterDigits);
551       const char *Exponent = s;
552       s++;
553       saw_exponent = true;
554       if (*s == '+' || *s == '-')  s++; // sign
555       checkSeparator(TokLoc, s, CSK_BeforeDigits);
556       const char *first_non_digit = SkipDigits(s);
557       if (first_non_digit != s) {
558         s = first_non_digit;
559       } else {
560         PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, Exponent - ThisTokBegin),
561                 diag::err_exponent_has_no_digits);
562         hadError = true;
563         return;
564       }
565     }
566   }
567 
568   SuffixBegin = s;
569   checkSeparator(TokLoc, s, CSK_AfterDigits);
570 
571   // Parse the suffix.  At this point we can classify whether we have an FP or
572   // integer constant.
573   bool isFPConstant = isFloatingLiteral();
574   const char *ImaginarySuffixLoc = nullptr;
575 
576   // Loop over all of the characters of the suffix.  If we see something bad,
577   // we break out of the loop.
578   for (; s != ThisTokEnd; ++s) {
579     switch (*s) {
580     case 'f':      // FP Suffix for "float"
581     case 'F':
582       if (!isFPConstant) break;  // Error for integer constant.
583       if (isFloat || isLong) break; // FF, LF invalid.
584       isFloat = true;
585       continue;  // Success.
586     case 'u':
587     case 'U':
588       if (isFPConstant) break;  // Error for floating constant.
589       if (isUnsigned) break;    // Cannot be repeated.
590       isUnsigned = true;
591       continue;  // Success.
592     case 'l':
593     case 'L':
594       if (isLong || isLongLong) break;  // Cannot be repeated.
595       if (isFloat) break;               // LF invalid.
596 
597       // Check for long long.  The L's need to be adjacent and the same case.
598       if (s+1 != ThisTokEnd && s[1] == s[0]) {
599         if (isFPConstant) break;        // long long invalid for floats.
600         isLongLong = true;
601         ++s;  // Eat both of them.
602       } else {
603         isLong = true;
604       }
605       continue;  // Success.
606     case 'i':
607     case 'I':
608       if (PP.getLangOpts().MicrosoftExt) {
609         if (isLong || isLongLong) break;
610 
611         // Allow i8, i16, i32, i64, and i128.
612         if (s + 1 != ThisTokEnd) {
613           switch (s[1]) {
614             case '8':
615               if (isFPConstant) break;
616               s += 2; // i8 suffix
617               isMicrosoftInteger = true;
618               break;
619             case '1':
620               if (isFPConstant) break;
621               if (s + 2 == ThisTokEnd) break;
622               if (s[2] == '6') {
623                 s += 3; // i16 suffix
624                 isMicrosoftInteger = true;
625               }
626               else if (s[2] == '2') {
627                 if (s + 3 == ThisTokEnd) break;
628                 if (s[3] == '8') {
629                   s += 4; // i128 suffix
630                   isMicrosoftInteger = true;
631                 }
632               }
633               break;
634             case '3':
635               if (isFPConstant) break;
636               if (s + 2 == ThisTokEnd) break;
637               if (s[2] == '2') {
638                 s += 3; // i32 suffix
639                 isLong = true;
640                 isMicrosoftInteger = true;
641               }
642               break;
643             case '6':
644               if (isFPConstant) break;
645               if (s + 2 == ThisTokEnd) break;
646               if (s[2] == '4') {
647                 s += 3; // i64 suffix
648                 isLongLong = true;
649                 isMicrosoftInteger = true;
650               }
651               break;
652             default:
653               break;
654           }
655           if (isMicrosoftInteger)
656             break;
657         }
658       }
659       // "i", "if", and "il" are user-defined suffixes in C++1y.
660       if (PP.getLangOpts().CPlusPlus1y && *s == 'i')
661         break;
662       // fall through.
663     case 'j':
664     case 'J':
665       if (isImaginary) break;   // Cannot be repeated.
666       isImaginary = true;
667       ImaginarySuffixLoc = s;
668       continue;  // Success.
669     }
670     // If we reached here, there was an error or a ud-suffix.
671     break;
672   }
673 
674   if (s != ThisTokEnd) {
675     // FIXME: Don't bother expanding UCNs if !tok.hasUCN().
676     expandUCNs(UDSuffixBuf, StringRef(SuffixBegin, ThisTokEnd - SuffixBegin));
677     if (isValidUDSuffix(PP.getLangOpts(), UDSuffixBuf)) {
678       // Any suffix pieces we might have parsed are actually part of the
679       // ud-suffix.
680       isLong = false;
681       isUnsigned = false;
682       isLongLong = false;
683       isFloat = false;
684       isImaginary = false;
685       isMicrosoftInteger = false;
686 
687       saw_ud_suffix = true;
688       return;
689     }
690 
691     // Report an error if there are any.
692     PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, SuffixBegin - ThisTokBegin),
693             isFPConstant ? diag::err_invalid_suffix_float_constant :
694                            diag::err_invalid_suffix_integer_constant)
695       << StringRef(SuffixBegin, ThisTokEnd-SuffixBegin);
696     hadError = true;
697     return;
698   }
699 
700   if (isImaginary) {
701     PP.Diag(PP.AdvanceToTokenCharacter(TokLoc,
702                                        ImaginarySuffixLoc - ThisTokBegin),
703             diag::ext_imaginary_constant);
704   }
705 }
706 
707 /// Determine whether a suffix is a valid ud-suffix. We avoid treating reserved
708 /// suffixes as ud-suffixes, because the diagnostic experience is better if we
709 /// treat it as an invalid suffix.
710 bool NumericLiteralParser::isValidUDSuffix(const LangOptions &LangOpts,
711                                            StringRef Suffix) {
712   if (!LangOpts.CPlusPlus11 || Suffix.empty())
713     return false;
714 
715   // By C++11 [lex.ext]p10, ud-suffixes starting with an '_' are always valid.
716   if (Suffix[0] == '_')
717     return true;
718 
719   // In C++11, there are no library suffixes.
720   if (!LangOpts.CPlusPlus1y)
721     return false;
722 
723   // In C++1y, "s", "h", "min", "ms", "us", and "ns" are used in the library.
724   // Per tweaked N3660, "il", "i", and "if" are also used in the library.
725   return llvm::StringSwitch<bool>(Suffix)
726       .Cases("h", "min", "s", true)
727       .Cases("ms", "us", "ns", true)
728       .Cases("il", "i", "if", true)
729       .Default(false);
730 }
731 
732 void NumericLiteralParser::checkSeparator(SourceLocation TokLoc,
733                                           const char *Pos,
734                                           CheckSeparatorKind IsAfterDigits) {
735   if (IsAfterDigits == CSK_AfterDigits) {
736     if (Pos == ThisTokBegin)
737       return;
738     --Pos;
739   } else if (Pos == ThisTokEnd)
740     return;
741 
742   if (isDigitSeparator(*Pos))
743     PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, Pos - ThisTokBegin),
744             diag::err_digit_separator_not_between_digits)
745       << IsAfterDigits;
746 }
747 
748 /// ParseNumberStartingWithZero - This method is called when the first character
749 /// of the number is found to be a zero.  This means it is either an octal
750 /// number (like '04') or a hex number ('0x123a') a binary number ('0b1010') or
751 /// a floating point number (01239.123e4).  Eat the prefix, determining the
752 /// radix etc.
753 void NumericLiteralParser::ParseNumberStartingWithZero(SourceLocation TokLoc) {
754   assert(s[0] == '0' && "Invalid method call");
755   s++;
756 
757   int c1 = s[0];
758   int c2 = s[1];
759 
760   // Handle a hex number like 0x1234.
761   if ((c1 == 'x' || c1 == 'X') && (isHexDigit(c2) || c2 == '.')) {
762     s++;
763     radix = 16;
764     DigitsBegin = s;
765     s = SkipHexDigits(s);
766     bool noSignificand = (s == DigitsBegin);
767     if (s == ThisTokEnd) {
768       // Done.
769     } else if (*s == '.') {
770       s++;
771       saw_period = true;
772       const char *floatDigitsBegin = s;
773       checkSeparator(TokLoc, s, CSK_BeforeDigits);
774       s = SkipHexDigits(s);
775       noSignificand &= (floatDigitsBegin == s);
776     }
777 
778     if (noSignificand) {
779       PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, s - ThisTokBegin),
780         diag::err_hexconstant_requires_digits);
781       hadError = true;
782       return;
783     }
784 
785     // A binary exponent can appear with or with a '.'. If dotted, the
786     // binary exponent is required.
787     if (*s == 'p' || *s == 'P') {
788       checkSeparator(TokLoc, s, CSK_AfterDigits);
789       const char *Exponent = s;
790       s++;
791       saw_exponent = true;
792       if (*s == '+' || *s == '-')  s++; // sign
793       const char *first_non_digit = SkipDigits(s);
794       if (first_non_digit == s) {
795         PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, Exponent-ThisTokBegin),
796                 diag::err_exponent_has_no_digits);
797         hadError = true;
798         return;
799       }
800       checkSeparator(TokLoc, s, CSK_BeforeDigits);
801       s = first_non_digit;
802 
803       if (!PP.getLangOpts().HexFloats)
804         PP.Diag(TokLoc, diag::ext_hexconstant_invalid);
805     } else if (saw_period) {
806       PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, s-ThisTokBegin),
807               diag::err_hexconstant_requires_exponent);
808       hadError = true;
809     }
810     return;
811   }
812 
813   // Handle simple binary numbers 0b01010
814   if ((c1 == 'b' || c1 == 'B') && (c2 == '0' || c2 == '1')) {
815     // 0b101010 is a C++1y / GCC extension.
816     PP.Diag(TokLoc,
817             PP.getLangOpts().CPlusPlus1y
818               ? diag::warn_cxx11_compat_binary_literal
819               : PP.getLangOpts().CPlusPlus
820                 ? diag::ext_binary_literal_cxx1y
821                 : diag::ext_binary_literal);
822     ++s;
823     radix = 2;
824     DigitsBegin = s;
825     s = SkipBinaryDigits(s);
826     if (s == ThisTokEnd) {
827       // Done.
828     } else if (isHexDigit(*s)) {
829       PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, s-ThisTokBegin),
830               diag::err_invalid_binary_digit) << StringRef(s, 1);
831       hadError = true;
832     }
833     // Other suffixes will be diagnosed by the caller.
834     return;
835   }
836 
837   // For now, the radix is set to 8. If we discover that we have a
838   // floating point constant, the radix will change to 10. Octal floating
839   // point constants are not permitted (only decimal and hexadecimal).
840   radix = 8;
841   DigitsBegin = s;
842   s = SkipOctalDigits(s);
843   if (s == ThisTokEnd)
844     return; // Done, simple octal number like 01234
845 
846   // If we have some other non-octal digit that *is* a decimal digit, see if
847   // this is part of a floating point number like 094.123 or 09e1.
848   if (isDigit(*s)) {
849     const char *EndDecimal = SkipDigits(s);
850     if (EndDecimal[0] == '.' || EndDecimal[0] == 'e' || EndDecimal[0] == 'E') {
851       s = EndDecimal;
852       radix = 10;
853     }
854   }
855 
856   // If we have a hex digit other than 'e' (which denotes a FP exponent) then
857   // the code is using an incorrect base.
858   if (isHexDigit(*s) && *s != 'e' && *s != 'E') {
859     PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, s-ThisTokBegin),
860             diag::err_invalid_octal_digit) << StringRef(s, 1);
861     hadError = true;
862     return;
863   }
864 
865   if (*s == '.') {
866     s++;
867     radix = 10;
868     saw_period = true;
869     checkSeparator(TokLoc, s, CSK_BeforeDigits);
870     s = SkipDigits(s); // Skip suffix.
871   }
872   if (*s == 'e' || *s == 'E') { // exponent
873     checkSeparator(TokLoc, s, CSK_AfterDigits);
874     const char *Exponent = s;
875     s++;
876     radix = 10;
877     saw_exponent = true;
878     if (*s == '+' || *s == '-')  s++; // sign
879     const char *first_non_digit = SkipDigits(s);
880     if (first_non_digit != s) {
881       checkSeparator(TokLoc, s, CSK_BeforeDigits);
882       s = first_non_digit;
883     } else {
884       PP.Diag(PP.AdvanceToTokenCharacter(TokLoc, Exponent-ThisTokBegin),
885               diag::err_exponent_has_no_digits);
886       hadError = true;
887       return;
888     }
889   }
890 }
891 
892 static bool alwaysFitsInto64Bits(unsigned Radix, unsigned NumDigits) {
893   switch (Radix) {
894   case 2:
895     return NumDigits <= 64;
896   case 8:
897     return NumDigits <= 64 / 3; // Digits are groups of 3 bits.
898   case 10:
899     return NumDigits <= 19; // floor(log10(2^64))
900   case 16:
901     return NumDigits <= 64 / 4; // Digits are groups of 4 bits.
902   default:
903     llvm_unreachable("impossible Radix");
904   }
905 }
906 
907 /// GetIntegerValue - Convert this numeric literal value to an APInt that
908 /// matches Val's input width.  If there is an overflow, set Val to the low bits
909 /// of the result and return true.  Otherwise, return false.
910 bool NumericLiteralParser::GetIntegerValue(llvm::APInt &Val) {
911   // Fast path: Compute a conservative bound on the maximum number of
912   // bits per digit in this radix. If we can't possibly overflow a
913   // uint64 based on that bound then do the simple conversion to
914   // integer. This avoids the expensive overflow checking below, and
915   // handles the common cases that matter (small decimal integers and
916   // hex/octal values which don't overflow).
917   const unsigned NumDigits = SuffixBegin - DigitsBegin;
918   if (alwaysFitsInto64Bits(radix, NumDigits)) {
919     uint64_t N = 0;
920     for (const char *Ptr = DigitsBegin; Ptr != SuffixBegin; ++Ptr)
921       if (!isDigitSeparator(*Ptr))
922         N = N * radix + llvm::hexDigitValue(*Ptr);
923 
924     // This will truncate the value to Val's input width. Simply check
925     // for overflow by comparing.
926     Val = N;
927     return Val.getZExtValue() != N;
928   }
929 
930   Val = 0;
931   const char *Ptr = DigitsBegin;
932 
933   llvm::APInt RadixVal(Val.getBitWidth(), radix);
934   llvm::APInt CharVal(Val.getBitWidth(), 0);
935   llvm::APInt OldVal = Val;
936 
937   bool OverflowOccurred = false;
938   while (Ptr < SuffixBegin) {
939     if (isDigitSeparator(*Ptr)) {
940       ++Ptr;
941       continue;
942     }
943 
944     unsigned C = llvm::hexDigitValue(*Ptr++);
945 
946     // If this letter is out of bound for this radix, reject it.
947     assert(C < radix && "NumericLiteralParser ctor should have rejected this");
948 
949     CharVal = C;
950 
951     // Add the digit to the value in the appropriate radix.  If adding in digits
952     // made the value smaller, then this overflowed.
953     OldVal = Val;
954 
955     // Multiply by radix, did overflow occur on the multiply?
956     Val *= RadixVal;
957     OverflowOccurred |= Val.udiv(RadixVal) != OldVal;
958 
959     // Add value, did overflow occur on the value?
960     //   (a + b) ult b  <=> overflow
961     Val += CharVal;
962     OverflowOccurred |= Val.ult(CharVal);
963   }
964   return OverflowOccurred;
965 }
966 
967 llvm::APFloat::opStatus
968 NumericLiteralParser::GetFloatValue(llvm::APFloat &Result) {
969   using llvm::APFloat;
970 
971   unsigned n = std::min(SuffixBegin - ThisTokBegin, ThisTokEnd - ThisTokBegin);
972 
973   llvm::SmallString<16> Buffer;
974   StringRef Str(ThisTokBegin, n);
975   if (Str.find('\'') != StringRef::npos) {
976     Buffer.reserve(n);
977     std::remove_copy_if(Str.begin(), Str.end(), std::back_inserter(Buffer),
978                         &isDigitSeparator);
979     Str = Buffer;
980   }
981 
982   return Result.convertFromString(Str, APFloat::rmNearestTiesToEven);
983 }
984 
985 
986 /// \verbatim
987 ///       user-defined-character-literal: [C++11 lex.ext]
988 ///         character-literal ud-suffix
989 ///       ud-suffix:
990 ///         identifier
991 ///       character-literal: [C++11 lex.ccon]
992 ///         ' c-char-sequence '
993 ///         u' c-char-sequence '
994 ///         U' c-char-sequence '
995 ///         L' c-char-sequence '
996 ///       c-char-sequence:
997 ///         c-char
998 ///         c-char-sequence c-char
999 ///       c-char:
1000 ///         any member of the source character set except the single-quote ',
1001 ///           backslash \, or new-line character
1002 ///         escape-sequence
1003 ///         universal-character-name
1004 ///       escape-sequence:
1005 ///         simple-escape-sequence
1006 ///         octal-escape-sequence
1007 ///         hexadecimal-escape-sequence
1008 ///       simple-escape-sequence:
1009 ///         one of \' \" \? \\ \a \b \f \n \r \t \v
1010 ///       octal-escape-sequence:
1011 ///         \ octal-digit
1012 ///         \ octal-digit octal-digit
1013 ///         \ octal-digit octal-digit octal-digit
1014 ///       hexadecimal-escape-sequence:
1015 ///         \x hexadecimal-digit
1016 ///         hexadecimal-escape-sequence hexadecimal-digit
1017 ///       universal-character-name: [C++11 lex.charset]
1018 ///         \u hex-quad
1019 ///         \U hex-quad hex-quad
1020 ///       hex-quad:
1021 ///         hex-digit hex-digit hex-digit hex-digit
1022 /// \endverbatim
1023 ///
1024 CharLiteralParser::CharLiteralParser(const char *begin, const char *end,
1025                                      SourceLocation Loc, Preprocessor &PP,
1026                                      tok::TokenKind kind) {
1027   // At this point we know that the character matches the regex "(L|u|U)?'.*'".
1028   HadError = false;
1029 
1030   Kind = kind;
1031 
1032   const char *TokBegin = begin;
1033 
1034   // Skip over wide character determinant.
1035   if (Kind != tok::char_constant) {
1036     ++begin;
1037   }
1038 
1039   // Skip over the entry quote.
1040   assert(begin[0] == '\'' && "Invalid token lexed");
1041   ++begin;
1042 
1043   // Remove an optional ud-suffix.
1044   if (end[-1] != '\'') {
1045     const char *UDSuffixEnd = end;
1046     do {
1047       --end;
1048     } while (end[-1] != '\'');
1049     // FIXME: Don't bother with this if !tok.hasUCN().
1050     expandUCNs(UDSuffixBuf, StringRef(end, UDSuffixEnd - end));
1051     UDSuffixOffset = end - TokBegin;
1052   }
1053 
1054   // Trim the ending quote.
1055   assert(end != begin && "Invalid token lexed");
1056   --end;
1057 
1058   // FIXME: The "Value" is an uint64_t so we can handle char literals of
1059   // up to 64-bits.
1060   // FIXME: This extensively assumes that 'char' is 8-bits.
1061   assert(PP.getTargetInfo().getCharWidth() == 8 &&
1062          "Assumes char is 8 bits");
1063   assert(PP.getTargetInfo().getIntWidth() <= 64 &&
1064          (PP.getTargetInfo().getIntWidth() & 7) == 0 &&
1065          "Assumes sizeof(int) on target is <= 64 and a multiple of char");
1066   assert(PP.getTargetInfo().getWCharWidth() <= 64 &&
1067          "Assumes sizeof(wchar) on target is <= 64");
1068 
1069   SmallVector<uint32_t, 4> codepoint_buffer;
1070   codepoint_buffer.resize(end - begin);
1071   uint32_t *buffer_begin = &codepoint_buffer.front();
1072   uint32_t *buffer_end = buffer_begin + codepoint_buffer.size();
1073 
1074   // Unicode escapes representing characters that cannot be correctly
1075   // represented in a single code unit are disallowed in character literals
1076   // by this implementation.
1077   uint32_t largest_character_for_kind;
1078   if (tok::wide_char_constant == Kind) {
1079     largest_character_for_kind =
1080         0xFFFFFFFFu >> (32-PP.getTargetInfo().getWCharWidth());
1081   } else if (tok::utf16_char_constant == Kind) {
1082     largest_character_for_kind = 0xFFFF;
1083   } else if (tok::utf32_char_constant == Kind) {
1084     largest_character_for_kind = 0x10FFFF;
1085   } else {
1086     largest_character_for_kind = 0x7Fu;
1087   }
1088 
1089   while (begin != end) {
1090     // Is this a span of non-escape characters?
1091     if (begin[0] != '\\') {
1092       char const *start = begin;
1093       do {
1094         ++begin;
1095       } while (begin != end && *begin != '\\');
1096 
1097       char const *tmp_in_start = start;
1098       uint32_t *tmp_out_start = buffer_begin;
1099       ConversionResult res =
1100           ConvertUTF8toUTF32(reinterpret_cast<UTF8 const **>(&start),
1101                              reinterpret_cast<UTF8 const *>(begin),
1102                              &buffer_begin, buffer_end, strictConversion);
1103       if (res != conversionOK) {
1104         // If we see bad encoding for unprefixed character literals, warn and
1105         // simply copy the byte values, for compatibility with gcc and
1106         // older versions of clang.
1107         bool NoErrorOnBadEncoding = isAscii();
1108         unsigned Msg = diag::err_bad_character_encoding;
1109         if (NoErrorOnBadEncoding)
1110           Msg = diag::warn_bad_character_encoding;
1111         PP.Diag(Loc, Msg);
1112         if (NoErrorOnBadEncoding) {
1113           start = tmp_in_start;
1114           buffer_begin = tmp_out_start;
1115           for (; start != begin; ++start, ++buffer_begin)
1116             *buffer_begin = static_cast<uint8_t>(*start);
1117         } else {
1118           HadError = true;
1119         }
1120       } else {
1121         for (; tmp_out_start < buffer_begin; ++tmp_out_start) {
1122           if (*tmp_out_start > largest_character_for_kind) {
1123             HadError = true;
1124             PP.Diag(Loc, diag::err_character_too_large);
1125           }
1126         }
1127       }
1128 
1129       continue;
1130     }
1131     // Is this a Universal Character Name escape?
1132     if (begin[1] == 'u' || begin[1] == 'U') {
1133       unsigned short UcnLen = 0;
1134       if (!ProcessUCNEscape(TokBegin, begin, end, *buffer_begin, UcnLen,
1135                             FullSourceLoc(Loc, PP.getSourceManager()),
1136                             &PP.getDiagnostics(), PP.getLangOpts(), true)) {
1137         HadError = true;
1138       } else if (*buffer_begin > largest_character_for_kind) {
1139         HadError = true;
1140         PP.Diag(Loc, diag::err_character_too_large);
1141       }
1142 
1143       ++buffer_begin;
1144       continue;
1145     }
1146     unsigned CharWidth = getCharWidth(Kind, PP.getTargetInfo());
1147     uint64_t result =
1148       ProcessCharEscape(TokBegin, begin, end, HadError,
1149                         FullSourceLoc(Loc,PP.getSourceManager()),
1150                         CharWidth, &PP.getDiagnostics(), PP.getLangOpts());
1151     *buffer_begin++ = result;
1152   }
1153 
1154   unsigned NumCharsSoFar = buffer_begin - &codepoint_buffer.front();
1155 
1156   if (NumCharsSoFar > 1) {
1157     if (isWide())
1158       PP.Diag(Loc, diag::warn_extraneous_char_constant);
1159     else if (isAscii() && NumCharsSoFar == 4)
1160       PP.Diag(Loc, diag::ext_four_char_character_literal);
1161     else if (isAscii())
1162       PP.Diag(Loc, diag::ext_multichar_character_literal);
1163     else
1164       PP.Diag(Loc, diag::err_multichar_utf_character_literal);
1165     IsMultiChar = true;
1166   } else {
1167     IsMultiChar = false;
1168   }
1169 
1170   llvm::APInt LitVal(PP.getTargetInfo().getIntWidth(), 0);
1171 
1172   // Narrow character literals act as though their value is concatenated
1173   // in this implementation, but warn on overflow.
1174   bool multi_char_too_long = false;
1175   if (isAscii() && isMultiChar()) {
1176     LitVal = 0;
1177     for (size_t i = 0; i < NumCharsSoFar; ++i) {
1178       // check for enough leading zeros to shift into
1179       multi_char_too_long |= (LitVal.countLeadingZeros() < 8);
1180       LitVal <<= 8;
1181       LitVal = LitVal + (codepoint_buffer[i] & 0xFF);
1182     }
1183   } else if (NumCharsSoFar > 0) {
1184     // otherwise just take the last character
1185     LitVal = buffer_begin[-1];
1186   }
1187 
1188   if (!HadError && multi_char_too_long) {
1189     PP.Diag(Loc, diag::warn_char_constant_too_large);
1190   }
1191 
1192   // Transfer the value from APInt to uint64_t
1193   Value = LitVal.getZExtValue();
1194 
1195   // If this is a single narrow character, sign extend it (e.g. '\xFF' is "-1")
1196   // if 'char' is signed for this target (C99 6.4.4.4p10).  Note that multiple
1197   // character constants are not sign extended in the this implementation:
1198   // '\xFF\xFF' = 65536 and '\x0\xFF' = 255, which matches GCC.
1199   if (isAscii() && NumCharsSoFar == 1 && (Value & 128) &&
1200       PP.getLangOpts().CharIsSigned)
1201     Value = (signed char)Value;
1202 }
1203 
1204 /// \verbatim
1205 ///       string-literal: [C++0x lex.string]
1206 ///         encoding-prefix " [s-char-sequence] "
1207 ///         encoding-prefix R raw-string
1208 ///       encoding-prefix:
1209 ///         u8
1210 ///         u
1211 ///         U
1212 ///         L
1213 ///       s-char-sequence:
1214 ///         s-char
1215 ///         s-char-sequence s-char
1216 ///       s-char:
1217 ///         any member of the source character set except the double-quote ",
1218 ///           backslash \, or new-line character
1219 ///         escape-sequence
1220 ///         universal-character-name
1221 ///       raw-string:
1222 ///         " d-char-sequence ( r-char-sequence ) d-char-sequence "
1223 ///       r-char-sequence:
1224 ///         r-char
1225 ///         r-char-sequence r-char
1226 ///       r-char:
1227 ///         any member of the source character set, except a right parenthesis )
1228 ///           followed by the initial d-char-sequence (which may be empty)
1229 ///           followed by a double quote ".
1230 ///       d-char-sequence:
1231 ///         d-char
1232 ///         d-char-sequence d-char
1233 ///       d-char:
1234 ///         any member of the basic source character set except:
1235 ///           space, the left parenthesis (, the right parenthesis ),
1236 ///           the backslash \, and the control characters representing horizontal
1237 ///           tab, vertical tab, form feed, and newline.
1238 ///       escape-sequence: [C++0x lex.ccon]
1239 ///         simple-escape-sequence
1240 ///         octal-escape-sequence
1241 ///         hexadecimal-escape-sequence
1242 ///       simple-escape-sequence:
1243 ///         one of \' \" \? \\ \a \b \f \n \r \t \v
1244 ///       octal-escape-sequence:
1245 ///         \ octal-digit
1246 ///         \ octal-digit octal-digit
1247 ///         \ octal-digit octal-digit octal-digit
1248 ///       hexadecimal-escape-sequence:
1249 ///         \x hexadecimal-digit
1250 ///         hexadecimal-escape-sequence hexadecimal-digit
1251 ///       universal-character-name:
1252 ///         \u hex-quad
1253 ///         \U hex-quad hex-quad
1254 ///       hex-quad:
1255 ///         hex-digit hex-digit hex-digit hex-digit
1256 /// \endverbatim
1257 ///
1258 StringLiteralParser::
1259 StringLiteralParser(const Token *StringToks, unsigned NumStringToks,
1260                     Preprocessor &PP, bool Complain)
1261   : SM(PP.getSourceManager()), Features(PP.getLangOpts()),
1262     Target(PP.getTargetInfo()), Diags(Complain ? &PP.getDiagnostics() :nullptr),
1263     MaxTokenLength(0), SizeBound(0), CharByteWidth(0), Kind(tok::unknown),
1264     ResultPtr(ResultBuf.data()), hadError(false), Pascal(false) {
1265   init(StringToks, NumStringToks);
1266 }
1267 
1268 void StringLiteralParser::init(const Token *StringToks, unsigned NumStringToks){
1269   // The literal token may have come from an invalid source location (e.g. due
1270   // to a PCH error), in which case the token length will be 0.
1271   if (NumStringToks == 0 || StringToks[0].getLength() < 2)
1272     return DiagnoseLexingError(SourceLocation());
1273 
1274   // Scan all of the string portions, remember the max individual token length,
1275   // computing a bound on the concatenated string length, and see whether any
1276   // piece is a wide-string.  If any of the string portions is a wide-string
1277   // literal, the result is a wide-string literal [C99 6.4.5p4].
1278   assert(NumStringToks && "expected at least one token");
1279   MaxTokenLength = StringToks[0].getLength();
1280   assert(StringToks[0].getLength() >= 2 && "literal token is invalid!");
1281   SizeBound = StringToks[0].getLength()-2;  // -2 for "".
1282   Kind = StringToks[0].getKind();
1283 
1284   hadError = false;
1285 
1286   // Implement Translation Phase #6: concatenation of string literals
1287   /// (C99 5.1.1.2p1).  The common case is only one string fragment.
1288   for (unsigned i = 1; i != NumStringToks; ++i) {
1289     if (StringToks[i].getLength() < 2)
1290       return DiagnoseLexingError(StringToks[i].getLocation());
1291 
1292     // The string could be shorter than this if it needs cleaning, but this is a
1293     // reasonable bound, which is all we need.
1294     assert(StringToks[i].getLength() >= 2 && "literal token is invalid!");
1295     SizeBound += StringToks[i].getLength()-2;  // -2 for "".
1296 
1297     // Remember maximum string piece length.
1298     if (StringToks[i].getLength() > MaxTokenLength)
1299       MaxTokenLength = StringToks[i].getLength();
1300 
1301     // Remember if we see any wide or utf-8/16/32 strings.
1302     // Also check for illegal concatenations.
1303     if (StringToks[i].isNot(Kind) && StringToks[i].isNot(tok::string_literal)) {
1304       if (isAscii()) {
1305         Kind = StringToks[i].getKind();
1306       } else {
1307         if (Diags)
1308           Diags->Report(StringToks[i].getLocation(),
1309                         diag::err_unsupported_string_concat);
1310         hadError = true;
1311       }
1312     }
1313   }
1314 
1315   // Include space for the null terminator.
1316   ++SizeBound;
1317 
1318   // TODO: K&R warning: "traditional C rejects string constant concatenation"
1319 
1320   // Get the width in bytes of char/wchar_t/char16_t/char32_t
1321   CharByteWidth = getCharWidth(Kind, Target);
1322   assert((CharByteWidth & 7) == 0 && "Assumes character size is byte multiple");
1323   CharByteWidth /= 8;
1324 
1325   // The output buffer size needs to be large enough to hold wide characters.
1326   // This is a worst-case assumption which basically corresponds to L"" "long".
1327   SizeBound *= CharByteWidth;
1328 
1329   // Size the temporary buffer to hold the result string data.
1330   ResultBuf.resize(SizeBound);
1331 
1332   // Likewise, but for each string piece.
1333   SmallString<512> TokenBuf;
1334   TokenBuf.resize(MaxTokenLength);
1335 
1336   // Loop over all the strings, getting their spelling, and expanding them to
1337   // wide strings as appropriate.
1338   ResultPtr = &ResultBuf[0];   // Next byte to fill in.
1339 
1340   Pascal = false;
1341 
1342   SourceLocation UDSuffixTokLoc;
1343 
1344   for (unsigned i = 0, e = NumStringToks; i != e; ++i) {
1345     const char *ThisTokBuf = &TokenBuf[0];
1346     // Get the spelling of the token, which eliminates trigraphs, etc.  We know
1347     // that ThisTokBuf points to a buffer that is big enough for the whole token
1348     // and 'spelled' tokens can only shrink.
1349     bool StringInvalid = false;
1350     unsigned ThisTokLen =
1351       Lexer::getSpelling(StringToks[i], ThisTokBuf, SM, Features,
1352                          &StringInvalid);
1353     if (StringInvalid)
1354       return DiagnoseLexingError(StringToks[i].getLocation());
1355 
1356     const char *ThisTokBegin = ThisTokBuf;
1357     const char *ThisTokEnd = ThisTokBuf+ThisTokLen;
1358 
1359     // Remove an optional ud-suffix.
1360     if (ThisTokEnd[-1] != '"') {
1361       const char *UDSuffixEnd = ThisTokEnd;
1362       do {
1363         --ThisTokEnd;
1364       } while (ThisTokEnd[-1] != '"');
1365 
1366       StringRef UDSuffix(ThisTokEnd, UDSuffixEnd - ThisTokEnd);
1367 
1368       if (UDSuffixBuf.empty()) {
1369         if (StringToks[i].hasUCN())
1370           expandUCNs(UDSuffixBuf, UDSuffix);
1371         else
1372           UDSuffixBuf.assign(UDSuffix);
1373         UDSuffixToken = i;
1374         UDSuffixOffset = ThisTokEnd - ThisTokBuf;
1375         UDSuffixTokLoc = StringToks[i].getLocation();
1376       } else {
1377         SmallString<32> ExpandedUDSuffix;
1378         if (StringToks[i].hasUCN()) {
1379           expandUCNs(ExpandedUDSuffix, UDSuffix);
1380           UDSuffix = ExpandedUDSuffix;
1381         }
1382 
1383         // C++11 [lex.ext]p8: At the end of phase 6, if a string literal is the
1384         // result of a concatenation involving at least one user-defined-string-
1385         // literal, all the participating user-defined-string-literals shall
1386         // have the same ud-suffix.
1387         if (UDSuffixBuf != UDSuffix) {
1388           if (Diags) {
1389             SourceLocation TokLoc = StringToks[i].getLocation();
1390             Diags->Report(TokLoc, diag::err_string_concat_mixed_suffix)
1391               << UDSuffixBuf << UDSuffix
1392               << SourceRange(UDSuffixTokLoc, UDSuffixTokLoc)
1393               << SourceRange(TokLoc, TokLoc);
1394           }
1395           hadError = true;
1396         }
1397       }
1398     }
1399 
1400     // Strip the end quote.
1401     --ThisTokEnd;
1402 
1403     // TODO: Input character set mapping support.
1404 
1405     // Skip marker for wide or unicode strings.
1406     if (ThisTokBuf[0] == 'L' || ThisTokBuf[0] == 'u' || ThisTokBuf[0] == 'U') {
1407       ++ThisTokBuf;
1408       // Skip 8 of u8 marker for utf8 strings.
1409       if (ThisTokBuf[0] == '8')
1410         ++ThisTokBuf;
1411     }
1412 
1413     // Check for raw string
1414     if (ThisTokBuf[0] == 'R') {
1415       ThisTokBuf += 2; // skip R"
1416 
1417       const char *Prefix = ThisTokBuf;
1418       while (ThisTokBuf[0] != '(')
1419         ++ThisTokBuf;
1420       ++ThisTokBuf; // skip '('
1421 
1422       // Remove same number of characters from the end
1423       ThisTokEnd -= ThisTokBuf - Prefix;
1424       assert(ThisTokEnd >= ThisTokBuf && "malformed raw string literal");
1425 
1426       // Copy the string over
1427       if (CopyStringFragment(StringToks[i], ThisTokBegin,
1428                              StringRef(ThisTokBuf, ThisTokEnd - ThisTokBuf)))
1429         hadError = true;
1430     } else {
1431       if (ThisTokBuf[0] != '"') {
1432         // The file may have come from PCH and then changed after loading the
1433         // PCH; Fail gracefully.
1434         return DiagnoseLexingError(StringToks[i].getLocation());
1435       }
1436       ++ThisTokBuf; // skip "
1437 
1438       // Check if this is a pascal string
1439       if (Features.PascalStrings && ThisTokBuf + 1 != ThisTokEnd &&
1440           ThisTokBuf[0] == '\\' && ThisTokBuf[1] == 'p') {
1441 
1442         // If the \p sequence is found in the first token, we have a pascal string
1443         // Otherwise, if we already have a pascal string, ignore the first \p
1444         if (i == 0) {
1445           ++ThisTokBuf;
1446           Pascal = true;
1447         } else if (Pascal)
1448           ThisTokBuf += 2;
1449       }
1450 
1451       while (ThisTokBuf != ThisTokEnd) {
1452         // Is this a span of non-escape characters?
1453         if (ThisTokBuf[0] != '\\') {
1454           const char *InStart = ThisTokBuf;
1455           do {
1456             ++ThisTokBuf;
1457           } while (ThisTokBuf != ThisTokEnd && ThisTokBuf[0] != '\\');
1458 
1459           // Copy the character span over.
1460           if (CopyStringFragment(StringToks[i], ThisTokBegin,
1461                                  StringRef(InStart, ThisTokBuf - InStart)))
1462             hadError = true;
1463           continue;
1464         }
1465         // Is this a Universal Character Name escape?
1466         if (ThisTokBuf[1] == 'u' || ThisTokBuf[1] == 'U') {
1467           EncodeUCNEscape(ThisTokBegin, ThisTokBuf, ThisTokEnd,
1468                           ResultPtr, hadError,
1469                           FullSourceLoc(StringToks[i].getLocation(), SM),
1470                           CharByteWidth, Diags, Features);
1471           continue;
1472         }
1473         // Otherwise, this is a non-UCN escape character.  Process it.
1474         unsigned ResultChar =
1475           ProcessCharEscape(ThisTokBegin, ThisTokBuf, ThisTokEnd, hadError,
1476                             FullSourceLoc(StringToks[i].getLocation(), SM),
1477                             CharByteWidth*8, Diags, Features);
1478 
1479         if (CharByteWidth == 4) {
1480           // FIXME: Make the type of the result buffer correct instead of
1481           // using reinterpret_cast.
1482           UTF32 *ResultWidePtr = reinterpret_cast<UTF32*>(ResultPtr);
1483           *ResultWidePtr = ResultChar;
1484           ResultPtr += 4;
1485         } else if (CharByteWidth == 2) {
1486           // FIXME: Make the type of the result buffer correct instead of
1487           // using reinterpret_cast.
1488           UTF16 *ResultWidePtr = reinterpret_cast<UTF16*>(ResultPtr);
1489           *ResultWidePtr = ResultChar & 0xFFFF;
1490           ResultPtr += 2;
1491         } else {
1492           assert(CharByteWidth == 1 && "Unexpected char width");
1493           *ResultPtr++ = ResultChar & 0xFF;
1494         }
1495       }
1496     }
1497   }
1498 
1499   if (Pascal) {
1500     if (CharByteWidth == 4) {
1501       // FIXME: Make the type of the result buffer correct instead of
1502       // using reinterpret_cast.
1503       UTF32 *ResultWidePtr = reinterpret_cast<UTF32*>(ResultBuf.data());
1504       ResultWidePtr[0] = GetNumStringChars() - 1;
1505     } else if (CharByteWidth == 2) {
1506       // FIXME: Make the type of the result buffer correct instead of
1507       // using reinterpret_cast.
1508       UTF16 *ResultWidePtr = reinterpret_cast<UTF16*>(ResultBuf.data());
1509       ResultWidePtr[0] = GetNumStringChars() - 1;
1510     } else {
1511       assert(CharByteWidth == 1 && "Unexpected char width");
1512       ResultBuf[0] = GetNumStringChars() - 1;
1513     }
1514 
1515     // Verify that pascal strings aren't too large.
1516     if (GetStringLength() > 256) {
1517       if (Diags)
1518         Diags->Report(StringToks[0].getLocation(),
1519                       diag::err_pascal_string_too_long)
1520           << SourceRange(StringToks[0].getLocation(),
1521                          StringToks[NumStringToks-1].getLocation());
1522       hadError = true;
1523       return;
1524     }
1525   } else if (Diags) {
1526     // Complain if this string literal has too many characters.
1527     unsigned MaxChars = Features.CPlusPlus? 65536 : Features.C99 ? 4095 : 509;
1528 
1529     if (GetNumStringChars() > MaxChars)
1530       Diags->Report(StringToks[0].getLocation(),
1531                     diag::ext_string_too_long)
1532         << GetNumStringChars() << MaxChars
1533         << (Features.CPlusPlus ? 2 : Features.C99 ? 1 : 0)
1534         << SourceRange(StringToks[0].getLocation(),
1535                        StringToks[NumStringToks-1].getLocation());
1536   }
1537 }
1538 
1539 static const char *resyncUTF8(const char *Err, const char *End) {
1540   if (Err == End)
1541     return End;
1542   End = Err + std::min<unsigned>(getNumBytesForUTF8(*Err), End-Err);
1543   while (++Err != End && (*Err & 0xC0) == 0x80)
1544     ;
1545   return Err;
1546 }
1547 
1548 /// \brief This function copies from Fragment, which is a sequence of bytes
1549 /// within Tok's contents (which begin at TokBegin) into ResultPtr.
1550 /// Performs widening for multi-byte characters.
1551 bool StringLiteralParser::CopyStringFragment(const Token &Tok,
1552                                              const char *TokBegin,
1553                                              StringRef Fragment) {
1554   const UTF8 *ErrorPtrTmp;
1555   if (ConvertUTF8toWide(CharByteWidth, Fragment, ResultPtr, ErrorPtrTmp))
1556     return false;
1557 
1558   // If we see bad encoding for unprefixed string literals, warn and
1559   // simply copy the byte values, for compatibility with gcc and older
1560   // versions of clang.
1561   bool NoErrorOnBadEncoding = isAscii();
1562   if (NoErrorOnBadEncoding) {
1563     memcpy(ResultPtr, Fragment.data(), Fragment.size());
1564     ResultPtr += Fragment.size();
1565   }
1566 
1567   if (Diags) {
1568     const char *ErrorPtr = reinterpret_cast<const char *>(ErrorPtrTmp);
1569 
1570     FullSourceLoc SourceLoc(Tok.getLocation(), SM);
1571     const DiagnosticBuilder &Builder =
1572       Diag(Diags, Features, SourceLoc, TokBegin,
1573            ErrorPtr, resyncUTF8(ErrorPtr, Fragment.end()),
1574            NoErrorOnBadEncoding ? diag::warn_bad_string_encoding
1575                                 : diag::err_bad_string_encoding);
1576 
1577     const char *NextStart = resyncUTF8(ErrorPtr, Fragment.end());
1578     StringRef NextFragment(NextStart, Fragment.end()-NextStart);
1579 
1580     // Decode into a dummy buffer.
1581     SmallString<512> Dummy;
1582     Dummy.reserve(Fragment.size() * CharByteWidth);
1583     char *Ptr = Dummy.data();
1584 
1585     while (!ConvertUTF8toWide(CharByteWidth, NextFragment, Ptr, ErrorPtrTmp)) {
1586       const char *ErrorPtr = reinterpret_cast<const char *>(ErrorPtrTmp);
1587       NextStart = resyncUTF8(ErrorPtr, Fragment.end());
1588       Builder << MakeCharSourceRange(Features, SourceLoc, TokBegin,
1589                                      ErrorPtr, NextStart);
1590       NextFragment = StringRef(NextStart, Fragment.end()-NextStart);
1591     }
1592   }
1593   return !NoErrorOnBadEncoding;
1594 }
1595 
1596 void StringLiteralParser::DiagnoseLexingError(SourceLocation Loc) {
1597   hadError = true;
1598   if (Diags)
1599     Diags->Report(Loc, diag::err_lexing_string);
1600 }
1601 
1602 /// getOffsetOfStringByte - This function returns the offset of the
1603 /// specified byte of the string data represented by Token.  This handles
1604 /// advancing over escape sequences in the string.
1605 unsigned StringLiteralParser::getOffsetOfStringByte(const Token &Tok,
1606                                                     unsigned ByteNo) const {
1607   // Get the spelling of the token.
1608   SmallString<32> SpellingBuffer;
1609   SpellingBuffer.resize(Tok.getLength());
1610 
1611   bool StringInvalid = false;
1612   const char *SpellingPtr = &SpellingBuffer[0];
1613   unsigned TokLen = Lexer::getSpelling(Tok, SpellingPtr, SM, Features,
1614                                        &StringInvalid);
1615   if (StringInvalid)
1616     return 0;
1617 
1618   const char *SpellingStart = SpellingPtr;
1619   const char *SpellingEnd = SpellingPtr+TokLen;
1620 
1621   // Handle UTF-8 strings just like narrow strings.
1622   if (SpellingPtr[0] == 'u' && SpellingPtr[1] == '8')
1623     SpellingPtr += 2;
1624 
1625   assert(SpellingPtr[0] != 'L' && SpellingPtr[0] != 'u' &&
1626          SpellingPtr[0] != 'U' && "Doesn't handle wide or utf strings yet");
1627 
1628   // For raw string literals, this is easy.
1629   if (SpellingPtr[0] == 'R') {
1630     assert(SpellingPtr[1] == '"' && "Should be a raw string literal!");
1631     // Skip 'R"'.
1632     SpellingPtr += 2;
1633     while (*SpellingPtr != '(') {
1634       ++SpellingPtr;
1635       assert(SpellingPtr < SpellingEnd && "Missing ( for raw string literal");
1636     }
1637     // Skip '('.
1638     ++SpellingPtr;
1639     return SpellingPtr - SpellingStart + ByteNo;
1640   }
1641 
1642   // Skip over the leading quote
1643   assert(SpellingPtr[0] == '"' && "Should be a string literal!");
1644   ++SpellingPtr;
1645 
1646   // Skip over bytes until we find the offset we're looking for.
1647   while (ByteNo) {
1648     assert(SpellingPtr < SpellingEnd && "Didn't find byte offset!");
1649 
1650     // Step over non-escapes simply.
1651     if (*SpellingPtr != '\\') {
1652       ++SpellingPtr;
1653       --ByteNo;
1654       continue;
1655     }
1656 
1657     // Otherwise, this is an escape character.  Advance over it.
1658     bool HadError = false;
1659     if (SpellingPtr[1] == 'u' || SpellingPtr[1] == 'U') {
1660       const char *EscapePtr = SpellingPtr;
1661       unsigned Len = MeasureUCNEscape(SpellingStart, SpellingPtr, SpellingEnd,
1662                                       1, Features, HadError);
1663       if (Len > ByteNo) {
1664         // ByteNo is somewhere within the escape sequence.
1665         SpellingPtr = EscapePtr;
1666         break;
1667       }
1668       ByteNo -= Len;
1669     } else {
1670       ProcessCharEscape(SpellingStart, SpellingPtr, SpellingEnd, HadError,
1671                         FullSourceLoc(Tok.getLocation(), SM),
1672                         CharByteWidth*8, Diags, Features);
1673       --ByteNo;
1674     }
1675     assert(!HadError && "This method isn't valid on erroneous strings");
1676   }
1677 
1678   return SpellingPtr-SpellingStart;
1679 }
1680