use fancy_regex::Regex;
use std::sync::LazyLock;
static NEEDS_QUOTING_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(r#"[\[\]:`\{\}#'";\(\)\|\$,\.\d\s\x00!?=]|(?i)^[+\-]?(inf(inity)?|nan)$"#)
.expect("internal error: NEEDS_QUOTING_REGEX didn't compile")
});
pub fn needs_quoting(string: &str) -> bool {
if string.is_empty() {
return true;
}
match string {
"true" | "false" | "null" | "&&" => return true,
_ => (),
};
NEEDS_QUOTING_REGEX.is_match(string).unwrap_or(false)
}
pub fn escape_quote_string(string: &str) -> String {
let mut output = String::with_capacity(string.len() + 2);
output.push('"');
for c in string.chars() {
match c {
'"' | '\\' => {
output.push('\\');
output.push(c);
}
'\0' => output.push_str("\\0"),
_ => output.push(c),
}
}
output.push('"');
output
}
pub fn as_raw_string(s: &str) -> Option<String> {
if s.contains('\0') || !s.contains(['"', '\\']) {
return None;
}
let mut hash_count = 1;
loop {
let hashes = "#".repeat(hash_count);
let closing = format!("'{}", hashes);
if !s.starts_with(&hashes) && !s.contains(&closing) {
return Some(format!("r{hashes}'{s}'{hashes}"));
}
hash_count += 1;
}
}
#[cfg(test)]
mod tests {
use super::{as_raw_string, escape_quote_string, needs_quoting};
#[test]
fn escape_quote_string_escapes_nul_as_backslash_zero() {
assert_eq!(escape_quote_string("a\0b"), r#""a\0b""#);
assert_eq!(escape_quote_string("\0"), r#""\0""#);
assert!(
!escape_quote_string("\0").contains('\0'),
"the escaped form must not contain a raw NUL"
);
}
#[test]
fn escape_quote_string_still_escapes_quotes_and_backslashes() {
assert_eq!(escape_quote_string(r#"a"b"#), r#""a\"b""#);
assert_eq!(escape_quote_string(r"a\b"), r#""a\\b""#);
assert_eq!(escape_quote_string("a\0b\"c"), r#""a\0b\"c""#);
}
#[test]
fn needs_quoting_forces_a_nul_to_be_quoted() {
assert!(needs_quoting("a\0b"));
assert!(needs_quoting("\0"));
assert!(!needs_quoting("hello"));
assert!(!needs_quoting("plain_name"));
}
#[test]
fn raw_string_uses_single_hash_when_safe() {
assert_eq!(
as_raw_string(r#"hello \"world\""#),
Some(r#"r#'hello \"world\"'#"#.to_string())
);
}
#[test]
fn raw_string_is_refused_when_the_value_has_a_nul() {
for value in ["a\0\"b", "\0\"", "a\\b\0"] {
assert_eq!(
as_raw_string(value),
None,
"a NUL-bearing value must not take the raw form: {value:?}"
);
}
assert_eq!(
as_raw_string(r#"hello \"world\""#),
Some(r#"r#'hello \"world\"'#"#.to_string())
);
}
#[test]
fn raw_string_uses_more_hashes_for_quote_hash_sequence() {
assert_eq!(
as_raw_string(r#"contains '# and "quote""#),
Some(r##"r##'contains '# and "quote"'##"##.to_string())
);
}
#[test]
fn raw_string_uses_more_hashes_when_content_starts_with_hash() {
let input = "# example.toml\nname = \"my-app\"\nversion = \"1.0.0\"\n";
assert_eq!(
as_raw_string(input),
Some(
r##"r##'# example.toml
name = "my-app"
version = "1.0.0"
'##"##
.to_string()
)
);
}
#[test]
fn raw_string_scales_hash_count_for_longer_sequences() {
assert_eq!(
as_raw_string(r#"contains '## and "quote""#),
Some(r###"r###'contains '## and "quote"'###"###.to_string())
);
}
}