brink_format/inkb/
write.rs

1//! Encoding (write) half of the `.inkb` binary format.
2
3use crate::codec::{
4    crc32, write_def_id, write_i32, write_str, write_u8, write_u16, write_u32, write_u64,
5};
6use crate::definition::{
7    AddressDef, AddressPath, ContainerDef, ExternalFnDef, GlobalVarDef, LineEntry, ListDef,
8    ListItemDef, ScopeLineTable,
9};
10use crate::line::{LineContent, LinePart, PluralCategory, SelectKey};
11use crate::story::StoryData;
12use crate::value::{ListValue, Value, ValueType};
13
14use super::{
15    CAT_FEW, CAT_MANY, CAT_ONE, CAT_OTHER, CAT_TWO, CAT_ZERO, HEADER_PREAMBLE, KEY_CARDINAL,
16    KEY_EXACT, KEY_KEYWORD, KEY_ORDINAL, LINE_PLAIN, LINE_TEMPLATE, MAGIC, PART_LITERAL,
17    PART_SELECT, PART_SLOT, SECTION_COUNT, SECTION_ENTRY_SIZE, SectionKind, VAL_BOOL,
18    VAL_DIVERT_TARGET, VAL_FLOAT, VAL_FRAGMENT_REF, VAL_INT, VAL_LIST, VAL_NULL, VAL_STRING,
19    VAL_VAR_POINTER, VERSION,
20};
21
22// ── Tier 1: Full story write ────────────────────────────────────────────────
23
24/// Encode a [`StoryData`] into the `.inkb` binary format with sectioned header.
25#[expect(clippy::cast_possible_truncation)]
26pub fn write_inkb(story: &StoryData, buf: &mut Vec<u8>) {
27    let base = buf.len();
28    let header_size = HEADER_PREAMBLE + SECTION_COUNT as usize * SECTION_ENTRY_SIZE;
29
30    // Write placeholder header (zeros) — we'll patch it after writing sections.
31    buf.resize(base + header_size, 0);
32
33    // Track section offsets as we write each section.
34    let section_kinds = [
35        SectionKind::NameTable,
36        SectionKind::Variables,
37        SectionKind::ListDefs,
38        SectionKind::ListItems,
39        SectionKind::Externals,
40        SectionKind::Containers,
41        SectionKind::LineTables,
42        SectionKind::Labels,
43        SectionKind::ListLiterals,
44        SectionKind::AddressPaths,
45    ];
46    let mut section_offsets = [0u32; 10];
47
48    // 1. NameTable
49    section_offsets[0] = (buf.len() - base) as u32;
50    write_section_name_table(&story.name_table, buf);
51
52    // 2. Variables
53    section_offsets[1] = (buf.len() - base) as u32;
54    write_section_variables(&story.variables, buf);
55
56    // 3. ListDefs
57    section_offsets[2] = (buf.len() - base) as u32;
58    write_section_list_defs(&story.list_defs, buf);
59
60    // 4. ListItems
61    section_offsets[3] = (buf.len() - base) as u32;
62    write_section_list_items(&story.list_items, buf);
63
64    // 5. Externals
65    section_offsets[4] = (buf.len() - base) as u32;
66    write_section_externals(&story.externals, buf);
67
68    // 6. Containers
69    section_offsets[5] = (buf.len() - base) as u32;
70    write_section_containers(&story.containers, buf);
71
72    // 7. LineTables
73    section_offsets[6] = (buf.len() - base) as u32;
74    write_section_line_tables(&story.line_tables, buf);
75
76    // 8. Addresses (Labels section)
77    section_offsets[7] = (buf.len() - base) as u32;
78    write_section_addresses(&story.addresses, buf);
79
80    // 9. ListLiterals
81    section_offsets[8] = (buf.len() - base) as u32;
82    write_section_list_literals(&story.list_literals, buf);
83
84    // 10. AddressPaths
85    section_offsets[9] = (buf.len() - base) as u32;
86    write_section_address_paths(&story.address_paths, buf);
87
88    let file_size = (buf.len() - base) as u32;
89    let checksum = crc32(&buf[base + header_size..]);
90
91    // Patch header in-place.
92    let h = &mut buf[base..];
93    h[0..4].copy_from_slice(MAGIC);
94    h[4..6].copy_from_slice(&VERSION.to_le_bytes());
95    h[6] = SECTION_COUNT;
96    h[7] = 0; // reserved
97    h[8..12].copy_from_slice(&file_size.to_le_bytes());
98    h[12..16].copy_from_slice(&checksum.to_le_bytes());
99
100    for (i, kind) in section_kinds.iter().enumerate() {
101        let entry_base = HEADER_PREAMBLE + i * SECTION_ENTRY_SIZE;
102        h[entry_base] = *kind as u8;
103        h[entry_base + 1] = 0; // reserved
104        h[entry_base + 2] = 0;
105        h[entry_base + 3] = 0;
106        h[entry_base + 4..entry_base + 8].copy_from_slice(&section_offsets[i].to_le_bytes());
107    }
108}
109
110// ── Assembly ────────────────────────────────────────────────────────────────
111
112/// Assemble a complete `.inkb` file from pre-encoded section buffers.
113///
114/// Sections should be provided in the canonical order matching [`SectionKind`]
115/// tags. The header (with offsets and checksum) is computed automatically.
116#[expect(clippy::cast_possible_truncation)]
117pub fn assemble_inkb(sections: &[(SectionKind, &[u8])], out: &mut Vec<u8>) {
118    let base = out.len();
119    let section_count = sections.len() as u8;
120    let header_size = HEADER_PREAMBLE + sections.len() * SECTION_ENTRY_SIZE;
121
122    // Placeholder header.
123    out.resize(base + header_size, 0);
124
125    // Append section data and record offsets.
126    let mut entries: Vec<(SectionKind, u32)> = Vec::with_capacity(sections.len());
127    for (kind, data) in sections {
128        let offset = (out.len() - base) as u32;
129        entries.push((*kind, offset));
130        out.extend_from_slice(data);
131    }
132
133    let file_size = (out.len() - base) as u32;
134    let checksum = crc32(&out[base + header_size..]);
135
136    // Patch header.
137    let h = &mut out[base..];
138    h[0..4].copy_from_slice(MAGIC);
139    h[4..6].copy_from_slice(&VERSION.to_le_bytes());
140    h[6] = section_count;
141    h[7] = 0;
142    h[8..12].copy_from_slice(&file_size.to_le_bytes());
143    h[12..16].copy_from_slice(&checksum.to_le_bytes());
144
145    for (i, (kind, offset)) in entries.iter().enumerate() {
146        let entry_base = HEADER_PREAMBLE + i * SECTION_ENTRY_SIZE;
147        h[entry_base] = *kind as u8;
148        h[entry_base + 1] = 0;
149        h[entry_base + 2] = 0;
150        h[entry_base + 3] = 0;
151        h[entry_base + 4..entry_base + 8].copy_from_slice(&offset.to_le_bytes());
152    }
153}
154
155// ── Section writers ─────────────────────────────────────────────────────────
156
157/// Write the name table section (no header framing).
158#[expect(clippy::cast_possible_truncation)]
159pub fn write_section_name_table(names: &[String], buf: &mut Vec<u8>) {
160    write_u32(buf, names.len() as u32);
161    for name in names {
162        write_str(buf, name);
163    }
164}
165
166/// Write the variables section (no header framing).
167#[expect(clippy::cast_possible_truncation)]
168pub fn write_section_variables(variables: &[GlobalVarDef], buf: &mut Vec<u8>) {
169    write_u32(buf, variables.len() as u32);
170    for var in variables {
171        encode_global_var(var, buf);
172    }
173}
174
175/// Write the list definitions section (no header framing).
176#[expect(clippy::cast_possible_truncation)]
177pub fn write_section_list_defs(list_defs: &[ListDef], buf: &mut Vec<u8>) {
178    write_u32(buf, list_defs.len() as u32);
179    for ld in list_defs {
180        encode_list_def(ld, buf);
181    }
182}
183
184/// Write the list items section (no header framing).
185#[expect(clippy::cast_possible_truncation)]
186pub fn write_section_list_items(list_items: &[ListItemDef], buf: &mut Vec<u8>) {
187    write_u32(buf, list_items.len() as u32);
188    for li in list_items {
189        encode_list_item(li, buf);
190    }
191}
192
193/// Write the externals section (no header framing).
194#[expect(clippy::cast_possible_truncation)]
195pub fn write_section_externals(externals: &[ExternalFnDef], buf: &mut Vec<u8>) {
196    write_u32(buf, externals.len() as u32);
197    for ext in externals {
198        encode_external(ext, buf);
199    }
200}
201
202/// Write the containers section (no header framing).
203#[expect(clippy::cast_possible_truncation)]
204pub fn write_section_containers(containers: &[ContainerDef], buf: &mut Vec<u8>) {
205    write_u32(buf, containers.len() as u32);
206    for c in containers {
207        encode_container(c, buf);
208    }
209}
210
211/// Write the addresses section (no header framing).
212#[expect(clippy::cast_possible_truncation)]
213pub fn write_section_addresses(addresses: &[AddressDef], buf: &mut Vec<u8>) {
214    write_u32(buf, addresses.len() as u32);
215    for addr in addresses {
216        write_def_id(buf, addr.id);
217        write_def_id(buf, addr.container_id);
218        write_u32(buf, addr.byte_offset);
219    }
220}
221
222/// Write the address-paths section (no header framing).
223#[expect(clippy::cast_possible_truncation)]
224pub fn write_section_address_paths(address_paths: &[AddressPath], buf: &mut Vec<u8>) {
225    write_u32(buf, address_paths.len() as u32);
226    for ap in address_paths {
227        write_u16(buf, ap.path.0);
228        write_def_id(buf, ap.target);
229    }
230}
231
232// ── Encode helpers (private) ────────────────────────────────────────────────
233
234fn encode_global_var(v: &GlobalVarDef, buf: &mut Vec<u8>) {
235    write_def_id(buf, v.id);
236    write_u16(buf, v.name.0);
237    encode_value_type(v.value_type, buf);
238    encode_value(&v.default_value, buf);
239    write_u8(buf, u8::from(v.mutable));
240}
241
242fn encode_value_type(vt: ValueType, buf: &mut Vec<u8>) {
243    let tag = match vt {
244        ValueType::Int => VAL_INT,
245        ValueType::Float => VAL_FLOAT,
246        ValueType::Bool => VAL_BOOL,
247        ValueType::String => VAL_STRING,
248        ValueType::List => VAL_LIST,
249        ValueType::DivertTarget => VAL_DIVERT_TARGET,
250        ValueType::VariablePointer => VAL_VAR_POINTER,
251        // TempPointer is runtime-only and should never appear in .inkb files.
252        ValueType::FragmentRef => VAL_FRAGMENT_REF,
253        ValueType::TempPointer | ValueType::Null => VAL_NULL,
254    };
255    write_u8(buf, tag);
256}
257
258#[expect(clippy::cast_possible_truncation)]
259fn encode_value(v: &Value, buf: &mut Vec<u8>) {
260    match v {
261        Value::Int(n) => {
262            write_u8(buf, VAL_INT);
263            write_i32(buf, *n);
264        }
265        Value::Float(n) => {
266            write_u8(buf, VAL_FLOAT);
267            buf.extend_from_slice(&n.to_le_bytes());
268        }
269        Value::Bool(b) => {
270            write_u8(buf, VAL_BOOL);
271            write_u8(buf, u8::from(*b));
272        }
273        Value::String(s) => {
274            write_u8(buf, VAL_STRING);
275            write_str(buf, s);
276        }
277        Value::List(lv) => {
278            write_u8(buf, VAL_LIST);
279            write_u32(buf, lv.items.len() as u32);
280            for item in &lv.items {
281                write_def_id(buf, *item);
282            }
283            write_u32(buf, lv.origins.len() as u32);
284            for origin in &lv.origins {
285                write_def_id(buf, *origin);
286            }
287        }
288        Value::DivertTarget(id) => {
289            write_u8(buf, VAL_DIVERT_TARGET);
290            write_def_id(buf, *id);
291        }
292        Value::VariablePointer(id) => {
293            write_u8(buf, VAL_VAR_POINTER);
294            write_def_id(buf, *id);
295        }
296        Value::FragmentRef(idx) => {
297            write_u8(buf, VAL_FRAGMENT_REF);
298            write_u32(buf, *idx);
299        }
300        // TempPointer is runtime-only and should never appear in .inkb files.
301        Value::TempPointer { .. } | Value::Null => {
302            write_u8(buf, VAL_NULL);
303        }
304    }
305}
306
307#[expect(clippy::cast_possible_truncation)]
308fn encode_list_def(ld: &ListDef, buf: &mut Vec<u8>) {
309    write_def_id(buf, ld.id);
310    write_u16(buf, ld.name.0);
311    write_u32(buf, ld.items.len() as u32);
312    for (name_id, ordinal) in &ld.items {
313        write_u16(buf, name_id.0);
314        write_i32(buf, *ordinal);
315    }
316}
317
318fn encode_list_item(li: &ListItemDef, buf: &mut Vec<u8>) {
319    write_def_id(buf, li.id);
320    write_def_id(buf, li.origin);
321    write_i32(buf, li.ordinal);
322    write_u16(buf, li.name.0);
323}
324
325/// Write the list literals section (no header framing).
326#[expect(clippy::cast_possible_truncation)]
327pub fn write_section_list_literals(list_literals: &[ListValue], buf: &mut Vec<u8>) {
328    write_u32(buf, list_literals.len() as u32);
329    for lv in list_literals {
330        write_u32(buf, lv.items.len() as u32);
331        for item in &lv.items {
332            write_def_id(buf, *item);
333        }
334        write_u32(buf, lv.origins.len() as u32);
335        for origin in &lv.origins {
336            write_def_id(buf, *origin);
337        }
338    }
339}
340
341fn encode_external(ext: &ExternalFnDef, buf: &mut Vec<u8>) {
342    write_def_id(buf, ext.id);
343    write_u16(buf, ext.name.0);
344    write_u8(buf, ext.arg_count);
345    match ext.fallback {
346        Some(fb) => {
347            write_u8(buf, 1);
348            write_def_id(buf, fb);
349        }
350        None => {
351            write_u8(buf, 0);
352        }
353    }
354}
355
356#[expect(clippy::cast_possible_truncation)]
357fn encode_container(c: &ContainerDef, buf: &mut Vec<u8>) {
358    write_def_id(buf, c.id);
359    write_def_id(buf, c.scope_id);
360    match c.name {
361        Some(name_id) => {
362            write_u8(buf, 1);
363            write_u16(buf, name_id.0);
364        }
365        None => {
366            write_u8(buf, 0);
367        }
368    }
369    write_u8(buf, c.counting_flags.bits());
370    write_i32(buf, c.path_hash);
371    write_u32(buf, c.bytecode.len() as u32);
372    buf.extend_from_slice(&c.bytecode);
373}
374
375/// Write the line tables section (no header framing).
376#[expect(clippy::cast_possible_truncation)]
377pub fn write_section_line_tables(line_tables: &[ScopeLineTable], buf: &mut Vec<u8>) {
378    write_u32(buf, line_tables.len() as u32);
379    for lt in line_tables {
380        encode_scope_line_table(lt, buf);
381    }
382}
383
384#[expect(clippy::cast_possible_truncation)]
385fn encode_scope_line_table(lt: &ScopeLineTable, buf: &mut Vec<u8>) {
386    write_def_id(buf, lt.scope_id);
387    write_u32(buf, lt.lines.len() as u32);
388    for entry in &lt.lines {
389        encode_line_entry(entry, buf);
390    }
391}
392
393fn encode_line_entry(entry: &LineEntry, buf: &mut Vec<u8>) {
394    encode_line_content(&entry.content, buf);
395    write_u64(buf, entry.source_hash);
396    match &entry.audio_ref {
397        Some(audio) => {
398            write_u8(buf, 1);
399            write_str(buf, audio);
400        }
401        None => {
402            write_u8(buf, 0);
403        }
404    }
405
406    // Slot info
407    #[expect(clippy::cast_possible_truncation)]
408    write_u8(buf, entry.slot_info.len() as u8);
409    for slot in &entry.slot_info {
410        write_u8(buf, slot.index);
411        write_str(buf, &slot.name);
412    }
413
414    // Source location
415    match &entry.source_location {
416        Some(loc) => {
417            write_u8(buf, 1);
418            write_str(buf, &loc.file);
419            write_u32(buf, loc.range_start);
420            write_u32(buf, loc.range_end);
421        }
422        None => {
423            write_u8(buf, 0);
424        }
425    }
426}
427
428#[expect(clippy::cast_possible_truncation)]
429pub(crate) fn encode_line_content(content: &LineContent, buf: &mut Vec<u8>) {
430    match content {
431        LineContent::Plain(s) => {
432            write_u8(buf, LINE_PLAIN);
433            write_str(buf, s);
434        }
435        LineContent::Template(parts) => {
436            write_u8(buf, LINE_TEMPLATE);
437            write_u32(buf, parts.len() as u32);
438            for part in parts {
439                encode_line_part(part, buf);
440            }
441        }
442    }
443}
444
445#[expect(clippy::cast_possible_truncation)]
446fn encode_line_part(part: &LinePart, buf: &mut Vec<u8>) {
447    match part {
448        LinePart::Literal(s) => {
449            write_u8(buf, PART_LITERAL);
450            write_str(buf, s);
451        }
452        LinePart::Slot(idx) => {
453            write_u8(buf, PART_SLOT);
454            write_u8(buf, *idx);
455        }
456        LinePart::Select {
457            slot,
458            variants,
459            default,
460        } => {
461            write_u8(buf, PART_SELECT);
462            write_u8(buf, *slot);
463            write_u32(buf, variants.len() as u32);
464            for (key, text) in variants {
465                encode_select_key(key, buf);
466                write_str(buf, text);
467            }
468            write_str(buf, default);
469        }
470    }
471}
472
473fn encode_select_key(key: &SelectKey, buf: &mut Vec<u8>) {
474    match key {
475        SelectKey::Cardinal(cat) => {
476            write_u8(buf, KEY_CARDINAL);
477            encode_plural_category(*cat, buf);
478        }
479        SelectKey::Ordinal(cat) => {
480            write_u8(buf, KEY_ORDINAL);
481            encode_plural_category(*cat, buf);
482        }
483        SelectKey::Exact(n) => {
484            write_u8(buf, KEY_EXACT);
485            write_i32(buf, *n);
486        }
487        SelectKey::Keyword(k) => {
488            write_u8(buf, KEY_KEYWORD);
489            write_str(buf, k);
490        }
491    }
492}
493
494fn encode_plural_category(cat: PluralCategory, buf: &mut Vec<u8>) {
495    let tag = match cat {
496        PluralCategory::Zero => CAT_ZERO,
497        PluralCategory::One => CAT_ONE,
498        PluralCategory::Two => CAT_TWO,
499        PluralCategory::Few => CAT_FEW,
500        PluralCategory::Many => CAT_MANY,
501        PluralCategory::Other => CAT_OTHER,
502    };
503    write_u8(buf, tag);
504}
brink_format/inkb/write.rs

brink_format/inkb/
write.rs
