Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Literal::c_string constructor #450

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ fn main() {

if rustc < 79 {
println!("cargo:rustc-cfg=no_literal_byte_character");
println!("cargo:rustc-cfg=no_literal_c_string");
}

if !cfg!(feature = "proc-macro") {
Expand Down
77 changes: 55 additions & 22 deletions src/fallback.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ use core::mem::ManuallyDrop;
use core::ops::Range;
use core::ops::RangeBounds;
use core::ptr;
use core::str::FromStr;
use core::str::{self, FromStr};
use std::ffi::CStr;
#[cfg(procmacro2_semver_exempt)]
use std::path::PathBuf;

Expand Down Expand Up @@ -1010,27 +1011,7 @@ impl Literal {
pub fn string(string: &str) -> Literal {
let mut repr = String::with_capacity(string.len() + 2);
repr.push('"');
let mut chars = string.chars();
while let Some(ch) = chars.next() {
if ch == '\0' {
repr.push_str(
if chars
.as_str()
.starts_with(|next| '0' <= next && next <= '7')
{
// circumvent clippy::octal_escapes lint
r"\x00"
} else {
r"\0"
},
);
} else if ch == '\'' {
// escape_debug turns this into "\'" which is unnecessary.
repr.push(ch);
} else {
repr.extend(ch.escape_debug());
}
}
escape_utf8(string, &mut repr);
repr.push('"');
Literal::_new(repr)
}
Expand Down Expand Up @@ -1093,6 +1074,34 @@ impl Literal {
Literal::_new(repr)
}

pub fn c_string(string: &CStr) -> Literal {
let mut repr = "c\"".to_string();
let mut bytes = string.to_bytes();
while !bytes.is_empty() {
let (valid, invalid) = match str::from_utf8(bytes) {
Ok(all_valid) => {
bytes = b"";
(all_valid, bytes)
}
Err(utf8_error) => {
let (valid, rest) = bytes.split_at(utf8_error.valid_up_to());
let valid = str::from_utf8(valid).unwrap();
let invalid = utf8_error
.error_len()
.map_or(rest, |error_len| &rest[..error_len]);
bytes = &bytes[valid.len() + invalid.len()..];
(valid, invalid)
}
};
escape_utf8(valid, &mut repr);
for &byte in invalid {
let _ = write!(repr, r"\x{:02X}", byte);
}
}
repr.push('"');
Literal::_new(repr)
}

pub fn span(&self) -> Span {
self.span
}
Expand Down Expand Up @@ -1191,3 +1200,27 @@ impl Debug for Literal {
debug.finish()
}
}

fn escape_utf8(string: &str, repr: &mut String) {
let mut chars = string.chars();
while let Some(ch) = chars.next() {
if ch == '\0' {
repr.push_str(
if chars
.as_str()
.starts_with(|next| '0' <= next && next <= '7')
{
// circumvent clippy::octal_escapes lint
r"\x00"
} else {
r"\0"
},
);
} else if ch == '\'' {
// escape_debug turns this into "\'" which is unnecessary.
repr.push(ch);
} else {
repr.extend(ch.escape_debug());
}
}
}
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ use core::ops::Range;
use core::ops::RangeBounds;
use core::str::FromStr;
use std::error::Error;
use std::ffi::CStr;
#[cfg(procmacro2_semver_exempt)]
use std::path::PathBuf;

Expand Down Expand Up @@ -1244,6 +1245,11 @@ impl Literal {
Literal::_new(imp::Literal::byte_string(bytes))
}

/// C string literal.
pub fn c_string(string: &CStr) -> Literal {
Literal::_new(imp::Literal::c_string(string))
}

/// Returns the span encompassing this literal.
pub fn span(&self) -> Span {
Span::_new(self.inner.span())
Expand Down
20 changes: 20 additions & 0 deletions src/wrapper.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use core::fmt::{self, Debug, Display};
use core::ops::Range;
use core::ops::RangeBounds;
use core::str::FromStr;
use std::ffi::CStr;
use std::panic;
#[cfg(super_unstable)]
use std::path::PathBuf;
Expand Down Expand Up @@ -889,6 +890,25 @@ impl Literal {
}
}

pub fn c_string(string: &CStr) -> Literal {
if inside_proc_macro() {
Literal::Compiler({
#[cfg(not(no_literal_c_string))]
{
proc_macro::Literal::c_string(string)
}

#[cfg(no_literal_c_string)]
{
let fallback = fallback::Literal::c_string(string);
fallback.repr.parse::<proc_macro::Literal>().unwrap()
}
})
} else {
Literal::Fallback(fallback::Literal::c_string(string))
}
}

pub fn span(&self) -> Span {
match self {
Literal::Compiler(lit) => Span::Compiler(lit.span()),
Expand Down
24 changes: 24 additions & 0 deletions tests/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
)]

use proc_macro2::{Ident, Literal, Punct, Spacing, Span, TokenStream, TokenTree};
use std::ffi::CStr;
use std::iter;
use std::str::{self, FromStr};

Expand Down Expand Up @@ -164,6 +165,29 @@ fn literal_byte_string() {

#[test]
fn literal_c_string() {
assert_eq!(Literal::c_string(<&CStr>::default()).to_string(), "c\"\"");

let cstr = CStr::from_bytes_with_nul(b"aA\0").unwrap();
assert_eq!(Literal::c_string(cstr).to_string(), r#" c"aA" "#.trim());

let cstr = CStr::from_bytes_with_nul(b"\t\0").unwrap();
assert_eq!(Literal::c_string(cstr).to_string(), r#" c"\t" "#.trim());

let cstr = CStr::from_bytes_with_nul(b"\xE2\x9D\xA4\0").unwrap();
assert_eq!(Literal::c_string(cstr).to_string(), r#" c"❤" "#.trim());

let cstr = CStr::from_bytes_with_nul(b"'\0").unwrap();
assert_eq!(Literal::c_string(cstr).to_string(), r#" c"'" "#.trim());

let cstr = CStr::from_bytes_with_nul(b"\"\0").unwrap();
assert_eq!(Literal::c_string(cstr).to_string(), r#" c"\"" "#.trim());

let cstr = CStr::from_bytes_with_nul(b"\x7F\xFF\xFE\xCC\xB3\0").unwrap();
assert_eq!(
Literal::c_string(cstr).to_string(),
r#" c"\u{7f}\xFF\xFE\u{333}" "#.trim(),
);

let strings = r###"
c"hello\x80我叫\u{1F980}" // from the RFC
cr"\"
Expand Down