1 use rustc_ast::ast::AttrStyle;
2 use rustc_ast::token::{self, CommentKind, Token, TokenKind};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{error_code, Applicability, DiagnosticBuilder, FatalError};
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};
15 mod unescape_error_reporting;
18 use rustc_lexer::{unescape::Mode, DocStyle};
19 use unescape_error_reporting::{emit_unescape_error, push_escaped_char};
21 #[derive(Clone, Debug)]
22 pub struct UnmatchedBrace {
23 pub expected_delim: token::DelimToken,
24 pub found_delim: Option<token::DelimToken>,
26 pub unclosed_span: Option<Span>,
27 pub candidate_span: Option<Span>,
30 pub struct StringReader<'a> {
32 /// Initial position, read-only.
34 /// The absolute offset within the source_map of the current character.
36 /// Stop reading src at this index.
38 /// Source text to tokenize.
40 override_span: Option<Span>,
43 impl<'a> StringReader<'a> {
46 source_file: Lrc<rustc_span::SourceFile>,
47 override_span: Option<Span>,
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));
54 let src = if let Some(src) = &source_file.src {
56 } else if let Some(src) = source_file.external_src.borrow().get_source() {
60 .bug(&format!("cannot lex `source_file` without source: {}", source_file.name));
65 start_pos: source_file.start_pos,
66 pos: source_file.start_pos,
67 end_src_index: src.len(),
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());
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();
82 let mut sr = StringReader::new(sess, begin.sf, None);
84 // Seek the lexer to the right byte range.
85 sr.end_src_index = sr.src_index(span.hi());
90 fn mk_sp(&self, lo: BytePos, hi: BytePos) -> Span {
91 self.override_span.unwrap_or_else(|| Span::with_root_ctxt(lo, hi))
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];
100 let span = self.mk_sp(self.pos, self.pos);
101 return Token::new(token::Eof, span);
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);
111 let sym = self.symbol_from(start + BytePos::from_usize("#!".len()));
112 let kind = token::Shebang(sym);
114 let span = self.mk_sp(start, self.pos);
115 return Token::new(kind, span);
120 let token = rustc_lexer::first_token(text);
122 let start = self.pos;
123 self.pos = self.pos + BytePos::from_usize(token.len);
125 debug!("try_next_token: {:?}({:?})", token.kind, self.str_from(start));
127 let kind = self.cook_lexer_token(token.kind, start);
128 let span = self.mk_sp(start, self.pos);
129 Token::new(kind, span)
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)
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();
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)
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)
152 fn struct_fatal_span_char(
158 ) -> DiagnosticBuilder<'a> {
159 let mut m = m.to_string();
161 push_escaped_char(&mut m, c);
163 self.sess.span_diagnostic.struct_span_fatal(self.mk_sp(from_pos, to_pos), &m[..])
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 {
171 rustc_lexer::TokenKind::LineComment { doc_style } => {
174 // Opening delimiter of the length 3 is not included into the symbol.
175 let content_start = start + BytePos(3);
176 let content = self.str_from(content_start);
178 self.cook_doc_comment(content_start, content, CommentKind::Line, doc_style)
180 None => token::Comment,
183 rustc_lexer::TokenKind::BlockComment { doc_style, terminated } => {
185 let msg = match doc_style {
186 Some(_) => "unterminated block doc-comment",
187 None => "unterminated block comment",
189 let last_bpos = self.pos;
192 .struct_span_fatal_with_code(
193 self.mk_sp(start, last_bpos),
202 // Opening delimiter of the length 3 and closing delimiter of the length 2
203 // are not included into the symbol.
204 let content_start = start + BytePos(3);
205 let content_end = self.pos - BytePos(if terminated { 2 } else { 0 });
206 let content = self.str_from_to(content_start, content_end);
208 self.cook_doc_comment(content_start, content, CommentKind::Block, doc_style)
210 None => token::Comment,
213 rustc_lexer::TokenKind::Whitespace => token::Whitespace,
214 rustc_lexer::TokenKind::Ident | rustc_lexer::TokenKind::RawIdent => {
215 let is_raw_ident = token == rustc_lexer::TokenKind::RawIdent;
216 let mut ident_start = start;
218 ident_start = ident_start + BytePos(2);
220 let sym = nfc_normalize(self.str_from(ident_start));
221 let span = self.mk_sp(start, self.pos);
222 self.sess.symbol_gallery.insert(sym, span);
224 if !sym.can_be_raw() {
225 self.err_span(span, &format!("`{}` cannot be a raw identifier", sym));
227 self.sess.raw_identifier_spans.borrow_mut().push(span);
229 token::Ident(sym, is_raw_ident)
231 rustc_lexer::TokenKind::Literal { kind, suffix_start } => {
232 let suffix_start = start + BytePos(suffix_start as u32);
233 let (kind, symbol) = self.cook_lexer_literal(start, suffix_start, kind);
234 let suffix = if suffix_start < self.pos {
235 let string = self.str_from(suffix_start);
240 self.mk_sp(suffix_start, self.pos),
241 "underscore literal suffix is not allowed",
244 "this was previously accepted by the compiler but is \
245 being phased out; it will become a hard error in \
250 <https://github.com/rust-lang/rust/issues/42326> \
251 for more information",
256 Some(Symbol::intern(string))
261 token::Literal(token::Lit { kind, symbol, suffix })
263 rustc_lexer::TokenKind::Lifetime { starts_with_number } => {
264 // Include the leading `'` in the real identifier, for macro
265 // expansion purposes. See #12512 for the gory details of why
266 // this is necessary.
267 let lifetime_name = self.str_from(start);
268 if starts_with_number {
269 self.err_span_(start, self.pos, "lifetimes cannot start with a number");
271 let ident = Symbol::intern(lifetime_name);
272 token::Lifetime(ident)
274 rustc_lexer::TokenKind::Semi => token::Semi,
275 rustc_lexer::TokenKind::Comma => token::Comma,
276 rustc_lexer::TokenKind::Dot => token::Dot,
277 rustc_lexer::TokenKind::OpenParen => token::OpenDelim(token::Paren),
278 rustc_lexer::TokenKind::CloseParen => token::CloseDelim(token::Paren),
279 rustc_lexer::TokenKind::OpenBrace => token::OpenDelim(token::Brace),
280 rustc_lexer::TokenKind::CloseBrace => token::CloseDelim(token::Brace),
281 rustc_lexer::TokenKind::OpenBracket => token::OpenDelim(token::Bracket),
282 rustc_lexer::TokenKind::CloseBracket => token::CloseDelim(token::Bracket),
283 rustc_lexer::TokenKind::At => token::At,
284 rustc_lexer::TokenKind::Pound => token::Pound,
285 rustc_lexer::TokenKind::Tilde => token::Tilde,
286 rustc_lexer::TokenKind::Question => token::Question,
287 rustc_lexer::TokenKind::Colon => token::Colon,
288 rustc_lexer::TokenKind::Dollar => token::Dollar,
289 rustc_lexer::TokenKind::Eq => token::Eq,
290 rustc_lexer::TokenKind::Bang => token::Not,
291 rustc_lexer::TokenKind::Lt => token::Lt,
292 rustc_lexer::TokenKind::Gt => token::Gt,
293 rustc_lexer::TokenKind::Minus => token::BinOp(token::Minus),
294 rustc_lexer::TokenKind::And => token::BinOp(token::And),
295 rustc_lexer::TokenKind::Or => token::BinOp(token::Or),
296 rustc_lexer::TokenKind::Plus => token::BinOp(token::Plus),
297 rustc_lexer::TokenKind::Star => token::BinOp(token::Star),
298 rustc_lexer::TokenKind::Slash => token::BinOp(token::Slash),
299 rustc_lexer::TokenKind::Caret => token::BinOp(token::Caret),
300 rustc_lexer::TokenKind::Percent => token::BinOp(token::Percent),
302 rustc_lexer::TokenKind::Unknown => {
303 let c = self.str_from(start).chars().next().unwrap();
305 self.struct_fatal_span_char(start, self.pos, "unknown start of token", c);
306 // FIXME: the lexer could be used to turn the ASCII version of unicode homoglyphs,
307 // instead of keeping a table in `check_for_substitution`into the token. Ideally,
308 // this should be inside `rustc_lexer`. However, we should first remove compound
309 // tokens like `<<` from `rustc_lexer`, and then add fancier error recovery to it,
310 // as there will be less overall work to do this way.
311 let token = unicode_chars::check_for_substitution(self, start, c, &mut err)
312 .unwrap_or_else(|| token::Unknown(self.symbol_from(start)));
321 content_start: BytePos,
323 comment_kind: CommentKind,
326 if content.contains('\r') {
327 for (idx, _) in content.char_indices().filter(|&(_, c)| c == '\r') {
329 content_start + BytePos(idx as u32),
330 content_start + BytePos(idx as u32 + 1),
332 CommentKind::Line => "bare CR not allowed in doc-comment",
333 CommentKind::Block => "bare CR not allowed in block doc-comment",
339 let attr_style = match doc_style {
340 DocStyle::Outer => AttrStyle::Outer,
341 DocStyle::Inner => AttrStyle::Inner,
344 token::DocComment(comment_kind, attr_style, Symbol::intern(content))
347 fn cook_lexer_literal(
350 suffix_start: BytePos,
351 kind: rustc_lexer::LiteralKind,
352 ) -> (token::LitKind, Symbol) {
353 // prefix means `"` or `br"` or `r###"`, ...
354 let (lit_kind, mode, prefix_len, postfix_len) = match kind {
355 rustc_lexer::LiteralKind::Char { terminated } => {
359 .struct_span_fatal_with_code(
360 self.mk_sp(start, suffix_start),
361 "unterminated character literal",
367 (token::Char, Mode::Char, 1, 1) // ' '
369 rustc_lexer::LiteralKind::Byte { terminated } => {
373 .struct_span_fatal_with_code(
374 self.mk_sp(start + BytePos(1), suffix_start),
375 "unterminated byte constant",
381 (token::Byte, Mode::Byte, 2, 1) // b' '
383 rustc_lexer::LiteralKind::Str { terminated } => {
387 .struct_span_fatal_with_code(
388 self.mk_sp(start, suffix_start),
389 "unterminated double quote string",
395 (token::Str, Mode::Str, 1, 1) // " "
397 rustc_lexer::LiteralKind::ByteStr { terminated } => {
401 .struct_span_fatal_with_code(
402 self.mk_sp(start + BytePos(1), suffix_start),
403 "unterminated double quote byte string",
409 (token::ByteStr, Mode::ByteStr, 2, 1) // b" "
411 rustc_lexer::LiteralKind::RawStr { n_hashes, err } => {
412 self.report_raw_str_error(start, err);
413 let n = u32::from(n_hashes);
414 (token::StrRaw(n_hashes), Mode::RawStr, 2 + n, 1 + n) // r##" "##
416 rustc_lexer::LiteralKind::RawByteStr { n_hashes, err } => {
417 self.report_raw_str_error(start, err);
418 let n = u32::from(n_hashes);
419 (token::ByteStrRaw(n_hashes), Mode::RawByteStr, 3 + n, 1 + n) // br##" "##
421 rustc_lexer::LiteralKind::Int { base, empty_int } => {
422 return if empty_int {
425 .struct_span_err_with_code(
426 self.mk_sp(start, suffix_start),
427 "no valid digits found for number",
431 (token::Integer, sym::integer(0))
433 self.validate_int_literal(base, start, suffix_start);
434 (token::Integer, self.symbol_from_to(start, suffix_start))
437 rustc_lexer::LiteralKind::Float { base, empty_exponent } => {
439 self.err_span_(start, self.pos, "expected at least one digit in exponent");
443 Base::Hexadecimal => self.err_span_(
446 "hexadecimal float literal is not supported",
449 self.err_span_(start, suffix_start, "octal float literal is not supported")
452 self.err_span_(start, suffix_start, "binary float literal is not supported")
457 let id = self.symbol_from_to(start, suffix_start);
458 return (token::Float, id);
461 let content_start = start + BytePos(prefix_len);
462 let content_end = suffix_start - BytePos(postfix_len);
463 let id = self.symbol_from_to(content_start, content_end);
464 self.validate_literal_escape(mode, content_start, content_end);
468 pub fn pos(&self) -> BytePos {
473 fn src_index(&self, pos: BytePos) -> usize {
474 (pos - self.start_pos).to_usize()
477 /// Slice of the source text from `start` up to but excluding `self.pos`,
478 /// meaning the slice does not include the character `self.ch`.
479 fn str_from(&self, start: BytePos) -> &str {
480 self.str_from_to(start, self.pos)
483 /// Creates a Symbol from a given offset to the current offset.
484 fn symbol_from(&self, start: BytePos) -> Symbol {
485 debug!("taking an ident from {:?} to {:?}", start, self.pos);
486 Symbol::intern(self.str_from(start))
489 /// As symbol_from, with an explicit endpoint.
490 fn symbol_from_to(&self, start: BytePos, end: BytePos) -> Symbol {
491 debug!("taking an ident from {:?} to {:?}", start, end);
492 Symbol::intern(self.str_from_to(start, end))
495 /// Slice of the source text spanning from `start` up to but excluding `end`.
496 fn str_from_to(&self, start: BytePos, end: BytePos) -> &str {
497 &self.src[self.src_index(start)..self.src_index(end)]
500 fn report_raw_str_error(&self, start: BytePos, opt_err: Option<RawStrError>) {
502 Some(RawStrError::InvalidStarter { bad_char }) => {
503 self.report_non_started_raw_string(start, bad_char)
505 Some(RawStrError::NoTerminator { expected, found, possible_terminator_offset }) => self
506 .report_unterminated_raw_string(start, expected, possible_terminator_offset, found),
507 Some(RawStrError::TooManyDelimiters { found }) => {
508 self.report_too_many_hashes(start, found)
514 fn report_non_started_raw_string(&self, start: BytePos, bad_char: char) -> ! {
515 self.struct_fatal_span_char(
518 "found invalid character; only `#` is allowed in raw string delimitation",
525 fn report_unterminated_raw_string(
529 possible_offset: Option<usize>,
530 found_terminators: usize,
532 let mut err = self.sess.span_diagnostic.struct_span_fatal_with_code(
533 self.mk_sp(start, start),
534 "unterminated raw string",
538 err.span_label(self.mk_sp(start, start), "unterminated raw string");
542 "this raw string should be terminated with `\"{}`",
547 if let Some(possible_offset) = possible_offset {
548 let lo = start + BytePos(possible_offset as u32);
549 let hi = lo + BytePos(found_terminators as u32);
550 let span = self.mk_sp(lo, hi);
553 "consider terminating the string here",
554 "#".repeat(n_hashes),
555 Applicability::MaybeIncorrect,
563 /// Note: It was decided to not add a test case, because it would be to big.
564 /// https://github.com/rust-lang/rust/pull/50296#issuecomment-392135180
565 fn report_too_many_hashes(&self, start: BytePos, found: usize) -> ! {
570 "too many `#` symbols: raw strings may be delimited \
571 by up to 65535 `#` symbols, but found {}",
578 fn validate_literal_escape(&self, mode: Mode, content_start: BytePos, content_end: BytePos) {
579 let lit_content = self.str_from_to(content_start, content_end);
580 unescape::unescape_literal(lit_content, mode, &mut |range, result| {
581 // Here we only check for errors. The actual unescaping is done later.
582 if let Err(err) = result {
583 let span_with_quotes =
584 self.mk_sp(content_start - BytePos(1), content_end + BytePos(1));
586 &self.sess.span_diagnostic,
597 fn validate_int_literal(&self, base: Base, content_start: BytePos, content_end: BytePos) {
598 let base = match base {
603 let s = self.str_from_to(content_start + BytePos(2), content_end);
604 for (idx, c) in s.char_indices() {
605 let idx = idx as u32;
606 if c != '_' && c.to_digit(base).is_none() {
607 let lo = content_start + BytePos(2 + idx);
608 let hi = content_start + BytePos(2 + idx + c.len_utf8() as u32);
609 self.err_span_(lo, hi, &format!("invalid digit for a base {} literal", base));
615 pub fn nfc_normalize(string: &str) -> Symbol {
616 use unicode_normalization::{is_nfc_quick, IsNormalized, UnicodeNormalization};
617 match is_nfc_quick(string.chars()) {
618 IsNormalized::Yes => Symbol::intern(string),
620 let normalized_str: String = string.chars().nfc().collect();
621 Symbol::intern(&normalized_str)