tmux-lib 0.5.0

Tmux helper functions.
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

use nom::{
    IResult, Parser,
    branch::alt,
    bytes::complete::{escaped, tag},
    character::complete::none_of,
    combinator::value,
    sequence::delimited,
};

/// Return the `&str` between single quotes. The returned string may be empty.
pub(crate) fn quoted_string(input: &str) -> IResult<&str, &str> {
    let esc = escaped(none_of("\\\'"), '\\', tag("'"));
    let esc_or_empty = alt((esc, tag("")));

    delimited(tag("'"), esc_or_empty, tag("'")).parse(input)
}

/// Return the `&str` between single quotes. The returned string may not be empty.
pub(crate) fn quoted_nonempty_string(input: &str) -> IResult<&str, &str> {
    let esc = escaped(none_of("\\\'"), '\\', tag("'"));
    delimited(tag("'"), esc, tag("'")).parse(input)
}

/// Return a bool: allowed values: `"true"` or `"false"`.
pub(crate) fn boolean(input: &str) -> IResult<&str, bool> {
    // This is a parser that returns `true` if it sees the string "true", and
    // an error otherwise.
    let parse_true = value(true, tag("true"));

    let parse_false = value(false, tag("false"));

    alt((parse_true, parse_false)).parse(input)
}

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

    #[test]
    fn test_quoted_nonempty_string() {
        let (input, res) = quoted_nonempty_string(r#"'foo\' 🤖 bar'"#).unwrap();
        assert!(input.is_empty());
        assert_eq!(res, r#"foo\' 🤖 bar"#);
        let (input, res) = quoted_nonempty_string("'λx → x'").unwrap();
        assert!(input.is_empty());
        assert_eq!(res, "λx → x");
        let (input, res) = quoted_nonempty_string("'  '").unwrap();
        assert!(input.is_empty());
        assert_eq!(res, "  ");

        assert!(quoted_nonempty_string("''").is_err());
    }

    #[test]
    fn test_quoted_string() {
        let (input, res) = quoted_string("''").unwrap();
        assert!(input.is_empty());
        assert!(res.is_empty());
    }

    #[test]
    fn test_quoted_string_with_content() {
        let (input, res) = quoted_string("'hello world'").unwrap();
        assert!(input.is_empty());
        assert_eq!(res, "hello world");
    }

    #[test]
    fn test_quoted_string_with_escaped_quote() {
        let (input, res) = quoted_string(r"'it\'s working'").unwrap();
        assert!(input.is_empty());
        assert_eq!(res, r"it\'s working");
    }

    #[test]
    fn test_quoted_string_leaves_remaining_input() {
        let (input, res) = quoted_string("'first':rest").unwrap();
        assert_eq!(input, ":rest");
        assert_eq!(res, "first");
    }

    #[test]
    fn test_quoted_string_fails_without_quotes() {
        assert!(quoted_string("no quotes").is_err());
    }

    #[test]
    fn test_quoted_string_fails_on_unclosed() {
        assert!(quoted_string("'unclosed").is_err());
    }

    #[test]
    fn test_quoted_nonempty_string_with_special_chars() {
        let (input, res) = quoted_nonempty_string("'path/to/file:with:colons'").unwrap();
        assert!(input.is_empty());
        assert_eq!(res, "path/to/file:with:colons");
    }

    #[test]
    fn test_quoted_nonempty_string_fails_on_empty() {
        assert!(quoted_nonempty_string("''").is_err());
    }

    #[test]
    fn test_boolean_true() {
        let (input, res) = boolean("true").unwrap();
        assert!(input.is_empty());
        assert!(res);
    }

    #[test]
    fn test_boolean_false() {
        let (input, res) = boolean("false").unwrap();
        assert!(input.is_empty());
        assert!(!res);
    }

    #[test]
    fn test_boolean_leaves_remaining_input() {
        let (input, res) = boolean("true:next").unwrap();
        assert_eq!(input, ":next");
        assert!(res);
    }

    #[test]
    fn test_boolean_fails_on_invalid() {
        assert!(boolean("yes").is_err());
        assert!(boolean("no").is_err());
        assert!(boolean("1").is_err());
        assert!(boolean("0").is_err());
        assert!(boolean("TRUE").is_err());
        assert!(boolean("FALSE").is_err());
    }

    #[test]
    fn test_boolean_fails_on_empty() {
        assert!(boolean("").is_err());
    }
}