1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
use crate::{Error, Result};
use std::borrow::Cow;
use std::str::Chars;
// String dedent implementation which does not distinguish between spaces, tabs or unicode
// whitespace but simply treats all of them as "one unit of whitespace".
//
// This is how the original HCL spec seems to handle it based on the original specsuite although it
// is not formally defined. E.g. ' ' (space) and '\u{2003}' (unicode "em-space") are treated as one
// unit of whitespace even though the former is 1 byte and the latter is 3 bytes long.
pub fn dedent(s: &str) -> Cow<str> {
if s.is_empty() {
return Cow::Borrowed(s);
}
let mut leading_ws = usize::MAX;
let mut non_empty_lines = 0;
// Find the minimum number of possible leading units of whitespace that can be be stripped off
// of each non-empty line.
for line in s.lines().filter(|line| !line.is_empty()) {
let line_leading_ws = line.chars().take_while(|ch| ch.is_whitespace()).count();
if line_leading_ws == 0 {
// Fast path: no dedent needed if we encounter a non-empty line which starts with a
// non-whitespace character.
return Cow::Borrowed(s);
}
leading_ws = leading_ws.min(line_leading_ws);
non_empty_lines += 1;
}
// Strip the determined amount of leading whitespace off of each line.
let mut dedented = String::with_capacity(s.len() - leading_ws * non_empty_lines);
for line in s.lines() {
if !line.is_empty() {
dedented.extend(line.chars().skip(leading_ws));
}
dedented.push('\n');
}
if dedented.ends_with('\n') && !s.ends_with('\n') {
let new_len = dedented.len() - 1;
dedented.truncate(new_len);
}
Cow::Owned(dedented)
}
/// Takes in a string with backslash escapes written out with literal backslash characters and
/// converts it to a string with the proper escaped characters.
///
/// ## Errors
///
/// Returns an error if an invalid or incomplete escape sequence or unicode code point is
/// encountered.
pub fn unescape(s: &str) -> Result<Cow<str>> {
for (idx, ch) in s.chars().enumerate() {
if ch == '\\' {
// At least one char needs unescaping so we need to return a new `String` instead of a
// borrowed `&str`.
return unescape_owned(s, idx).map(Cow::Owned);
}
}
Ok(Cow::Borrowed(s))
}
fn unescape_owned(s: &str, idx: usize) -> Result<String> {
let mut buf = String::with_capacity(s.len());
// Put all preceeding chars into buf already.
buf.push_str(&s[..idx]);
let mut chars = s[idx..].chars();
let mut scratch = String::new();
while let Some(ch) = chars.next() {
if ch != '\\' {
buf.push(ch);
continue;
}
let ch = match chars.next() {
Some('b') => '\u{0008}',
Some('f') => '\u{000C}',
Some('n') => '\n',
Some('r') => '\r',
Some('t') => '\t',
Some('\'') => '\'',
Some('\"') => '\"',
Some('\\') => '\\',
Some('u') => match unescape_unicode(&mut chars, &mut scratch) {
Some(ch) => ch,
None => return Err(Error::InvalidUnicodeCodePoint(scratch)),
},
Some(ch) => return Err(Error::InvalidEscape(ch)),
None => return Err(Error::Eof),
};
buf.push(ch);
}
Ok(buf)
}
fn unescape_unicode(chars: &mut Chars<'_>, scratch: &mut String) -> Option<char> {
scratch.clear();
for _ in 0..4 {
scratch.push(chars.next()?);
}
char::from_u32(u32::from_str_radix(scratch, 16).ok()?)
}
/// Like [`unescape`], but returns the original `&str` if it contains invalid escape sequences
/// instead of failing.
pub fn try_unescape(s: &str) -> Cow<str> {
match unescape(s) {
Ok(s) => s,
Err(_) => Cow::Borrowed(s),
}
}
/// Scan `s` for sequences that introduce a template interpolation or directive. Returns `true`
/// once it found one of these start markers, `false` otherwise.
///
/// This function only looks for start markers and does not check if the template is actually
/// valid.
#[inline]
pub fn is_templated(s: &str) -> bool {
if s.len() < 3 {
return false;
}
let mut skip_next = false;
// Because calling `s.contains("${")` would also match escaped interpolations (`$${`) a
// window iterator is used here to detect and ignore these. The same applies to escaped
// directives.
for window in s.as_bytes().windows(3) {
if skip_next {
skip_next = false;
continue;
}
match window {
[b'$', b'$', b'{'] | [b'%', b'%', b'{'] => {
// The next window would incorrectly match the next arm, so it must be
// skipped.
skip_next = true;
}
[b'$' | b'%', b'{', _] => return true,
_ => {}
}
}
false
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_is_templated() {
assert!(is_templated("${a}"));
assert!(is_templated("${\"a\"}"));
assert!(is_templated("%{ if foo }foo%{ else }bar%{ endif }"));
assert!(is_templated("$${ introduces an ${\"interpolation\"}"));
assert!(!is_templated(
"escaped directive %%{ if foo }foo%%{ else }bar%%{ endif }"
));
assert!(!is_templated("escaped interpolation $${a}"));
}
}