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
use serde_derive::Serialize;
use crate::builtin_types;
use crate::builtin_types::BuiltinTypeClass;
use crate::parser;
use crate::parser::{ElementTypeRef, StructDefn, ArrayLen};
use crate::type_check::TSchema;
#[derive(PartialEq, Debug, Serialize)]
pub struct Nugget {
pub start: usize,
pub len: usize,
pub name: String,
pub value: Option<String>,
pub children: Vec<Nugget>,
}
pub fn apply_schema(schema: &TSchema, file_data: &[u8]) -> Nugget {
// We know this struct must exist, as we checked for it during the correctness checks
let root_struct = schema.types.get("root").unwrap();
let start = 0;
build_nugget(start, root_struct, "root", schema, file_data)
}
fn build_nugget(
start: usize,
struct_defn: &StructDefn,
name: &str,
schema: &TSchema,
file_data: &[u8],
) -> Nugget {
let mut len = 0;
let mut children = Vec::new();
for element in &struct_defn.elements {
let (nugget, size) = match &element.kind {
ElementTypeRef::TypeName(typename) => {
build_single_val(typename, start + len, file_data, &element.name, schema)
}
ElementTypeRef::ArrayElem(array_defn) => build_array_val(
array_defn,
start + len,
file_data,
&element.name,
schema,
&children,
),
};
len += size;
children.push(nugget);
}
Nugget {
start,
len,
name: name.to_string(),
value: None,
children,
}
}
fn build_single_val(
typename: &str,
start: usize,
file_data: &[u8],
name: &str,
schema: &TSchema,
) -> (Nugget, usize) {
if builtin_types::is_builtin_type(typename) {
let elem_data = file_data.get(start..).unwrap();
// is_builtin_type returned true, so this value must exist
let (size, value) = builtin_types::get_value(elem_data, typename).unwrap();
let child = Nugget {
start: start,
len: size,
name: name.to_string(),
value: Some(value),
children: Vec::new(),
};
(child, size)
} else {
// Must exist, as typechecking has passed for the schema
let child_kind = schema.types.get(typename).unwrap();
let child = build_nugget(start, child_kind, name, schema, file_data);
let len = child.len;
(child, len)
}
}
fn build_array_val(
array_defn: &parser::ArrayDefn,
start: usize,
file_data: &[u8],
name: &str,
schema: &TSchema,
siblings: &Vec<Nugget>,
) -> (Nugget, usize) {
let mut children = Vec::new();
let mut size = 0;
let value: Option<String>;
// Get the array len
let arr_len = get_elem_size_value(&array_defn.length, siblings).unwrap();
// If we have a text type, then build up the individual characters into a single text string
if builtin_types::is_type_class(&array_defn.kind, BuiltinTypeClass::Text) {
let mut text_value = String::new();
for _ in 0..arr_len {
let elem_data = file_data.get((start + size)..).unwrap();
let (char_size, char_value) =
builtin_types::get_value(elem_data, &array_defn.kind).unwrap();
text_value += &char_value;
size += char_size;
}
value = Some(text_value)
} else {
// Otherwise, treat each array entry individually
for i in 0..arr_len {
let child_name = i.to_string();
let (child, len) = build_single_val(
&array_defn.kind,
start + size,
file_data,
&child_name,
schema,
);
children.push(child);
size += len;
}
value = None;
}
(
Nugget {
start,
len: size,
name: name.to_string(),
value,
children,
},
size,
)
}
fn get_elem_size_value(len: &ArrayLen, nuggets: &Vec<Nugget>) -> Option<u32> {
match len {
ArrayLen::Identifier(name) => {
// Simple linear search among sibling nuggets for referenced value
for nugget in nuggets {
if nugget.name == *name {
let value = &nugget.value.as_ref().unwrap();
return Some(value.parse::<u32>().unwrap());
}
}
None
},
ArrayLen::Static(i) => Some(*i),
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::compile_schema_file;
#[test]
fn u8_struct() {
let schema =
compile_schema_file("struct root {val1: int8, val2: int8, val3: int8}").unwrap();
let res = apply_schema(&schema, b"\x00\x01\x02");
assert_eq!(
res,
Nugget {
start: 0,
len: 3,
name: "root".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 1,
name: "val1".to_string(),
value: Some("0".to_string()),
children: Vec::new(),
},
Nugget {
start: 1,
len: 1,
name: "val2".to_string(),
value: Some("1".to_string()),
children: Vec::new(),
},
Nugget {
start: 2,
len: 1,
name: "val3".to_string(),
value: Some("2".to_string()),
children: Vec::new(),
}
],
}
);
}
#[test]
fn u8_i16_struct() {
let schema =
compile_schema_file("struct root {val1: int8, val2: int16_le, val3: int8}").unwrap();
let res = apply_schema(&schema, b"\x00\x01\x00\x02");
assert_eq!(
res,
Nugget {
start: 0,
len: 4,
name: "root".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 1,
name: "val1".to_string(),
value: Some("0".to_string()),
children: Vec::new(),
},
Nugget {
start: 1,
len: 2,
name: "val2".to_string(),
value: Some("1".to_string()),
children: Vec::new(),
},
Nugget {
start: 3,
len: 1,
name: "val3".to_string(),
value: Some("2".to_string()),
children: Vec::new(),
}
],
}
);
}
#[test]
fn child_structs() {
let schema =
compile_schema_file("struct root {version1: Version, version2: Version} struct Version {major: int8, minor: int8}").unwrap();
let res = apply_schema(&schema, b"\x00\x01\x02\x03");
assert_eq!(
res,
Nugget {
start: 0,
len: 4,
name: "root".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 2,
name: "version1".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 1,
name: "major".to_string(),
value: Some("0".to_string()),
children: Vec::new(),
},
Nugget {
start: 1,
len: 1,
name: "minor".to_string(),
value: Some("1".to_string()),
children: Vec::new(),
}
]
},
Nugget {
start: 2,
len: 2,
name: "version2".to_string(),
value: None,
children: vec![
Nugget {
start: 2,
len: 1,
name: "major".to_string(),
value: Some("2".to_string()),
children: Vec::new(),
},
Nugget {
start: 3,
len: 1,
name: "minor".to_string(),
value: Some("3".to_string()),
children: Vec::new(),
}
]
}
]
}
);
}
#[test]
fn array() {
let schema = compile_schema_file("struct root {len: int8, arr: [uint8; len]}").unwrap();
let res = apply_schema(&schema, b"\x02\x00\x01");
assert_eq!(
res,
Nugget {
start: 0,
len: 3,
name: "root".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 1,
name: "len".to_string(),
value: Some("2".to_string()),
children: Vec::new(),
},
Nugget {
start: 1,
len: 2,
name: "arr".to_string(),
value: None,
children: vec![
Nugget {
start: 1,
len: 1,
name: "0".to_string(),
value: Some("0".to_string()),
children: Vec::new(),
},
Nugget {
start: 2,
len: 1,
name: "1".to_string(),
value: Some("1".to_string()),
children: Vec::new(),
}
],
}
]
}
);
// Same schema, zero length array
let res = apply_schema(&schema, b"\x00");
assert_eq!(
res,
Nugget {
start: 0,
len: 1,
name: "root".to_string(),
value: None,
children: vec![
Nugget {
start: 0,
len: 1,
name: "len".to_string(),
value: Some("0".to_string()),
children: Vec::new(),
},
Nugget {
start: 1,
len: 0,
name: "arr".to_string(),
value: None,
children: Vec::new(),
}
]
}
);
}
}