graphite_binary 0.1.0

Efficient binary serialization for the graphite_minecraft project
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
use std::str::FromStr;

use anyhow::bail;

use crate::nbt::*;

pub fn from_snbt(mut snbt: &str) -> anyhow::Result<NBT> {
    let mut nodes = Vec::new();

    // todo: check if using peekable gives perf
    // let snbt = snbt.chars().peekable();

    // Make sure snbt starts with an opening brace
    let next_char = peek_non_whitespace(&mut snbt)?;
    if next_char == '{' {
        snbt = &snbt[1..];
    } else {
        bail!("from_snbt: snbt must start with opening brace ({{)")
    }

    // Parse the root compound
    let children = read_compound(&mut snbt, &mut nodes)?;

    // Make sure there is no more input
    for c in snbt.chars() {
        if !c.is_whitespace() {
            bail!("from_snbt: expected end of input")
        }
    }

    Ok(NBT {
        root_name: String::new(),
        root_children: children,
        nodes,
    })
}

fn read_node(snbt: &mut &str, nodes: &mut Vec<NBTNode>) -> anyhow::Result<(usize, TagType)> {
    let (node, type_id) = match peek_non_whitespace(snbt)? {
        '0'..='9' | '.' | '-' => read_numeric_node(snbt)?,
        '{' => {
            *snbt = &snbt[1..];
            (
                NBTNode::Compound(read_compound(snbt, nodes)?),
                TAG_COMPOUND_ID,
            )
        }
        '[' => {
            *snbt = &snbt[1..];
            read_array_node(snbt, nodes)?
        }
        '"' => (NBTNode::String(read_string(snbt)?), TAG_STRING_ID),
        't' => {
            if snbt.len() >= 4 && &snbt[..4] == "true" {
                (NBTNode::Byte(1), TAG_BYTE_ID)
            } else {
                bail!("unknown start of type: t");
            }
        }
        'f' => {
            if snbt.len() >= 5 && &snbt[..5] == "false" {
                (NBTNode::Byte(0), TAG_BYTE_ID)
            } else {
                bail!("unknown start of type: f");
            }
        }
        c => bail!("unknown start of type: {}", c),
    };

    nodes.push(node);
    Ok((nodes.len() - 1, type_id))
}

fn peek_non_whitespace(snbt: &mut &str) -> anyhow::Result<char> {
    for (index, c) in snbt.char_indices() {
        if !c.is_whitespace() {
            // Skip the whitespace
            // snbt[0] will be c
            *snbt = &snbt[index..];
            return Ok(c);
        }
    }
    bail!("next_char: unexpected end of input");
}

fn read_compound(snbt: &mut &str, nodes: &mut Vec<NBTNode>) -> anyhow::Result<NBTCompound> {
    let mut children = NBTCompound(Vec::new());

    // Special case for empty compound `{}`
    let next_char = peek_non_whitespace(snbt)?;
    if next_char == '}' {
        *snbt = &snbt[1..];
        return Ok(children);
    }

    loop {
        let name = read_key(snbt)?;

        if peek_non_whitespace(snbt)? == ':' {
            *snbt = &snbt[1..];
        } else {
            bail!("read_compound: key must be followed by a colon (:)")
        }

        let (idx, _type_id) = read_node(snbt, nodes)?;

        match children.binary_search(name.as_ref()) {
            Ok(_) => bail!("read_compound: duplicate key"),
            Err(index) => {
                children.0.insert(index, (name.into(), idx));
            }
        }

        match peek_non_whitespace(snbt)? {
            '}' => {
                *snbt = &snbt[1..];
                return Ok(children);
            }
            ',' => *snbt = &snbt[1..],
            c => bail!("read_compound: unknown continuation: {}", c),
        }
    }
}

fn read_key(snbt: &mut &str) -> anyhow::Result<String> {
    let first_char = peek_non_whitespace(snbt)?;

    if first_char == '"' {
        read_string(snbt)
    } else {
        for (index, c) in snbt.char_indices() {
            match c {
                '0'..='9' | 'A'..='Z' | 'a'..='z' | '.' | '_' | '+' | '-' => continue,
                ':' => {
                    let string = snbt[..index].into();
                    *snbt = &snbt[index..];
                    return Ok(string);
                }
                c => bail!("read_key: invalid character: {}", c),
            }
        }
        bail!("read_key: unexpected end of input");
    }
}

fn read_string(snbt: &mut &str) -> anyhow::Result<String> {
    let first_char = peek_non_whitespace(snbt)?;

    if first_char != '"' {
        bail!("read_string: first character must be quote literal (\")");
    } else {
        *snbt = &snbt[1..];

        let mut string = String::new();
        let mut start = 0;
        let mut escaping = false;

        for (index, c) in snbt.char_indices() {
            match c {
                '\\' => {
                    if escaping {
                        escaping = false;
                    } else {
                        string.push_str(&snbt[start..index]);
                        start = index + 1;
                    }
                }
                '"' => {
                    if escaping {
                        escaping = false;
                    } else {
                        string.push_str(&snbt[start..index]);
                        *snbt = &snbt[(index + 1)..];
                        return Ok(string);
                    }
                }
                c => {
                    if escaping {
                        bail!("read_string: unknown escape sequence: \\{}", c);
                    } else {
                        continue;
                    }
                }
            }
        }
        bail!("read_string: unexpected end of input");
    }
}

fn read_numeric_node(snbt: &mut &str) -> anyhow::Result<(NBTNode, TagType)> {
    let mut has_decimal = false;
    for (index, c) in snbt.char_indices() {
        match c {
            '-' => {
                if index != 0 {
                    bail!("read_numeric_node: minus literal (-) is only valid at the beginning")
                }
            }
            '0'..='9' => {
                continue;
            }
            '.' => {
                if has_decimal {
                    bail!("read_numeric_node: found multiple decimal points while parsing number");
                } else {
                    has_decimal = true;
                }
                continue;
            }
            'b' | 'B' => {
                let number_string = &snbt[..index];
                *snbt = &snbt[(index + 1)..];
                return Ok((NBTNode::Byte(number_string.parse()?), TAG_BYTE_ID));
            }
            's' | 'S' => {
                let number_string = &snbt[..index];
                *snbt = &snbt[(index + 1)..];
                return Ok((NBTNode::Short(number_string.parse()?), TAG_SHORT_ID));
            }
            'l' | 'L' => {
                let number_string = &snbt[..index];
                *snbt = &snbt[(index + 1)..];
                return Ok((NBTNode::Long(number_string.parse()?), TAG_LONG_ID));
            }
            'f' | 'F' => {
                let number_string = &snbt[..index];
                *snbt = &snbt[(index + 1)..];
                return Ok((NBTNode::Float(number_string.parse()?), TAG_FLOAT_ID));
            }
            'd' | 'D' => {
                let number_string = &snbt[..index];
                *snbt = &snbt[(index + 1)..];
                return Ok((NBTNode::Double(number_string.parse()?), TAG_DOUBLE_ID));
            }
            _ => {
                let number_string = &snbt[..index];
                *snbt = &snbt[index..];
                if has_decimal {
                    return Ok((NBTNode::Double(number_string.parse()?), TAG_DOUBLE_ID));
                } else {
                    return Ok((NBTNode::Int(number_string.parse()?), TAG_INT_ID));
                }
            }
        }
    }
    bail!("read_numeric_node: unexpected end of input");
}

enum PrimArrParseState {
    WaitingForNumber,
    WaitingForComma,
    InNumber { start: usize },
}

fn read_array_node(snbt: &mut &str, nodes: &mut Vec<NBTNode>) -> anyhow::Result<(NBTNode, TagType)> {
    let next_char = peek_non_whitespace(snbt)?;
    match next_char {
        // Primitive ByteArray
        'B' => {
            *snbt = &snbt[1..];
            match peek_non_whitespace(snbt)? {
                ';' => *snbt = &snbt[1..],
                _ => bail!("read_array_node: expect semicolon (;) after B"),
            }

            Ok((
                NBTNode::ByteArray(read_primitive_array(snbt)?),
                TAG_BYTE_ARRAY_ID,
            ))
        }
        // Primitive IntArray
        'I' => {
            *snbt = &snbt[1..];
            match peek_non_whitespace(snbt)? {
                ';' => *snbt = &snbt[1..],
                _ => bail!("read_array_node: expect semicolon (;) after I"),
            }

            Ok((
                NBTNode::IntArray(read_primitive_array(snbt)?),
                TAG_INT_ARRAY_ID,
            ))
        }
        // Primitive LongArray
        'L' => {
            *snbt = &snbt[1..];
            match peek_non_whitespace(snbt)? {
                ';' => *snbt = &snbt[1..],
                _ => bail!("read_array_node: expect semicolon (;) after L"),
            }

            Ok((
                NBTNode::LongArray(read_primitive_array(snbt)?),
                TAG_LONG_ARRAY_ID,
            ))
        }
        // Special case for empty list `[]`
        ']' => {
            *snbt = &snbt[1..];
            Ok((
                NBTNode::List {
                    type_id: TAG_END_ID,
                    children: Vec::new(),
                },
                TAG_LIST_ID,
            ))
        }
        // Normal list
        _ => {
            let mut children = Vec::new();

            let (idx, first_type_id) = read_node(snbt, nodes)?;
            children.push(idx);

            loop {
                match peek_non_whitespace(snbt)? {
                    ']' => {
                        *snbt = &snbt[1..];
                        return Ok((
                            NBTNode::List {
                                type_id: first_type_id,
                                children,
                            },
                            TAG_LIST_ID,
                        ));
                    }
                    ',' => *snbt = &snbt[1..],
                    c => bail!("read_array_node: unknown continuation: {}", c),
                }

                let (idx, type_id) = read_node(snbt, nodes)?;
                children.push(idx);

                if type_id != first_type_id {
                    bail!("read_array_node: elements in array have different type")
                }
            }
        }
    }
}

fn read_primitive_array<T: FromStr>(snbt: &mut &str) -> anyhow::Result<Vec<T>> {
    let mut values = Vec::new();
    let mut state = PrimArrParseState::WaitingForNumber;
    for (index, c) in snbt.char_indices() {
        match c {
            ']' => {
                match state {
                    PrimArrParseState::WaitingForComma => (),
                    PrimArrParseState::WaitingForNumber => {
                        bail!("read_primitive_array: expected numeric character, got ]")
                    }
                    PrimArrParseState::InNumber { start } => {
                        let value: T = snbt[start..index].parse().map_err(|_| {
                            anyhow::anyhow!("read_primitive_array: failed to parse")
                        })?;
                        values.push(value);
                    }
                }

                *snbt = &snbt[(index + 1)..];
                return Ok(values);
            }
            '0'..='9' | '-' => match state {
                PrimArrParseState::WaitingForNumber => {
                    state = PrimArrParseState::InNumber { start: index }
                }
                PrimArrParseState::InNumber { start: _ } => continue,
                PrimArrParseState::WaitingForComma => {
                    bail!("read_primitive_array: expected comma, got numeric character")
                }
            },
            ',' => {
                match state {
                    PrimArrParseState::WaitingForComma => (),
                    PrimArrParseState::WaitingForNumber => {
                        bail!("read_primitive_array: expected numeric character, got comma")
                    }
                    PrimArrParseState::InNumber { start } => {
                        let value: T = snbt[start..index].parse().map_err(|_| {
                            anyhow::anyhow!("read_primitive_array: failed to parse")
                        })?;
                        values.push(value);
                    }
                }
                state = PrimArrParseState::WaitingForNumber;
            }
            ' ' => continue,
            c => {
                // todo: this is very permissive
                // this should only allow b/B (for byte arrays), l/L (for long arrays) and nothing for int arrays
                match state {
                    PrimArrParseState::WaitingForComma => {
                        bail!("read_primitive_array: expected comma, got `{}`", c)
                    }
                    PrimArrParseState::WaitingForNumber => bail!(
                        "read_primitive_array: expected numeric character, got `{}`",
                        c
                    ),
                    PrimArrParseState::InNumber { start } => {
                        let value: T = snbt[start..index].parse().map_err(|_| {
                            anyhow::anyhow!("read_primitive_array: failed to parse")
                        })?;
                        values.push(value);
                    }
                }
                state = PrimArrParseState::WaitingForComma;
            }
        }
    }
    bail!("read_array_node: unexpected end of input");
}