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>(src: &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 = src.chars();
  88             let result = unescape_char_or_byte(&mut chars, mode == Mode::Byte);
  89             // The Chars iterator moved forward.
  90             callback(0..(src.len() - chars.as_str().len()), result);
  91         }
  92         Mode::Str | Mode::ByteStr => unescape_str_or_byte_str(src, mode == Mode::ByteStr, 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_raw_byte_str(src, mode == Mode::RawByteStr, 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>(src: &str, mode: Mode, callback: &mut F)
 105 where
 106     F: FnMut(Range<usize>, Result<u8, EscapeError>),
 107 {
 108     debug_assert!(mode.is_byte());
 109     unescape_literal(src, 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(src: &str) -> Result<char, (usize, EscapeError)> {
 117     let mut chars = src.chars();
 118     unescape_char_or_byte(&mut chars, false).map_err(|err| (src.len() - chars.as_str().len(), err))
 119 }
 120
 121 /// Takes a contents of a byte literal (without quotes), and returns an
 122 /// unescaped byte or an error.
 123 pub fn unescape_byte(src: &str) -> Result<u8, (usize, EscapeError)> {
 124     let mut chars = src.chars();
 125     unescape_char_or_byte(&mut chars, true)
 126         .map(byte_from_char)
 127         .map_err(|err| (src.len() - chars.as_str().len(), err))
 128 }
 129
 130 /// What kind of literal do we parse.
 131 #[derive(Debug, Clone, Copy, PartialEq)]
 132 pub enum Mode {
 133     Char,
 134     Str,
 135     Byte,
 136     ByteStr,
 137     RawStr,
 138     RawByteStr,
 139 }
 140
 141 impl Mode {
 142     pub fn in_double_quotes(self) -> bool {
 143         match self {
 144             Mode::Str | Mode::ByteStr | Mode::RawStr | Mode::RawByteStr => true,
 145             Mode::Char | Mode::Byte => false,
 146         }
 147     }
 148
 149     pub fn is_byte(self) -> bool {
 150         match self {
 151             Mode::Byte | Mode::ByteStr | Mode::RawByteStr => true,
 152             Mode::Char | Mode::Str | Mode::RawStr => false,
 153         }
 154     }
 155 }
 156
 157 fn scan_escape(chars: &mut Chars<'_>, is_byte: bool) -> Result<char, EscapeError> {
 158     // Previous character was '\\', unescape what follows.
 159     let res = match chars.next().ok_or(EscapeError::LoneSlash)? {
 160         '"' => '"',
 161         'n' => '\n',
 162         'r' => '\r',
 163         't' => '\t',
 164         '\\' => '\\',
 165         '\'' => '\'',
 166         '0' => '\0',
 167
 168         'x' => {
 169             // Parse hexadecimal character code.
 170
 171             let hi = chars.next().ok_or(EscapeError::TooShortHexEscape)?;
 172             let hi = hi.to_digit(16).ok_or(EscapeError::InvalidCharInHexEscape)?;
 173
 174             let lo = chars.next().ok_or(EscapeError::TooShortHexEscape)?;
 175             let lo = lo.to_digit(16).ok_or(EscapeError::InvalidCharInHexEscape)?;
 176
 177             let value = hi * 16 + lo;
 178
 179             // For a non-byte literal verify that it is within ASCII range.
 180             if !is_byte && !is_ascii(value) {
 181                 return Err(EscapeError::OutOfRangeHexEscape);
 182             }
 183             let value = value as u8;
 184
 185             value as char
 186         }
 187
 188         'u' => {
 189             // We've parsed '\u', now we have to parse '{..}'.
 190
 191             if chars.next() != Some('{') {
 192                 return Err(EscapeError::NoBraceInUnicodeEscape);
 193             }
 194
 195             // First character must be a hexadecimal digit.
 196             let mut n_digits = 1;
 197             let mut value: u32 = match chars.next().ok_or(EscapeError::UnclosedUnicodeEscape)? {
 198                 '_' => return Err(EscapeError::LeadingUnderscoreUnicodeEscape),
 199                 '}' => return Err(EscapeError::EmptyUnicodeEscape),
 200                 c => c.to_digit(16).ok_or(EscapeError::InvalidCharInUnicodeEscape)?,
 201             };
 202
 203             // First character is valid, now parse the rest of the number
 204             // and closing brace.
 205             loop {
 206                 match chars.next() {
 207                     None => return Err(EscapeError::UnclosedUnicodeEscape),
 208                     Some('_') => continue,
 209                     Some('}') => {
 210                         if n_digits > 6 {
 211                             return Err(EscapeError::OverlongUnicodeEscape);
 212                         }
 213
 214                         // Incorrect syntax has higher priority for error reporting
 215                         // than unallowed value for a literal.
 216                         if is_byte {
 217                             return Err(EscapeError::UnicodeEscapeInByte);
 218                         }
 219
 220                         break std::char::from_u32(value).ok_or_else(|| {
 221                             if value > 0x10FFFF {
 222                                 EscapeError::OutOfRangeUnicodeEscape
 223                             } else {
 224                                 EscapeError::LoneSurrogateUnicodeEscape
 225                             }
 226                         })?;
 227                     }
 228                     Some(c) => {
 229                         let digit =
 230                             c.to_digit(16).ok_or(EscapeError::InvalidCharInUnicodeEscape)?;
 231                         n_digits += 1;
 232                         if n_digits > 6 {
 233                             // Stop updating value since we're sure that it's incorrect already.
 234                             continue;
 235                         }
 236                         let digit = digit as u32;
 237                         value = value * 16 + digit;
 238                     }
 239                 };
 240             }
 241         }
 242         _ => return Err(EscapeError::InvalidEscape),
 243     };
 244     Ok(res)
 245 }
 246
 247 #[inline]
 248 fn ascii_check(c: char, is_byte: bool) -> Result<char, EscapeError> {
 249     if is_byte && !c.is_ascii() {
 250         // Byte literal can't be a non-ascii character.
 251         Err(EscapeError::NonAsciiCharInByte)
 252     } else {
 253         Ok(c)
 254     }
 255 }
 256
 257 fn unescape_char_or_byte(chars: &mut Chars<'_>, is_byte: bool) -> Result<char, EscapeError> {
 258     let c = chars.next().ok_or(EscapeError::ZeroChars)?;
 259     let res = match c {
 260         '\\' => scan_escape(chars, is_byte),
 261         '\n' | '\t' | '\'' => Err(EscapeError::EscapeOnlyChar),
 262         '\r' => Err(EscapeError::BareCarriageReturn),
 263         _ => ascii_check(c, is_byte),
 264     }?;
 265     if chars.next().is_some() {
 266         return Err(EscapeError::MoreThanOneChar);
 267     }
 268     Ok(res)
 269 }
 270
 271 /// Takes a contents of a string literal (without quotes) and produces a
 272 /// sequence of escaped characters or errors.
 273 fn unescape_str_or_byte_str<F>(src: &str, is_byte: bool, callback: &mut F)
 274 where
 275     F: FnMut(Range<usize>, Result<char, EscapeError>),
 276 {
 277     let mut chars = src.chars();
 278
 279     // The `start` and `end` computation here is complicated because
 280     // `skip_ascii_whitespace` makes us to skip over chars without counting
 281     // them in the range computation.
 282     while let Some(c) = chars.next() {
 283         let start = src.len() - chars.as_str().len() - c.len_utf8();
 284         let result = match c {
 285             '\\' => {
 286                 match chars.clone().next() {
 287                     Some('\n') => {
 288                         // Rust language specification requires us to skip whitespaces
 289                         // if unescaped '\' character is followed by '\n'.
 290                         // For details see [Rust language reference]
 291                         // (https://doc.rust-lang.org/reference/tokens.html#string-literals).
 292                         skip_ascii_whitespace(&mut chars, start, callback);
 293                         continue;
 294                     }
 295                     _ => scan_escape(&mut chars, is_byte),
 296                 }
 297             }
 298             '\n' => Ok('\n'),
 299             '\t' => Ok('\t'),
 300             '"' => Err(EscapeError::EscapeOnlyChar),
 301             '\r' => Err(EscapeError::BareCarriageReturn),
 302             _ => ascii_check(c, is_byte),
 303         };
 304         let end = src.len() - chars.as_str().len();
 305         callback(start..end, result);
 306     }
 307
 308     fn skip_ascii_whitespace<F>(chars: &mut Chars<'_>, start: usize, callback: &mut F)
 309     where
 310         F: FnMut(Range<usize>, Result<char, EscapeError>),
 311     {
 312         let tail = chars.as_str();
 313         let first_non_space = tail
 314             .bytes()
 315             .position(|b| b != b' ' && b != b'\t' && b != b'\n' && b != b'\r')
 316             .unwrap_or(tail.len());
 317         if tail[1..first_non_space].contains('\n') {
 318             // The +1 accounts for the escaping slash.
 319             let end = start + first_non_space + 1;
 320             callback(start..end, Err(EscapeError::MultipleSkippedLinesWarning));
 321         }
 322         let tail = &tail[first_non_space..];
 323         if let Some(c) = tail.chars().nth(0) {
 324             // For error reporting, we would like the span to contain the character that was not
 325             // skipped.  The +1 is necessary to account for the leading \ that started the escape.
 326             let end = start + first_non_space + c.len_utf8() + 1;
 327             if c.is_whitespace() {
 328                 callback(start..end, Err(EscapeError::UnskippedWhitespaceWarning));
 329             }
 330         }
 331         *chars = tail.chars();
 332     }
 333 }
 334
 335 /// Takes a contents of a string literal (without quotes) and produces a
 336 /// sequence of characters or errors.
 337 /// NOTE: Raw strings do not perform any explicit character escaping, here we
 338 /// only translate CRLF to LF and produce errors on bare CR.
 339 fn unescape_raw_str_or_raw_byte_str<F>(src: &str, is_byte: bool, callback: &mut F)
 340 where
 341     F: FnMut(Range<usize>, Result<char, EscapeError>),
 342 {
 343     let mut chars = src.chars();
 344
 345     // The `start` and `end` computation here matches the one in
 346     // `unescape_str_or_byte_str` for consistency, even though this function
 347     // doesn't have to worry about skipping any chars.
 348     while let Some(c) = chars.next() {
 349         let start = src.len() - chars.as_str().len() - c.len_utf8();
 350         let result = match c {
 351             '\r' => Err(EscapeError::BareCarriageReturnInRawString),
 352             c if is_byte && !c.is_ascii() => Err(EscapeError::NonAsciiCharInByteString),
 353             c => Ok(c),
 354         };
 355         let end = src.len() - chars.as_str().len();
 356         callback(start..end, result);
 357     }
 358 }
 359
 360 fn byte_from_char(c: char) -> u8 {
 361     let res = c as u32;
 362     debug_assert!(res <= u8::MAX as u32, "guaranteed because of Mode::ByteStr");
 363     res as u8
 364 }
 365
 366 fn is_ascii(x: u32) -> bool {
 367     x <= 0x7F
 368 }