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