src/librustc_parse/lexer/mod.rs

   1 use rustc_ast::token::{self, Token, TokenKind};
   2 use rustc_ast::util::comments;
   3 use rustc_data_structures::sync::Lrc;
   4 use rustc_errors::{error_code, Applicability, DiagnosticBuilder, FatalError};
   5 use rustc_lexer::Base;
   6 use rustc_lexer::{unescape, RawStrError};
   7 use rustc_session::parse::ParseSess;
   8 use rustc_span::symbol::{sym, Symbol};
   9 use rustc_span::{BytePos, Pos, Span};
  10
  11 use log::debug;
  12 use std::char;
  13
  14 mod tokentrees;
  15 mod unescape_error_reporting;
  16 mod unicode_chars;
  17
  18 use rustc_lexer::unescape::Mode;
  19 use unescape_error_reporting::{emit_unescape_error, push_escaped_char};
  20
  21 #[derive(Clone, Debug)]
  22 pub struct UnmatchedBrace {
  23     pub expected_delim: token::DelimToken,
  24     pub found_delim: Option<token::DelimToken>,
  25     pub found_span: Span,
  26     pub unclosed_span: Option<Span>,
  27     pub candidate_span: Option<Span>,
  28 }
  29
  30 pub struct StringReader<'a> {
  31     sess: &'a ParseSess,
  32     /// Initial position, read-only.
  33     start_pos: BytePos,
  34     /// The absolute offset within the source_map of the current character.
  35     pos: BytePos,
  36     /// Stop reading src at this index.
  37     end_src_index: usize,
  38     /// Source text to tokenize.
  39     src: Lrc<String>,
  40     override_span: Option<Span>,
  41 }
  42
  43 impl<'a> StringReader<'a> {
  44     pub fn new(
  45         sess: &'a ParseSess,
  46         source_file: Lrc<rustc_span::SourceFile>,
  47         override_span: Option<Span>,
  48     ) -> Self {
  49         // Make sure external source is loaded first, before accessing it.
  50         // While this can't show up during normal parsing, `retokenize` may
  51         // be called with a source file from an external crate.
  52         sess.source_map().ensure_source_file_source_present(Lrc::clone(&source_file));
  53
  54         let src = if let Some(src) = &source_file.src {
  55             Lrc::clone(&src)
  56         } else if let Some(src) = source_file.external_src.borrow().get_source() {
  57             Lrc::clone(&src)
  58         } else {
  59             sess.span_diagnostic
  60                 .bug(&format!("cannot lex `source_file` without source: {}", source_file.name));
  61         };
  62
  63         StringReader {
  64             sess,
  65             start_pos: source_file.start_pos,
  66             pos: source_file.start_pos,
  67             end_src_index: src.len(),
  68             src,
  69             override_span,
  70         }
  71     }
  72
  73     pub fn retokenize(sess: &'a ParseSess, mut span: Span) -> Self {
  74         let begin = sess.source_map().lookup_byte_offset(span.lo());
  75         let end = sess.source_map().lookup_byte_offset(span.hi());
  76
  77         // Make the range zero-length if the span is invalid.
  78         if begin.sf.start_pos != end.sf.start_pos {
  79             span = span.shrink_to_lo();
  80         }
  81
  82         let mut sr = StringReader::new(sess, begin.sf, None);
  83
  84         // Seek the lexer to the right byte range.
  85         sr.end_src_index = sr.src_index(span.hi());
  86
  87         sr
  88     }
  89
  90     fn mk_sp(&self, lo: BytePos, hi: BytePos) -> Span {
  91         self.override_span.unwrap_or_else(|| Span::with_root_ctxt(lo, hi))
  92     }
  93
  94     /// Returns the next token, including trivia like whitespace or comments.
  95     pub fn next_token(&mut self) -> Token {
  96         let start_src_index = self.src_index(self.pos);
  97         let text: &str = &self.src[start_src_index..self.end_src_index];
  98
  99         if text.is_empty() {
 100             let span = self.mk_sp(self.pos, self.pos);
 101             return Token::new(token::Eof, span);
 102         }
 103
 104         {
 105             let is_beginning_of_file = self.pos == self.start_pos;
 106             if is_beginning_of_file {
 107                 if let Some(shebang_len) = rustc_lexer::strip_shebang(text) {
 108                     let start = self.pos;
 109                     self.pos = self.pos + BytePos::from_usize(shebang_len);
 110
 111                     let sym = self.symbol_from(start + BytePos::from_usize("#!".len()));
 112                     let kind = token::Shebang(sym);
 113
 114                     let span = self.mk_sp(start, self.pos);
 115                     return Token::new(kind, span);
 116                 }
 117             }
 118         }
 119
 120         let token = rustc_lexer::first_token(text);
 121
 122         let start = self.pos;
 123         self.pos = self.pos + BytePos::from_usize(token.len);
 124
 125         debug!("try_next_token: {:?}({:?})", token.kind, self.str_from(start));
 126
 127         let kind = self.cook_lexer_token(token.kind, start);
 128         let span = self.mk_sp(start, self.pos);
 129         Token::new(kind, span)
 130     }
 131
 132     /// Report a fatal lexical error with a given span.
 133     fn fatal_span(&self, sp: Span, m: &str) -> FatalError {
 134         self.sess.span_diagnostic.span_fatal(sp, m)
 135     }
 136
 137     /// Report a lexical error with a given span.
 138     fn err_span(&self, sp: Span, m: &str) {
 139         self.sess.span_diagnostic.struct_span_err(sp, m).emit();
 140     }
 141
 142     /// Report a fatal error spanning [`from_pos`, `to_pos`).
 143     fn fatal_span_(&self, from_pos: BytePos, to_pos: BytePos, m: &str) -> FatalError {
 144         self.fatal_span(self.mk_sp(from_pos, to_pos), m)
 145     }
 146
 147     /// Report a lexical error spanning [`from_pos`, `to_pos`).
 148     fn err_span_(&self, from_pos: BytePos, to_pos: BytePos, m: &str) {
 149         self.err_span(self.mk_sp(from_pos, to_pos), m)
 150     }
 151
 152     fn struct_fatal_span_char(
 153         &self,
 154         from_pos: BytePos,
 155         to_pos: BytePos,
 156         m: &str,
 157         c: char,
 158     ) -> DiagnosticBuilder<'a> {
 159         let mut m = m.to_string();
 160         m.push_str(": ");
 161         push_escaped_char(&mut m, c);
 162
 163         self.sess.span_diagnostic.struct_span_fatal(self.mk_sp(from_pos, to_pos), &m[..])
 164     }
 165
 166     /// Turns simple `rustc_lexer::TokenKind` enum into a rich
 167     /// `librustc_ast::TokenKind`. This turns strings into interned
 168     /// symbols and runs additional validation.
 169     fn cook_lexer_token(&self, token: rustc_lexer::TokenKind, start: BytePos) -> TokenKind {
 170         match token {
 171             rustc_lexer::TokenKind::LineComment => {
 172                 let string = self.str_from(start);
 173                 // comments with only more "/"s are not doc comments
 174                 if comments::is_line_doc_comment(string) {
 175                     self.forbid_bare_cr(start, string, "bare CR not allowed in doc-comment");
 176                     token::DocComment(Symbol::intern(string))
 177                 } else {
 178                     token::Comment
 179                 }
 180             }
 181             rustc_lexer::TokenKind::BlockComment { terminated } => {
 182                 let string = self.str_from(start);
 183                 // block comments starting with "/**" or "/*!" are doc-comments
 184                 // but comments with only "*"s between two "/"s are not
 185                 let is_doc_comment = comments::is_block_doc_comment(string);
 186
 187                 if !terminated {
 188                     let msg = if is_doc_comment {
 189                         "unterminated block doc-comment"
 190                     } else {
 191                         "unterminated block comment"
 192                     };
 193                     let last_bpos = self.pos;
 194                     self.sess
 195                         .span_diagnostic
 196                         .struct_span_fatal_with_code(
 197                             self.mk_sp(start, last_bpos),
 198                             msg,
 199                             error_code!(E0758),
 200                         )
 201                         .emit();
 202                     FatalError.raise();
 203                 }
 204
 205                 if is_doc_comment {
 206                     self.forbid_bare_cr(start, string, "bare CR not allowed in block doc-comment");
 207                     token::DocComment(Symbol::intern(string))
 208                 } else {
 209                     token::Comment
 210                 }
 211             }
 212             rustc_lexer::TokenKind::Whitespace => token::Whitespace,
 213             rustc_lexer::TokenKind::Ident | rustc_lexer::TokenKind::RawIdent => {
 214                 let is_raw_ident = token == rustc_lexer::TokenKind::RawIdent;
 215                 let mut ident_start = start;
 216                 if is_raw_ident {
 217                     ident_start = ident_start + BytePos(2);
 218                 }
 219                 let sym = nfc_normalize(self.str_from(ident_start));
 220                 let span = self.mk_sp(start, self.pos);
 221                 self.sess.symbol_gallery.insert(sym, span);
 222                 if is_raw_ident {
 223                     if !sym.can_be_raw() {
 224                         self.err_span(span, &format!("`{}` cannot be a raw identifier", sym));
 225                     }
 226                     self.sess.raw_identifier_spans.borrow_mut().push(span);
 227                 }
 228                 token::Ident(sym, is_raw_ident)
 229             }
 230             rustc_lexer::TokenKind::Literal { kind, suffix_start } => {
 231                 let suffix_start = start + BytePos(suffix_start as u32);
 232                 let (kind, symbol) = self.cook_lexer_literal(start, suffix_start, kind);
 233                 let suffix = if suffix_start < self.pos {
 234                     let string = self.str_from(suffix_start);
 235                     if string == "_" {
 236                         self.sess
 237                             .span_diagnostic
 238                             .struct_span_warn(
 239                                 self.mk_sp(suffix_start, self.pos),
 240                                 "underscore literal suffix is not allowed",
 241                             )
 242                             .warn(
 243                                 "this was previously accepted by the compiler but is \
 244                                    being phased out; it will become a hard error in \
 245                                    a future release!",
 246                             )
 247                             .note(
 248                                 "see issue #42326 \
 249                                  <https://github.com/rust-lang/rust/issues/42326> \
 250                                  for more information",
 251                             )
 252                             .emit();
 253                         None
 254                     } else {
 255                         Some(Symbol::intern(string))
 256                     }
 257                 } else {
 258                     None
 259                 };
 260                 token::Literal(token::Lit { kind, symbol, suffix })
 261             }
 262             rustc_lexer::TokenKind::Lifetime { starts_with_number } => {
 263                 // Include the leading `'` in the real identifier, for macro
 264                 // expansion purposes. See #12512 for the gory details of why
 265                 // this is necessary.
 266                 let lifetime_name = self.str_from(start);
 267                 if starts_with_number {
 268                     self.err_span_(start, self.pos, "lifetimes cannot start with a number");
 269                 }
 270                 let ident = Symbol::intern(lifetime_name);
 271                 token::Lifetime(ident)
 272             }
 273             rustc_lexer::TokenKind::Semi => token::Semi,
 274             rustc_lexer::TokenKind::Comma => token::Comma,
 275             rustc_lexer::TokenKind::Dot => token::Dot,
 276             rustc_lexer::TokenKind::OpenParen => token::OpenDelim(token::Paren),
 277             rustc_lexer::TokenKind::CloseParen => token::CloseDelim(token::Paren),
 278             rustc_lexer::TokenKind::OpenBrace => token::OpenDelim(token::Brace),
 279             rustc_lexer::TokenKind::CloseBrace => token::CloseDelim(token::Brace),
 280             rustc_lexer::TokenKind::OpenBracket => token::OpenDelim(token::Bracket),
 281             rustc_lexer::TokenKind::CloseBracket => token::CloseDelim(token::Bracket),
 282             rustc_lexer::TokenKind::At => token::At,
 283             rustc_lexer::TokenKind::Pound => token::Pound,
 284             rustc_lexer::TokenKind::Tilde => token::Tilde,
 285             rustc_lexer::TokenKind::Question => token::Question,
 286             rustc_lexer::TokenKind::Colon => token::Colon,
 287             rustc_lexer::TokenKind::Dollar => token::Dollar,
 288             rustc_lexer::TokenKind::Eq => token::Eq,
 289             rustc_lexer::TokenKind::Not => token::Not,
 290             rustc_lexer::TokenKind::Lt => token::Lt,
 291             rustc_lexer::TokenKind::Gt => token::Gt,
 292             rustc_lexer::TokenKind::Minus => token::BinOp(token::Minus),
 293             rustc_lexer::TokenKind::And => token::BinOp(token::And),
 294             rustc_lexer::TokenKind::Or => token::BinOp(token::Or),
 295             rustc_lexer::TokenKind::Plus => token::BinOp(token::Plus),
 296             rustc_lexer::TokenKind::Star => token::BinOp(token::Star),
 297             rustc_lexer::TokenKind::Slash => token::BinOp(token::Slash),
 298             rustc_lexer::TokenKind::Caret => token::BinOp(token::Caret),
 299             rustc_lexer::TokenKind::Percent => token::BinOp(token::Percent),
 300
 301             rustc_lexer::TokenKind::Unknown => {
 302                 let c = self.str_from(start).chars().next().unwrap();
 303                 let mut err =
 304                     self.struct_fatal_span_char(start, self.pos, "unknown start of token", c);
 305                 // FIXME: the lexer could be used to turn the ASCII version of unicode homoglyphs,
 306                 // instead of keeping a table in `check_for_substitution`into the token. Ideally,
 307                 // this should be inside `rustc_lexer`. However, we should first remove compound
 308                 // tokens like `<<` from `rustc_lexer`, and then add fancier error recovery to it,
 309                 // as there will be less overall work to do this way.
 310                 let token = unicode_chars::check_for_substitution(self, start, c, &mut err)
 311                     .unwrap_or_else(|| token::Unknown(self.symbol_from(start)));
 312                 err.emit();
 313                 token
 314             }
 315         }
 316     }
 317
 318     fn cook_lexer_literal(
 319         &self,
 320         start: BytePos,
 321         suffix_start: BytePos,
 322         kind: rustc_lexer::LiteralKind,
 323     ) -> (token::LitKind, Symbol) {
 324         // prefix means `"` or `br"` or `r###"`, ...
 325         let (lit_kind, mode, prefix_len, postfix_len) = match kind {
 326             rustc_lexer::LiteralKind::Char { terminated } => {
 327                 if !terminated {
 328                     self.sess
 329                         .span_diagnostic
 330                         .struct_span_fatal_with_code(
 331                             self.mk_sp(start, suffix_start),
 332                             "unterminated character literal",
 333                             error_code!(E0762),
 334                         )
 335                         .emit();
 336                     FatalError.raise();
 337                 }
 338                 (token::Char, Mode::Char, 1, 1) // ' '
 339             }
 340             rustc_lexer::LiteralKind::Byte { terminated } => {
 341                 if !terminated {
 342                     self.sess
 343                         .span_diagnostic
 344                         .struct_span_fatal_with_code(
 345                             self.mk_sp(start + BytePos(1), suffix_start),
 346                             "unterminated byte constant",
 347                             error_code!(E0763),
 348                         )
 349                         .emit();
 350                     FatalError.raise();
 351                 }
 352                 (token::Byte, Mode::Byte, 2, 1) // b' '
 353             }
 354             rustc_lexer::LiteralKind::Str { terminated } => {
 355                 if !terminated {
 356                     self.sess
 357                         .span_diagnostic
 358                         .struct_span_fatal_with_code(
 359                             self.mk_sp(start, suffix_start),
 360                             "unterminated double quote string",
 361                             error_code!(E0765),
 362                         )
 363                         .emit();
 364                     FatalError.raise();
 365                 }
 366                 (token::Str, Mode::Str, 1, 1) // " "
 367             }
 368             rustc_lexer::LiteralKind::ByteStr { terminated } => {
 369                 if !terminated {
 370                     self.sess
 371                         .span_diagnostic
 372                         .struct_span_fatal_with_code(
 373                             self.mk_sp(start + BytePos(1), suffix_start),
 374                             "unterminated double quote byte string",
 375                             error_code!(E0766),
 376                         )
 377                         .emit();
 378                     FatalError.raise();
 379                 }
 380                 (token::ByteStr, Mode::ByteStr, 2, 1) // b" "
 381             }
 382             rustc_lexer::LiteralKind::RawStr { n_hashes, err } => {
 383                 self.report_raw_str_error(start, err);
 384                 let n = u32::from(n_hashes);
 385                 (token::StrRaw(n_hashes), Mode::RawStr, 2 + n, 1 + n) // r##" "##
 386             }
 387             rustc_lexer::LiteralKind::RawByteStr { n_hashes, err } => {
 388                 self.report_raw_str_error(start, err);
 389                 let n = u32::from(n_hashes);
 390                 (token::ByteStrRaw(n_hashes), Mode::RawByteStr, 3 + n, 1 + n) // br##" "##
 391             }
 392             rustc_lexer::LiteralKind::Int { base, empty_int } => {
 393                 return if empty_int {
 394                     self.sess
 395                         .span_diagnostic
 396                         .struct_span_err_with_code(
 397                             self.mk_sp(start, suffix_start),
 398                             "no valid digits found for number",
 399                             error_code!(E0768),
 400                         )
 401                         .emit();
 402                     (token::Integer, sym::integer(0))
 403                 } else {
 404                     self.validate_int_literal(base, start, suffix_start);
 405                     (token::Integer, self.symbol_from_to(start, suffix_start))
 406                 };
 407             }
 408             rustc_lexer::LiteralKind::Float { base, empty_exponent } => {
 409                 if empty_exponent {
 410                     self.err_span_(start, self.pos, "expected at least one digit in exponent");
 411                 }
 412
 413                 match base {
 414                     Base::Hexadecimal => self.err_span_(
 415                         start,
 416                         suffix_start,
 417                         "hexadecimal float literal is not supported",
 418                     ),
 419                     Base::Octal => {
 420                         self.err_span_(start, suffix_start, "octal float literal is not supported")
 421                     }
 422                     Base::Binary => {
 423                         self.err_span_(start, suffix_start, "binary float literal is not supported")
 424                     }
 425                     _ => (),
 426                 }
 427
 428                 let id = self.symbol_from_to(start, suffix_start);
 429                 return (token::Float, id);
 430             }
 431         };
 432         let content_start = start + BytePos(prefix_len);
 433         let content_end = suffix_start - BytePos(postfix_len);
 434         let id = self.symbol_from_to(content_start, content_end);
 435         self.validate_literal_escape(mode, content_start, content_end);
 436         (lit_kind, id)
 437     }
 438
 439     pub fn pos(&self) -> BytePos {
 440         self.pos
 441     }
 442
 443     #[inline]
 444     fn src_index(&self, pos: BytePos) -> usize {
 445         (pos - self.start_pos).to_usize()
 446     }
 447
 448     /// Slice of the source text from `start` up to but excluding `self.pos`,
 449     /// meaning the slice does not include the character `self.ch`.
 450     fn str_from(&self, start: BytePos) -> &str {
 451         self.str_from_to(start, self.pos)
 452     }
 453
 454     /// Creates a Symbol from a given offset to the current offset.
 455     fn symbol_from(&self, start: BytePos) -> Symbol {
 456         debug!("taking an ident from {:?} to {:?}", start, self.pos);
 457         Symbol::intern(self.str_from(start))
 458     }
 459
 460     /// As symbol_from, with an explicit endpoint.
 461     fn symbol_from_to(&self, start: BytePos, end: BytePos) -> Symbol {
 462         debug!("taking an ident from {:?} to {:?}", start, end);
 463         Symbol::intern(self.str_from_to(start, end))
 464     }
 465
 466     /// Slice of the source text spanning from `start` up to but excluding `end`.
 467     fn str_from_to(&self, start: BytePos, end: BytePos) -> &str {
 468         &self.src[self.src_index(start)..self.src_index(end)]
 469     }
 470
 471     fn forbid_bare_cr(&self, start: BytePos, s: &str, errmsg: &str) {
 472         let mut idx = 0;
 473         loop {
 474             idx = match s[idx..].find('\r') {
 475                 None => break,
 476                 Some(it) => idx + it + 1,
 477             };
 478             self.err_span_(start + BytePos(idx as u32 - 1), start + BytePos(idx as u32), errmsg);
 479         }
 480     }
 481
 482     fn report_raw_str_error(&self, start: BytePos, opt_err: Option<RawStrError>) {
 483         match opt_err {
 484             Some(RawStrError::InvalidStarter { bad_char }) => {
 485                 self.report_non_started_raw_string(start, bad_char)
 486             }
 487             Some(RawStrError::NoTerminator { expected, found, possible_terminator_offset }) => self
 488                 .report_unterminated_raw_string(start, expected, possible_terminator_offset, found),
 489             Some(RawStrError::TooManyDelimiters { found }) => {
 490                 self.report_too_many_hashes(start, found)
 491             }
 492             None => (),
 493         }
 494     }
 495
 496     fn report_non_started_raw_string(&self, start: BytePos, bad_char: char) -> ! {
 497         self.struct_fatal_span_char(
 498             start,
 499             self.pos,
 500             "found invalid character; only `#` is allowed in raw string delimitation",
 501             bad_char,
 502         )
 503         .emit();
 504         FatalError.raise()
 505     }
 506
 507     fn report_unterminated_raw_string(
 508         &self,
 509         start: BytePos,
 510         n_hashes: usize,
 511         possible_offset: Option<usize>,
 512         found_terminators: usize,
 513     ) -> ! {
 514         let mut err = self.sess.span_diagnostic.struct_span_fatal_with_code(
 515             self.mk_sp(start, start),
 516             "unterminated raw string",
 517             error_code!(E0748),
 518         );
 519
 520         err.span_label(self.mk_sp(start, start), "unterminated raw string");
 521
 522         if n_hashes > 0 {
 523             err.note(&format!(
 524                 "this raw string should be terminated with `\"{}`",
 525                 "#".repeat(n_hashes)
 526             ));
 527         }
 528
 529         if let Some(possible_offset) = possible_offset {
 530             let lo = start + BytePos(possible_offset as u32);
 531             let hi = lo + BytePos(found_terminators as u32);
 532             let span = self.mk_sp(lo, hi);
 533             err.span_suggestion(
 534                 span,
 535                 "consider terminating the string here",
 536                 "#".repeat(n_hashes),
 537                 Applicability::MaybeIncorrect,
 538             );
 539         }
 540
 541         err.emit();
 542         FatalError.raise()
 543     }
 544
 545     /// Note: It was decided to not add a test case, because it would be to big.
 546     /// https://github.com/rust-lang/rust/pull/50296#issuecomment-392135180
 547     fn report_too_many_hashes(&self, start: BytePos, found: usize) -> ! {
 548         self.fatal_span_(
 549             start,
 550             self.pos,
 551             &format!(
 552                 "too many `#` symbols: raw strings may be delimited \
 553                 by up to 65535 `#` symbols, but found {}",
 554                 found
 555             ),
 556         )
 557         .raise();
 558     }
 559
 560     fn validate_literal_escape(&self, mode: Mode, content_start: BytePos, content_end: BytePos) {
 561         let lit_content = self.str_from_to(content_start, content_end);
 562         unescape::unescape_literal(lit_content, mode, &mut |range, result| {
 563             // Here we only check for errors. The actual unescaping is done later.
 564             if let Err(err) = result {
 565                 let span_with_quotes =
 566                     self.mk_sp(content_start - BytePos(1), content_end + BytePos(1));
 567                 emit_unescape_error(
 568                     &self.sess.span_diagnostic,
 569                     lit_content,
 570                     span_with_quotes,
 571                     mode,
 572                     range,
 573                     err,
 574                 );
 575             }
 576         });
 577     }
 578
 579     fn validate_int_literal(&self, base: Base, content_start: BytePos, content_end: BytePos) {
 580         let base = match base {
 581             Base::Binary => 2,
 582             Base::Octal => 8,
 583             _ => return,
 584         };
 585         let s = self.str_from_to(content_start + BytePos(2), content_end);
 586         for (idx, c) in s.char_indices() {
 587             let idx = idx as u32;
 588             if c != '_' && c.to_digit(base).is_none() {
 589                 let lo = content_start + BytePos(2 + idx);
 590                 let hi = content_start + BytePos(2 + idx + c.len_utf8() as u32);
 591                 self.err_span_(lo, hi, &format!("invalid digit for a base {} literal", base));
 592             }
 593         }
 594     }
 595 }
 596
 597 pub fn nfc_normalize(string: &str) -> Symbol {
 598     use unicode_normalization::{is_nfc_quick, IsNormalized, UnicodeNormalization};
 599     match is_nfc_quick(string.chars()) {
 600         IsNormalized::Yes => Symbol::intern(string),
 601         _ => {
 602             let normalized_str: String = string.chars().nfc().collect();
 603             Symbol::intern(&normalized_str)
 604         }
 605     }
 606 }