Skip to content

Commit 59a3e42

Browse files
oxalicaoxalica
committed
Fix unescaping of C string literals
1 parent de1f766 commit 59a3e42

File tree

6 files changed

+49
-21
lines changed

6 files changed

+49
-21
lines changed

‎crates/hir-def/src/body/pretty.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,7 @@ impl Printer<'_> {
634634
match literal {
635635
Literal::String(it) => w!(self, "{:?}", it),
636636
Literal::ByteString(it) => w!(self, "\"{}\"", it.escape_ascii()),
637-
Literal::CString(it) => w!(self, "\"{}\\0\"", it),
637+
Literal::CString(it) => w!(self, "\"{}\\0\"", it.escape_ascii()),
638638
Literal::Char(it) => w!(self, "'{}'", it.escape_debug()),
639639
Literal::Bool(it) => w!(self, "{}", it),
640640
Literal::Int(i, suffix) => {

‎crates/hir-def/src/hir.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ impl fmt::Display for FloatTypeWrapper {
8585
pub enum Literal {
8686
String(Box<str>),
8787
ByteString(Box<[u8]>),
88-
CString(Box<str>),
88+
CString(Box<[u8]>),
8989
Char(char),
9090
Bool(bool),
9191
Int(i128, Option<BuiltinInt>),

‎crates/hir-ty/src/mir/lower.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1355,7 +1355,6 @@ impl<'ctx> MirLowerCtx<'ctx> {
13551355
return Ok(Operand::from_concrete_const(data, mm, ty));
13561356
}
13571357
hir_def::hir::Literal::CString(b) => {
1358-
let b = b.as_bytes();
13591358
let bytes = b.iter().copied().chain(iter::once(0)).collect::<Vec<_>>();
13601359

13611360
let mut data = Vec::with_capacity(mem::size_of::<usize>() * 2);

‎crates/ide/src/syntax_highlighting/test_data/highlight_strings.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,9 @@
161161
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"Hello</span><span class="escape_sequence">\n</span><span class="string_literal macro">World"</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
162162
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"</span><span class="escape_sequence">\u{48}</span><span class="escape_sequence">\x65</span><span class="escape_sequence">\x6C</span><span class="escape_sequence">\x6C</span><span class="escape_sequence">\x6F</span><span class="string_literal macro"> World"</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>
163163

164-
<span class="keyword">let</span> <span class="punctuation">_</span> <span class="operator">=</span> <span class="string_literal">"</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x00</span><span class="escape_sequence">\x63</span><span class="string_literal">\xFF</span><span class="escape_sequence">\n</span><span class="string_literal">"</span><span class="semicolon">;</span> <span class="comment">// invalid non-UTF8 escape sequences</span>
165-
<span class="keyword">let</span> <span class="punctuation">_</span> <span class="operator">=</span> <span class="string_literal">b"</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x00</span><span class="escape_sequence">\x63</span><span class="escape_sequence">\xFF</span><span class="escape_sequence">\n</span><span class="string_literal">"</span><span class="semicolon">;</span> <span class="comment">// valid bytes</span>
164+
<span class="keyword">let</span> <span class="punctuation">_</span> <span class="operator">=</span> <span class="string_literal">"</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x00</span><span class="escape_sequence">\x63</span><span class="string_literal">\xFF</span><span class="escape_sequence">\u{FF}</span><span class="escape_sequence">\n</span><span class="string_literal">"</span><span class="semicolon">;</span> <span class="comment">// invalid non-UTF8 escape sequences</span>
165+
<span class="keyword">let</span> <span class="punctuation">_</span> <span class="operator">=</span> <span class="string_literal">b"</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x28</span><span class="escape_sequence">\x00</span><span class="escape_sequence">\x63</span><span class="escape_sequence">\xFF</span><span class="string_literal">\u{FF}</span><span class="escape_sequence">\n</span><span class="string_literal">"</span><span class="semicolon">;</span> <span class="comment">// valid bytes, invalid unicodes</span>
166+
<span class="keyword">let</span> <span class="punctuation">_</span> <span class="operator">=</span> <span class="string_literal">c"</span><span class="escape_sequence">\u{FF}</span><span class="escape_sequence">\xFF</span><span class="string_literal">"</span><span class="semicolon">;</span> <span class="comment">// valid bytes, valid unicodes</span>
166167
<span class="keyword">let</span> <span class="variable declaration reference">backslash</span> <span class="operator">=</span> <span class="string_literal">r"\\"</span><span class="semicolon">;</span>
167168

168169
<span class="macro">println</span><span class="macro_bang">!</span><span class="parenthesis macro">(</span><span class="string_literal macro">"</span><span class="format_specifier">{</span><span class="escape_sequence">\x41</span><span class="format_specifier">}</span><span class="string_literal macro">"</span><span class="comma macro">,</span> <span class="none macro">A</span> <span class="operator macro">=</span> <span class="numeric_literal macro">92</span><span class="parenthesis macro">)</span><span class="semicolon">;</span>

‎crates/ide/src/syntax_highlighting/tests.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,8 +507,9 @@ fn main() {
507507
println!("Hello\nWorld");
508508
println!("\u{48}\x65\x6C\x6C\x6F World");
509509
510-
let _ = "\x28\x28\x00\x63\xFF\n"; // invalid non-UTF8 escape sequences
511-
let _ = b"\x28\x28\x00\x63\xFF\n"; // valid bytes
510+
let _ = "\x28\x28\x00\x63\xFF\u{FF}\n"; // invalid non-UTF8 escape sequences
511+
let _ = b"\x28\x28\x00\x63\xFF\u{FF}\n"; // valid bytes, invalid unicodes
512+
let _ = c"\u{FF}\xFF"; // valid bytes, valid unicodes
512513
let backslash = r"\\";
513514
514515
println!("{\x41}", A = 92);

‎crates/syntax/src/ast/token_ext.rs

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
33
use std::borrow::Cow;
44

5-
use rustc_lexer::unescape::{unescape_byte, unescape_char, unescape_literal, Mode};
5+
use rustc_lexer::unescape::{
6+
unescape_byte, unescape_c_string, unescape_char, unescape_literal, CStrUnit, Mode,
7+
};
68

79
use crate::{
810
ast::{self, AstToken},
@@ -285,45 +287,70 @@ impl ast::ByteString {
285287

286288
impl IsString for ast::CString {
287289
const RAW_PREFIX: &'static str = "cr";
288-
// XXX: `Mode::CStr` is not supported by `unescape_literal` of ra-ap-rustc_lexer yet.
289-
// Here we pretend it to be a byte string.
290-
const MODE: Mode = Mode::ByteStr;
290+
const MODE: Mode = Mode::CStr;
291+
292+
fn escaped_char_ranges(
293+
&self,
294+
cb: &mut dyn FnMut(TextRange, Result<char, rustc_lexer::unescape::EscapeError>),
295+
) {
296+
let text_range_no_quotes = match self.text_range_between_quotes() {
297+
Some(it) => it,
298+
None => return,
299+
};
300+
301+
let start = self.syntax().text_range().start();
302+
let text = &self.text()[text_range_no_quotes - start];
303+
let offset = text_range_no_quotes.start() - start;
304+
305+
unescape_c_string(text, Self::MODE, &mut |range, unescaped_char| {
306+
let text_range =
307+
TextRange::new(range.start.try_into().unwrap(), range.end.try_into().unwrap());
308+
// XXX: This method should only be used for highlighting ranges. The unescaped
309+
// char/byte is not used. For simplicity, we return an arbitrary placeholder char.
310+
cb(text_range + offset, unescaped_char.map(|_| ' '));
311+
});
312+
}
291313
}
292314

293315
impl ast::CString {
294-
pub fn value(&self) -> Option<Cow<'_, str>> {
316+
pub fn value(&self) -> Option<Cow<'_, [u8]>> {
295317
if self.is_raw() {
296318
let text = self.text();
297319
let text =
298320
&text[self.text_range_between_quotes()? - self.syntax().text_range().start()];
299-
return Some(Cow::Borrowed(text));
321+
return Some(Cow::Borrowed(text.as_bytes()));
300322
}
301323

302324
let text = self.text();
303325
let text = &text[self.text_range_between_quotes()? - self.syntax().text_range().start()];
304326

305-
let mut buf = String::new();
327+
let mut buf = Vec::new();
306328
let mut prev_end = 0;
307329
let mut has_error = false;
308-
unescape_literal(text, Self::MODE, &mut |char_range, unescaped_char| match (
309-
unescaped_char,
330+
let mut char_buf = [0u8; 4];
331+
let mut extend_unit = |buf: &mut Vec<u8>, unit: CStrUnit| match unit {
332+
CStrUnit::Byte(b) => buf.push(b),
333+
CStrUnit::Char(c) => buf.extend(c.encode_utf8(&mut char_buf).as_bytes()),
334+
};
335+
unescape_c_string(text, Self::MODE, &mut |char_range, unescaped| match (
336+
unescaped,
310337
buf.capacity() == 0,
311338
) {
312-
(Ok(c), false) => buf.push(c),
339+
(Ok(u), false) => extend_unit(&mut buf, u),
313340
(Ok(_), true) if char_range.len() == 1 && char_range.start == prev_end => {
314341
prev_end = char_range.end
315342
}
316-
(Ok(c), true) => {
343+
(Ok(u), true) => {
317344
buf.reserve_exact(text.len());
318-
buf.push_str(&text[..prev_end]);
319-
buf.push(c);
345+
buf.extend(text[..prev_end].as_bytes());
346+
extend_unit(&mut buf, u);
320347
}
321348
(Err(_), _) => has_error = true,
322349
});
323350

324351
match (has_error, buf.capacity() == 0) {
325352
(true, _) => None,
326-
(false, true) => Some(Cow::Borrowed(text)),
353+
(false, true) => Some(Cow::Borrowed(text.as_bytes())),
327354
(false, false) => Some(Cow::Owned(buf)),
328355
}
329356
}

0 commit comments

Comments
 (0)