v_shellescape 0.3.5

/// Unix-specific escaping.
///

// ASCII codes blacklist characters
#[rustfmt::skip]
static BLACKLIST: [bool; 256] = byte_map![
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
//  \0                            \n
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
//  commands
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0,
//  \w !  "  #  $  %  &  '  (  )  *  +  ,  -  .  /
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 1, 1,
//  0  1  2  3  4  5  6  7  8  9  :  ;  <  =  >  ?
    1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
//  @  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0,
//  P  Q  R  S  T  U  V  W  X  Y  Z  [  \  ]  ^  _
    1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
//  `  a  b  c  d  e  f  g  h  i  j  k  l  m  n  o
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
//  p  q  r  s  t  u  v  w  x  y  z  {  |  }  ~  del
//   ====== Extended ASCII (aka. obs-text) ======
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
    ];

#[inline]
fn blacklisted(c: u8) -> bool {
    BLACKLIST[c as usize]
}

pub mod scalar {
    use super::blacklisted;

    #[inline]
    /// Escape characters that may have special meaning in a shell, including spaces.
    pub fn escape(bytes: &[u8], fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
        use std::char::from_u32_unchecked;
        use std::str::from_utf8_unchecked;

        let mut first = None;

        for (i, b) in bytes.iter().enumerate() {
            if blacklisted(*b) {
                first = Some(i);
                break;
            }
        }

        if let Some(first) = first {
            let mut start = 0;

            fmt.write_str("'")?;
            fmt.write_str(unsafe { from_utf8_unchecked(&bytes[..first]) })?;

            let bytes = &bytes[first..];

            for (i, b) in bytes.iter().enumerate() {
                let b = *b;
                if b == b'\'' || b == b'!' {
                    if start < i {
                        fmt.write_str(unsafe { from_utf8_unchecked(&bytes[start..i]) })?;
                    }
                    fmt.write_fmt(format_args!("'\\{}'", unsafe {
                        from_u32_unchecked(u32::from(b))
                    }))?;
                    start = i + 1;
                }
            }

            fmt.write_str(unsafe { from_utf8_unchecked(&bytes[start..]) })?;
            fmt.write_str("'")?;
        } else {
            fmt.write_str(unsafe { from_utf8_unchecked(bytes) })?;
        }

        Ok(())
    }
}

#[cfg(test)]
mod test {
    mod scalar {
        use super::super::scalar::escape as _escape;
        use std::fmt::{self, Display, Formatter};

        pub struct ShellEscape<'a> {
            bytes: &'a [u8],
        }
        _v_escape_escape_new!(ShellEscape);

        #[test]
        fn test() {
            assert_eq!(
                ShellEscape::from(
                    "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_=/,.+"
                )
                .to_string(),
                "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_=/,.+"
            );
            assert_eq!(
                ShellEscape::from("--aaa=bbb-ccc").to_string(),
                "--aaa=bbb-ccc"
            );
            assert_eq!(
                ShellEscape::from("linker=gcc -L/foo -Wl,bar").to_string(),
                r#"'linker=gcc -L/foo -Wl,bar'"#
            );
            assert_eq!(
                ShellEscape::from(r#"--features="default""#).to_string(),
                r#"'--features="default"'"#
            );
            assert_eq!(
                ShellEscape::from(r#"'!\$`\\\n "#).to_string(),
                r#"''\'''\!'\$`\\\n '"#
            );
        }
    }
}