vt100 0.8.0

Library for parsing terminal data
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

use rand::Rng as _;

mod helpers;

#[derive(Clone, Debug)]
struct TerminalInput(Vec<u8>);

impl quickcheck::Arbitrary for TerminalInput {
    fn arbitrary<G: quickcheck::Gen>(g: &mut G) -> Self {
        let size = {
            let s = g.size();
            g.gen_range(0, s)
        };
        TerminalInput(
            (0..size)
                .map(|_| choose_terminal_input_fragment(g))
                .flatten()
                .collect(),
        )
    }

    fn shrink(&self) -> Box<dyn Iterator<Item = Self>> {
        Box::new(self.0.shrink().map(TerminalInput))
    }
}

#[allow(clippy::many_single_char_names)]
fn choose_terminal_input_fragment<G: quickcheck::Gen>(g: &mut G) -> Vec<u8> {
    enum Fragment {
        Text,
        Control,
        Escape,
        CSI,
        #[allow(dead_code)]
        OSC,
        #[allow(dead_code)]
        DCS,
    }

    impl rand::distributions::Distribution<Fragment>
        for rand::distributions::Standard
    {
        fn sample<R: rand::Rng + ?Sized>(&self, rng: &mut R) -> Fragment {
            match rng.gen() {
                0u8..=231 => Fragment::Text,
                232..=239 => Fragment::Control,
                240..=247 => Fragment::Escape,
                248..=255 => Fragment::CSI,
            }
        }
    }

    match g.gen() {
        Fragment::Text => {
            let mut u: u32 = g.gen_range(32, 2u32.pow(20) - 2048);
            // surrogates aren't valid codepoints on their own
            if u >= 0xD800 {
                u += 2048;
            }
            let c: Result<char, _> = std::convert::TryFrom::try_from(u);
            let c = match c {
                Ok(c) => c,
                Err(e) => panic!("failed to create char from {}: {}", u, e),
            };
            let mut b = [0; 4];
            let s = c.encode_utf8(&mut b);
            s.to_string().into_bytes()
        }
        Fragment::Control => vec![g.gen_range(7, 14)],
        Fragment::Escape => {
            let mut v = vec![0x1b];
            let c = g.gen_range(b'0', b'~');
            v.push(c);
            v
        }
        Fragment::CSI => {
            let mut v = vec![0x1b, b'['];
            // TODO: params
            let c = g.gen_range(b'@', b'~');
            v.push(c);
            v
        }
        Fragment::OSC => {
            // TODO
            unimplemented!()
        }
        Fragment::DCS => {
            // TODO
            unimplemented!()
        }
    }
    // TODO: sometimes add garbage in random places
}

fn contents_formatted_reproduces_state_random(input: Vec<u8>) -> bool {
    helpers::contents_formatted_reproduces_state(&input)
}

fn contents_formatted_reproduces_state_structured(
    input: TerminalInput,
) -> bool {
    helpers::contents_formatted_reproduces_state(&input.0)
}

#[test]
#[ignore]
fn qc_structured_long() {
    let mut qc = quickcheck::QuickCheck::new()
        .tests(1_000_000)
        .max_tests(1_000_000);
    qc.quickcheck(
        contents_formatted_reproduces_state_structured
            as fn(TerminalInput) -> bool,
    );
}

#[test]
fn qc_structured_short() {
    let mut qc = quickcheck::QuickCheck::new().tests(1_000).max_tests(1_000);
    qc.quickcheck(
        contents_formatted_reproduces_state_structured
            as fn(TerminalInput) -> bool,
    );
}

#[test]
#[ignore]
fn qc_random_long() {
    let mut qc = quickcheck::QuickCheck::new()
        .tests(10_000_000)
        .max_tests(10_000_000);
    qc.quickcheck(
        contents_formatted_reproduces_state_random as fn(Vec<u8>) -> bool,
    );
}

#[test]
fn qc_random_short() {
    let mut qc = quickcheck::QuickCheck::new()
        .tests(10_000)
        .max_tests(10_000);
    qc.quickcheck(
        contents_formatted_reproduces_state_random as fn(Vec<u8>) -> bool,
    );
}