compiler/rustc_lexer/src/unescape.rs

   1 //! Utilities for validating string and char literals and turning them into
   2 //! values they represent.
   3
   4 use std::ops::Range;
   5 use std::str::Chars;
   6
   7 #[cfg(test)]
   8 mod tests;
   9
  10 /// Errors and warnings that can occur during string unescaping.
  11 #[derive(Debug, PartialEq, Eq)]
  12 pub enum EscapeError {
  13     /// Expected 1 char, but 0 were found.
  14     ZeroChars,
  15     /// Expected 1 char, but more than 1 were found.
  16     MoreThanOneChar,
  17
  18     /// Escaped '\' character without continuation.
  19     LoneSlash,
  20     /// Invalid escape character (e.g. '\z').
  21     InvalidEscape,
  22     /// Raw '\r' encountered.
  23     BareCarriageReturn,
  24     /// Raw '\r' encountered in raw string.
  25     BareCarriageReturnInRawString,
  26     /// Unescaped character that was expected to be escaped (e.g. raw '\t').
  27     EscapeOnlyChar,
  28
  29     /// Numeric character escape is too short (e.g. '\x1').
  30     TooShortHexEscape,
  31     /// Invalid character in numeric escape (e.g. '\xz')
  32     InvalidCharInHexEscape,
  33     /// Character code in numeric escape is non-ascii (e.g. '\xFF').
  34     OutOfRangeHexEscape,
  35
  36     /// '\u' not followed by '{'.
  37     NoBraceInUnicodeEscape,
  38     /// Non-hexadecimal value in '\u{..}'.
  39     InvalidCharInUnicodeEscape,
  40     /// '\u{}'
  41     EmptyUnicodeEscape,
  42     /// No closing brace in '\u{..}', e.g. '\u{12'.
  43     UnclosedUnicodeEscape,
  44     /// '\u{_12}'
  45     LeadingUnderscoreUnicodeEscape,
  46     /// More than 6 characters in '\u{..}', e.g. '\u{10FFFF_FF}'
  47     OverlongUnicodeEscape,
  48     /// Invalid in-bound unicode character code, e.g. '\u{DFFF}'.
  49     LoneSurrogateUnicodeEscape,
  50     /// Out of bounds unicode character code, e.g. '\u{FFFFFF}'.
  51     OutOfRangeUnicodeEscape,
  52
  53     /// Unicode escape code in byte literal.
  54     UnicodeEscapeInByte,
  55     /// Non-ascii character in byte literal.
  56     NonAsciiCharInByte,
  57     /// Non-ascii character in byte string literal.
  58     NonAsciiCharInByteString,
  59
  60     /// After a line ending with '\', the next line contains whitespace
  61     /// characters that are not skipped.
  62     UnskippedWhitespaceWarning,
  63
  64     /// After a line ending with '\', multiple lines are skipped.
  65     MultipleSkippedLinesWarning,
  66 }
  67
  68 impl EscapeError {
  69     /// Returns true for actual errors, as opposed to warnings.
  70     pub fn is_fatal(&self) -> bool {
  71         !matches!(
  72             self,
  73             EscapeError::UnskippedWhitespaceWarning | EscapeError::MultipleSkippedLinesWarning
  74         )
  75     }
  76 }
  77
  78 /// Takes a contents of a literal (without quotes) and produces a
  79 /// sequence of escaped characters or errors.
  80 /// Values are returned through invoking of the provided callback.
  81 pub fn unescape_literal<F>(literal_text: &str, mode: Mode, callback: &mut F)
  82 where
  83     F: FnMut(Range<usize>, Result<char, EscapeError>),
  84 {
  85     match mode {
  86         Mode::Char | Mode::Byte => {
  87             let mut chars = literal_text.chars();
  88             let result = unescape_char_or_byte(&mut chars, mode);
  89             // The Chars iterator moved forward.
  90             callback(0..(literal_text.len() - chars.as_str().len()), result);
  91         }
  92         Mode::Str | Mode::ByteStr => unescape_str_or_byte_str(literal_text, mode, callback),
  93         // NOTE: Raw strings do not perform any explicit character escaping, here we
  94         // only translate CRLF to LF and produce errors on bare CR.
  95         Mode::RawStr | Mode::RawByteStr => {
  96             unescape_raw_str_or_byte_str(literal_text, mode, callback)
  97         }
  98     }
  99 }
 100
 101 /// Takes a contents of a byte, byte string or raw byte string (without quotes)
 102 /// and produces a sequence of bytes or errors.
 103 /// Values are returned through invoking of the provided callback.
 104 pub fn unescape_byte_literal<F>(literal_text: &str, mode: Mode, callback: &mut F)
 105 where
 106     F: FnMut(Range<usize>, Result<u8, EscapeError>),
 107 {
 108     assert!(mode.is_bytes());
 109     unescape_literal(literal_text, mode, &mut |range, result| {
 110         callback(range, result.map(byte_from_char));
 111     })
 112 }
 113
 114 /// Takes a contents of a char literal (without quotes), and returns an
 115 /// unescaped char or an error
 116 pub fn unescape_char(literal_text: &str) -> Result<char, (usize, EscapeError)> {
 117     let mut chars = literal_text.chars();
 118     unescape_char_or_byte(&mut chars, Mode::Char)
 119         .map_err(|err| (literal_text.len() - chars.as_str().len(), err))
 120 }
 121
 122 /// Takes a contents of a byte literal (without quotes), and returns an
 123 /// unescaped byte or an error.
 124 pub fn unescape_byte(literal_text: &str) -> Result<u8, (usize, EscapeError)> {
 125     let mut chars = literal_text.chars();
 126     unescape_char_or_byte(&mut chars, Mode::Byte)
 127         .map(byte_from_char)
 128         .map_err(|err| (literal_text.len() - chars.as_str().len(), err))
 129 }
 130
 131 /// What kind of literal do we parse.
 132 #[derive(Debug, Clone, Copy)]
 133 pub enum Mode {
 134     Char,
 135     Str,
 136     Byte,
 137     ByteStr,
 138     RawStr,
 139     RawByteStr,
 140 }
 141
 142 impl Mode {
 143     pub fn in_single_quotes(self) -> bool {
 144         match self {
 145             Mode::Char | Mode::Byte => true,
 146             Mode::Str | Mode::ByteStr | Mode::RawStr | Mode::RawByteStr => false,
 147         }
 148     }
 149
 150     pub fn in_double_quotes(self) -> bool {
 151         !self.in_single_quotes()
 152     }
 153
 154     pub fn is_bytes(self) -> bool {
 155         match self {
 156             Mode::Byte | Mode::ByteStr | Mode::RawByteStr => true,
 157             Mode::Char | Mode::Str | Mode::RawStr => false,
 158         }
 159     }
 160 }
 161
 162 fn scan_escape(chars: &mut Chars<'_>, mode: Mode) -> Result<char, EscapeError> {
 163     // Previous character was '\\', unescape what follows.
 164
 165     let second_char = chars.next().ok_or(EscapeError::LoneSlash)?;
 166
 167     let res = match second_char {
 168         '"' => '"',
 169         'n' => '\n',
 170         'r' => '\r',
 171         't' => '\t',
 172         '\\' => '\\',
 173         '\'' => '\'',
 174         '0' => '\0',
 175
 176         'x' => {
 177             // Parse hexadecimal character code.
 178
 179             let hi = chars.next().ok_or(EscapeError::TooShortHexEscape)?;
 180             let hi = hi.to_digit(16).ok_or(EscapeError::InvalidCharInHexEscape)?;
 181
 182             let lo = chars.next().ok_or(EscapeError::TooShortHexEscape)?;
 183             let lo = lo.to_digit(16).ok_or(EscapeError::InvalidCharInHexEscape)?;
 184
 185             let value = hi * 16 + lo;
 186
 187             // For a byte literal verify that it is within ASCII range.
 188             if !mode.is_bytes() && !is_ascii(value) {
 189                 return Err(EscapeError::OutOfRangeHexEscape);
 190             }
 191             let value = value as u8;
 192
 193             value as char
 194         }
 195
 196         'u' => {
 197             // We've parsed '\u', now we have to parse '{..}'.
 198
 199             if chars.next() != Some('{') {
 200                 return Err(EscapeError::NoBraceInUnicodeEscape);
 201             }
 202
 203             // First character must be a hexadecimal digit.
 204             let mut n_digits = 1;
 205             let mut value: u32 = match chars.next().ok_or(EscapeError::UnclosedUnicodeEscape)? {
 206                 '_' => return Err(EscapeError::LeadingUnderscoreUnicodeEscape),
 207                 '}' => return Err(EscapeError::EmptyUnicodeEscape),
 208                 c => c.to_digit(16).ok_or(EscapeError::InvalidCharInUnicodeEscape)?,
 209             };
 210
 211             // First character is valid, now parse the rest of the number
 212             // and closing brace.
 213             loop {
 214                 match chars.next() {
 215                     None => return Err(EscapeError::UnclosedUnicodeEscape),
 216                     Some('_') => continue,
 217                     Some('}') => {
 218                         if n_digits > 6 {
 219                             return Err(EscapeError::OverlongUnicodeEscape);
 220                         }
 221
 222                         // Incorrect syntax has higher priority for error reporting
 223                         // than unallowed value for a literal.
 224                         if mode.is_bytes() {
 225                             return Err(EscapeError::UnicodeEscapeInByte);
 226                         }
 227
 228                         break std::char::from_u32(value).ok_or_else(|| {
 229                             if value > 0x10FFFF {
 230                                 EscapeError::OutOfRangeUnicodeEscape
 231                             } else {
 232                                 EscapeError::LoneSurrogateUnicodeEscape
 233                             }
 234                         })?;
 235                     }
 236                     Some(c) => {
 237                         let digit =
 238                             c.to_digit(16).ok_or(EscapeError::InvalidCharInUnicodeEscape)?;
 239                         n_digits += 1;
 240                         if n_digits > 6 {
 241                             // Stop updating value since we're sure that it's is incorrect already.
 242                             continue;
 243                         }
 244                         let digit = digit as u32;
 245                         value = value * 16 + digit;
 246                     }
 247                 };
 248             }
 249         }
 250         _ => return Err(EscapeError::InvalidEscape),
 251     };
 252     Ok(res)
 253 }
 254
 255 #[inline]
 256 fn ascii_check(first_char: char, mode: Mode) -> Result<char, EscapeError> {
 257     if mode.is_bytes() && !first_char.is_ascii() {
 258         // Byte literal can't be a non-ascii character.
 259         Err(EscapeError::NonAsciiCharInByte)
 260     } else {
 261         Ok(first_char)
 262     }
 263 }
 264
 265 fn unescape_char_or_byte(chars: &mut Chars<'_>, mode: Mode) -> Result<char, EscapeError> {
 266     let first_char = chars.next().ok_or(EscapeError::ZeroChars)?;
 267     let res = match first_char {
 268         '\\' => scan_escape(chars, mode),
 269         '\n' | '\t' | '\'' => Err(EscapeError::EscapeOnlyChar),
 270         '\r' => Err(EscapeError::BareCarriageReturn),
 271         _ => ascii_check(first_char, mode),
 272     }?;
 273     if chars.next().is_some() {
 274         return Err(EscapeError::MoreThanOneChar);
 275     }
 276     Ok(res)
 277 }
 278
 279 /// Takes a contents of a string literal (without quotes) and produces a
 280 /// sequence of escaped characters or errors.
 281 fn unescape_str_or_byte_str<F>(src: &str, mode: Mode, callback: &mut F)
 282 where
 283     F: FnMut(Range<usize>, Result<char, EscapeError>),
 284 {
 285     assert!(mode.in_double_quotes());
 286     let initial_len = src.len();
 287     let mut chars = src.chars();
 288     while let Some(first_char) = chars.next() {
 289         let start = initial_len - chars.as_str().len() - first_char.len_utf8();
 290
 291         let unescaped_char = match first_char {
 292             '\\' => {
 293                 let second_char = chars.clone().next();
 294                 match second_char {
 295                     Some('\n') => {
 296                         // Rust language specification requires us to skip whitespaces
 297                         // if unescaped '\' character is followed by '\n'.
 298                         // For details see [Rust language reference]
 299                         // (https://doc.rust-lang.org/reference/tokens.html#string-literals).
 300                         skip_ascii_whitespace(&mut chars, start, callback);
 301                         continue;
 302                     }
 303                     _ => scan_escape(&mut chars, mode),
 304                 }
 305             }
 306             '\n' => Ok('\n'),
 307             '\t' => Ok('\t'),
 308             '"' => Err(EscapeError::EscapeOnlyChar),
 309             '\r' => Err(EscapeError::BareCarriageReturn),
 310             _ => ascii_check(first_char, mode),
 311         };
 312         let end = initial_len - chars.as_str().len();
 313         callback(start..end, unescaped_char);
 314     }
 315
 316     fn skip_ascii_whitespace<F>(chars: &mut Chars<'_>, start: usize, callback: &mut F)
 317     where
 318         F: FnMut(Range<usize>, Result<char, EscapeError>),
 319     {
 320         let tail = chars.as_str();
 321         let first_non_space = tail
 322             .bytes()
 323             .position(|b| b != b' ' && b != b'\t' && b != b'\n' && b != b'\r')
 324             .unwrap_or(tail.len());
 325         if tail[1..first_non_space].contains('\n') {
 326             // The +1 accounts for the escaping slash.
 327             let end = start + first_non_space + 1;
 328             callback(start..end, Err(EscapeError::MultipleSkippedLinesWarning));
 329         }
 330         let tail = &tail[first_non_space..];
 331         if let Some(c) = tail.chars().nth(0) {
 332             // For error reporting, we would like the span to contain the character that was not
 333             // skipped.  The +1 is necessary to account for the leading \ that started the escape.
 334             let end = start + first_non_space + c.len_utf8() + 1;
 335             if c.is_whitespace() {
 336                 callback(start..end, Err(EscapeError::UnskippedWhitespaceWarning));
 337             }
 338         }
 339         *chars = tail.chars();
 340     }
 341 }
 342
 343 /// Takes a contents of a string literal (without quotes) and produces a
 344 /// sequence of characters or errors.
 345 /// NOTE: Raw strings do not perform any explicit character escaping, here we
 346 /// only translate CRLF to LF and produce errors on bare CR.
 347 fn unescape_raw_str_or_byte_str<F>(literal_text: &str, mode: Mode, callback: &mut F)
 348 where
 349     F: FnMut(Range<usize>, Result<char, EscapeError>),
 350 {
 351     assert!(mode.in_double_quotes());
 352     let initial_len = literal_text.len();
 353
 354     let mut chars = literal_text.chars();
 355     while let Some(curr) = chars.next() {
 356         let start = initial_len - chars.as_str().len() - curr.len_utf8();
 357
 358         let result = match curr {
 359             '\r' => Err(EscapeError::BareCarriageReturnInRawString),
 360             c if mode.is_bytes() && !c.is_ascii() => Err(EscapeError::NonAsciiCharInByteString),
 361             c => Ok(c),
 362         };
 363         let end = initial_len - chars.as_str().len();
 364
 365         callback(start..end, result);
 366     }
 367 }
 368
 369 fn byte_from_char(c: char) -> u8 {
 370     let res = c as u32;
 371     assert!(res <= u8::MAX as u32, "guaranteed because of Mode::ByteStr");
 372     res as u8
 373 }
 374
 375 fn is_ascii(x: u32) -> bool {
 376     x <= 0x7F
 377 }