hldemo 0.3.0

A parser for Half-Life (Goldsource) demo files using nom.
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

use super::*;

#[test]
fn basic() {
    let bytes = include_bytes!("../test-demos/basic.dem");
    let demo = Demo::parse(bytes).unwrap();

    // Header
    assert_eq!(demo.header.demo_protocol, 5);
    assert_eq!(demo.header.net_protocol, 48);

    let mut map_name = [0; 260];
    map_name[..4].copy_from_slice(b"c1a0");
    assert_eq!(demo.header.map_name, &map_name[..]);

    let mut game_dir = [0; 260];
    game_dir[..5].copy_from_slice(b"valve");
    assert_eq!(demo.header.game_dir, &game_dir[..]);

    assert_eq!(demo.header.map_crc, 0);
    assert_eq!(demo.header.directory_offset, 193192);

    // Directory
    assert_eq!(demo.directory.entries.len(), 2);

    // Entry 1
    let entry = &demo.directory.entries[0];
    assert_eq!(entry.entry_type, 0);

    let mut description = [0; 64];
    description[..7].copy_from_slice(b"LOADING");
    assert_eq!(entry.description, &description[..]);

    assert_eq!(entry.flags, 0);
    assert_eq!(entry.cd_track, -1);
    assert_eq!(entry.track_time, 0f32);
    assert_eq!(entry.frame_count, 0);
    assert_eq!(entry.offset, 544);
    assert_eq!(entry.file_length, 25268);

    assert_eq!(entry.frames.len(), 6);

    // Entry 2
    let entry = &demo.directory.entries[1];
    assert_eq!(entry.entry_type, 1);

    let mut description = [0; 64];
    description[..8].copy_from_slice(b"Playback");
    assert_eq!(entry.description, &description[..]);

    assert_eq!(entry.flags, 0);
    assert_eq!(entry.cd_track, -1);
    // Not sure how good of an idea this one is, but it seems to work.
    assert_eq!(entry.track_time, 2.8860817f32);
    assert_eq!(entry.frame_count, 289);
    assert_eq!(entry.offset, 25812);
    assert_eq!(entry.file_length, 167380);

    assert_eq!(entry.frames.len(), 911);
}

#[test]
fn without_frames() {
    let bytes = include_bytes!("../test-demos/basic.dem");
    let demo = Demo::parse_without_frames(bytes).unwrap();

    assert!(demo.directory.entries[0].frames.is_empty());
    assert!(demo.directory.entries[1].frames.is_empty());
}

#[test]
fn frame_types() {
    let bytes = include_bytes!("../test-demos/frame-types.dem");
    let demo = Demo::parse(bytes).unwrap();
    let frames = &demo.directory.entries[0].frames;

    assert!(if let FrameData::NetMsg(_) = frames[0].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::DemoStart = frames[1].data {
                true
            } else {
                false
            });

    let mut command = [0; 64];
    command[..11].copy_from_slice(b"hello world");
    assert!(if let FrameData::ConsoleCommand(ConsoleCommandData { command: c }) = frames[2].data {
                c == &command[..]
            } else {
                false
            });

    assert!(if let FrameData::ClientData(_) = frames[3].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::Event(_) = frames[4].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::WeaponAnim(_) = frames[5].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::Sound(_) = frames[6].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::DemoBuffer(_) = frames[7].data {
                true
            } else {
                false
            });
    assert!(if let FrameData::NextSection = frames[8].data {
                true
            } else {
                false
            });
}

#[test]
fn error_invalid_magic() {
    let bytes = include_bytes!("../test-demos/invalid-magic.dem");
    let error = Demo::parse_without_frames(bytes).err().unwrap();
    let mut error_iter = error.iter();

    // Can't downcast errors. :(
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::Header));
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::InvalidMagic));
}

#[test]
fn error_invalid_demo_protocol() {
    let bytes = include_bytes!("../test-demos/invalid-demo-protocol.dem");
    let error = Demo::parse_without_frames(bytes).err().unwrap();
    let mut error_iter = error.iter();

    // Can't downcast errors. :(
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::Header));
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::InvalidDemoProtocol(4)));
}

#[test]
fn error_invalid_directory_entry_count() {
    let bytes = include_bytes!("../test-demos/invalid-directory-entry-count.dem");
    let error = Demo::parse_without_frames(bytes).err().unwrap();
    let mut error_iter = error.iter();

    // Can't downcast errors. :(
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::Directory));
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::InvalidDirectoryEntryCount(65535)));
}

#[test]
fn error_invalid_netmsg_length() {
    let bytes = include_bytes!("../test-demos/invalid-netmsg-length.dem");
    let error = Demo::parse(bytes).err().unwrap();
    let mut error_iter = error.iter();

    // Can't downcast errors. :(
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::Frames));
    assert_eq!(format!("{}", error_iter.next().unwrap()),
               format!("{}", parse::Error::InvalidNetMsgLength(16777215)));
}