bashkit 0.20.1

Awesomely fast virtual sandbox with bash and file system
Documentation 
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

//! Helpers for words kept as written in the source.
//!
//! Important decision: bash prints function bodies (`type`, `declare -f`)
//! with each word exactly as written, so the parser records word source text
//! inside function definitions (`Word::raw`). These helpers derive the
//! source-level pieces the parser cannot get from decoded tokens.

/// Quote-remove a here-document delimiter as written; the bool reports
/// whether any part of it was quoted (bash then reads the body literally).
pub(crate) fn heredoc_eof_from_raw(raw: &str) -> (String, bool) {
    let mut eof = String::new();
    let mut quoted = false;
    let mut chars = raw.chars().peekable();
    while let Some(c) = chars.next() {
        match c {
            '\\' => {
                quoted = true;
                if let Some(n) = chars.next() {
                    eof.push(n);
                }
            }
            '\'' => {
                quoted = true;
                for n in chars.by_ref() {
                    if n == '\'' {
                        break;
                    }
                    eof.push(n);
                }
            }
            '"' => {
                quoted = true;
                while let Some(n) = chars.next() {
                    match n {
                        '"' => break,
                        '\\' if matches!(chars.peek(), Some('"' | '\\' | '$' | '`')) => {
                            if let Some(e) = chars.next() {
                                eof.push(e);
                            }
                        }
                        _ => eof.push(n),
                    }
                }
            }
            _ => eof.push(c),
        }
    }
    (eof, quoted)
}

/// Single-quote `s` for shell output (`'it'\''s'`).
pub(crate) fn single_quote(s: &str) -> String {
    format!("'{}'", s.replace('\'', "'\\''"))
}

/// Split source text on unquoted blanks, keeping quotes, escapes and
/// `$(..)`/`${..}` groups intact (compound array elements as written).
/// Backslash-newline continuations are dropped, as the lexer does.
pub(crate) fn split_raw_words(s: &str) -> Vec<String> {
    let mut out = Vec::new();
    let mut cur = String::new();
    let mut depth = 0usize;
    let mut chars = s.chars();
    while let Some(c) = chars.next() {
        match c {
            '\\' => match chars.next() {
                Some('\n') => {}
                Some(n) => {
                    cur.push(c);
                    cur.push(n);
                }
                None => cur.push(c),
            },
            '\'' => {
                cur.push(c);
                for n in chars.by_ref() {
                    cur.push(n);
                    if n == '\'' {
                        break;
                    }
                }
            }
            '"' => {
                cur.push(c);
                while let Some(n) = chars.next() {
                    cur.push(n);
                    if n == '\\' {
                        if let Some(e) = chars.next() {
                            cur.push(e);
                        }
                    } else if n == '"' {
                        break;
                    }
                }
            }
            '(' | '{' => {
                depth += 1;
                cur.push(c);
            }
            ')' | '}' => {
                depth = depth.saturating_sub(1);
                cur.push(c);
            }
            ' ' | '\t' | '\n' if depth == 0 => {
                if !cur.is_empty() {
                    out.push(std::mem::take(&mut cur));
                }
            }
            _ => cur.push(c),
        }
    }
    if !cur.is_empty() {
        out.push(cur);
    }
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn heredoc_delimiter_quote_removal() {
        assert_eq!(heredoc_eof_from_raw("EOF"), ("EOF".into(), false));
        assert_eq!(heredoc_eof_from_raw("'EOF'"), ("EOF".into(), true));
        assert_eq!(heredoc_eof_from_raw("\\E\\OF"), ("EOF".into(), true));
        assert_eq!(heredoc_eof_from_raw("E\"OF\""), ("EOF".into(), true));
    }

    #[test]
    fn single_quote_escapes_quotes() {
        assert_eq!(single_quote("it's"), "'it'\\''s'");
    }

    #[test]
    fn split_raw_words_keeps_quotes_and_groups() {
        assert_eq!(
            split_raw_words(" 1   2\n 3 "),
            vec!["1".to_string(), "2".into(), "3".into()]
        );
        assert_eq!(
            split_raw_words("'a b' \"c d\" $(x y) e\\ f"),
            vec![
                "'a b'".to_string(),
                "\"c d\"".into(),
                "$(x y)".into(),
                "e\\ f".into()
            ]
        );
    }
}