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
//! Contains functions for performing XML special characters escaping.
use std::borrow::Cow;
use self::Value::{C, S};
use self::Process::{B, O};
enum Value {
C(char),
S(&'static str)
}
impl Value {
fn dispatch_for_attribute(c: char) -> Value {
match c {
'<' => S("<"),
'>' => S(">"),
'"' => S("""),
'\'' => S("'"),
'&' => S("&"),
_ => C(c)
}
}
fn dispatch_for_pcdata(c: char) -> Value {
match c {
'<' => S("<"),
'&' => S("&"),
_ => C(c)
}
}
}
enum Process<'a> {
B(&'a str),
O(String)
}
impl<'a> Process<'a> {
fn process(&mut self, (i, next): (usize, Value)) {
match next {
S(s) => if let O(ref mut o) = *self {
o.push_str(s);
} else if let B(b) = *self {
let mut r = String::with_capacity(b.len() + s.len());
r.push_str(&b[..i]);
r.push_str(s);
*self = O(r);
},
C(c) => match *self {
B(_) => {}
O(ref mut o) => o.push(c)
}
}
}
fn into_result(self) -> Cow<'a, str> {
match self {
B(b) => Cow::Borrowed(b),
O(o) => Cow::Owned(o)
}
}
}
impl<'a> Extend<Value> for Process<'a> {
fn extend<I: IntoIterator<Item=Value>>(&mut self, it: I) {
for v in it.into_iter().enumerate() {
self.process(v);
}
}
}
fn escape_str(s: &str, dispatch: fn(char) -> Value) -> Cow<str> {
let mut p = B(s);
p.extend(s.chars().map(dispatch));
p.into_result()
}
/// Performs escaping of common XML characters inside an attribute value.
///
/// This function replaces several important markup characters with their
/// entity equivalents:
///
/// * `<` → `<`
/// * `>` → `>`
/// * `"` → `"`
/// * `'` → `'`
/// * `&` → `&`
///
/// The resulting string is safe to use inside XML attribute values or in PCDATA sections.
///
/// Does not perform allocations if the given string does not contain escapable characters.
#[inline]
pub fn escape_str_attribute(s: &str) -> Cow<str> {
escape_str(s, Value::dispatch_for_attribute)
}
/// Performs escaping of common XML characters inside PCDATA.
///
/// This function replaces several important markup characters with their
/// entity equivalents:
///
/// * `<` → `<`
/// * `&` → `&`
///
/// The resulting string is safe to use inside PCDATA sections but NOT inside attribute values.
///
/// Does not perform allocations if the given string does not contain escapable characters.
#[inline]
pub fn escape_str_pcdata(s: &str) -> Cow<str> {
escape_str(s, Value::dispatch_for_pcdata)
}