lutra-codegen 0.6.1

Code generation for Lutra
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
use std::fmt::Write;

use lutra_bin::{ir, layout};

use crate::rust::Context;
use crate::rust::types::{
    is_option_enum, is_result_enum, is_unit_variant, variant_needs_box, write_ty_ref,
};

pub fn write_encode_impls(
    w: &mut impl Write,
    tys: &[ir::Ty],
    ctx: &mut Context,
) -> Result<(), std::fmt::Error> {
    if tys.is_empty() {
        return Ok(());
    }

    writeln!(w, "mod impls {{")?;
    writeln!(w, "#![allow(unused_imports)]")?;
    writeln!(w, "use {}::ReaderExt;", ctx.options.lutra_bin_path)?;
    writeln!(w, "use {}::bytes::BufMut;", ctx.options.lutra_bin_path)?;
    writeln!(w, "use super::*;\n")?;

    ctx.current_rust_mod.push("impls".into());
    for ty in tys {
        write_ty_def_impl(w, ty, ctx)?;
    }
    ctx.current_rust_mod.pop();

    ctx.def_buffer.clear(); // all defs must have been already generated

    writeln!(w, "}}")
}

/// Generates the impl encode for a type.
#[rustfmt::skip::macros(writeln)]
#[rustfmt::skip::macros(write)]
fn write_ty_def_impl(
    w: &mut impl Write,
    ty: &ir::Ty,
    ctx: &mut Context,
) -> Result<(), std::fmt::Error> {
    let lutra_bin = &ctx.options.lutra_bin_path;
    let name = ty.name.as_ref().unwrap();

    match &ty.kind {
        ir::TyKind::Primitive(_) | ir::TyKind::Ident(_) => {
            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = ();")?;
            writeln!(w, "    fn encode_head(&self, buf: &mut {lutra_bin}::bytes::BytesMut) {{")?;
            writeln!(w, "        self.0.encode_head(buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "    fn encode_body(&self, _: (), _: &mut {lutra_bin}::bytes::BytesMut) {{}}")?;
            writeln!(w, "}}")?;
        }

        ir::TyKind::Array(_) => {
            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = {lutra_bin}::ReversePointer;")?;
            writeln!(w, "    fn encode_head(&self, buf: &mut {lutra_bin}::bytes::BytesMut) -> Self::HeadPtr {{")?;
            writeln!(w, "        self.0.encode_head(buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "    fn encode_body(&self, head: Self::HeadPtr, buf: &mut {lutra_bin}::bytes::BytesMut) {{")?;
            writeln!(w, "        self.0.encode_body(head, buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "}}")?;
        }

        ir::TyKind::Enum(variants) if is_option_enum(variants) => {
            let inner_ty = &variants[1].ty;

            let mut inner_head_ptr = String::new();
            write_ty_ref(&mut inner_head_ptr, inner_ty, true, ctx)?;

            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = Option<Result<")?;
            writeln!(w, "         <{inner_head_ptr} as {lutra_bin}::Encode>::HeadPtr,")?;
            writeln!(w, "         {lutra_bin}::ReversePointer,")?;
            writeln!(w, "    >>;")?;
            writeln!(w, "    fn encode_head(&self, buf: &mut {lutra_bin}::bytes::BytesMut) -> Self::HeadPtr {{")?;
            writeln!(w, "        self.0.encode_head(buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "    fn encode_body(&self, head: Self::HeadPtr, buf: &mut {lutra_bin}::bytes::BytesMut) {{")?;
            writeln!(w, "        self.0.encode_body(head, buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "}}")?;
        }

        ir::TyKind::Enum(variants) if is_result_enum(variants, &ty.variants_recursive) => {
            let ok_ty = &variants[0].ty;
            let err_ty = &variants[1].ty;

            let mut ok_head_ptr = String::new();
            write_ty_ref(&mut ok_head_ptr, ok_ty, true, ctx)?;

            let mut err_head_ptr = String::new();
            write_ty_ref(&mut err_head_ptr, err_ty, true, ctx)?;

            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = core::result::Result<")?;
            writeln!(w, "        core::result::Result<")?;
            writeln!(w, "            <{ok_head_ptr} as {lutra_bin}::Encode>::HeadPtr,")?;
            writeln!(w, "            <{err_head_ptr} as {lutra_bin}::Encode>::HeadPtr,")?;
            writeln!(w, "        >,")?;
            writeln!(w, "        {lutra_bin}::ReversePointer,")?;
            writeln!(w, "    >;")?;
            writeln!(w, "    fn encode_head(&self, buf: &mut {lutra_bin}::bytes::BytesMut) -> Self::HeadPtr {{")?;
            writeln!(w, "        self.0.encode_head(buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "    fn encode_body(&self, head: Self::HeadPtr, buf: &mut {lutra_bin}::bytes::BytesMut) {{")?;
            writeln!(w, "        self.0.encode_body(head, buf)")?;
            writeln!(w, "    }}")?;
            writeln!(w, "}}")?;
        }

        ir::TyKind::Tuple(fields) => {
            writeln!(w, "#[allow(clippy::all, unused_variables)]")?;
            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = {name}HeadPtr;")?;

            // encode head
            writeln!(w, "    fn encode_head(&self, buf: &mut {lutra_bin}::bytes::BytesMut) -> Self::HeadPtr {{")?;
            for (index, field) in fields.iter().enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);

                writeln!(w, "        let {field_name} = self.{field_name}.encode_head(buf);")?;
            }
            writeln!(w, "        {name}HeadPtr {{")?;
            for (index, field) in fields.iter().enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);

                writeln!(w, "            {field_name},")?;
            }
            writeln!(w, "        }}")?;
            writeln!(w, "    }}")?;

            // encode body
            writeln!(w, "    fn encode_body(&self, head: Self::HeadPtr, buf: &mut {lutra_bin}::bytes::BytesMut) {{")?;

            for (index, field) in fields.iter().enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);

                writeln!(w, "        self.{field_name}.encode_body(head.{field_name}, buf);")?;
            }

            writeln!(w, "    }}")?;

            writeln!(w, "}}")?;

            // head ptr struct
            writeln!(w, "#[allow(non_camel_case_types)]")?;
            writeln!(w, "pub struct {name}HeadPtr {{")?;
            for (index, field) in fields.iter().enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);

                write!(w, "    {field_name}: <")?;

                write_ty_ref(w, &field.ty, true, ctx)?;

                writeln!(w, " as {lutra_bin}::Encode>::HeadPtr,")?;
            }
            writeln!(w, "}}")?;
        }

        ir::TyKind::Enum(variants) => {
            let head = layout::enum_head_format(variants, &ty.variants_recursive);

            let needs_head_ptr = head.has_ptr;
            let head_ptr_name = if needs_head_ptr {
                format!("{name}HeadPtr")
            } else {
                "()".to_string()
            };

            writeln!(w, "#[allow(unused_variables)]")?;
            writeln!(w, "#[allow(clippy::all)]")?;
            writeln!(w, "impl {lutra_bin}::Encode for {name} {{")?;
            writeln!(w, "    type HeadPtr = {head_ptr_name};")?;
            writeln!(w, "    fn encode_head(&self, w: &mut {lutra_bin}::bytes::BytesMut) -> {head_ptr_name} {{")?;
            writeln!(w, "        match self {{")?;

            for (tag, variant) in variants.iter().enumerate() {
                let va_format = layout::enum_variant_format(&head, &variant.ty);
                let va_name = crate::snake_to_sentence(&variant.name);

                write!(w, "            Self::{va_name}")?;

                if is_unit_variant(&variant.ty) {
                } else if head.inner_bytes == 0 {
                    write!(w, "(_)")?;
                } else {
                    write!(w, "(inner)")?;
                }
                writeln!(w, " => {{")?;

                let tag_bytes = &tag.to_le_bytes()[0..head.tag_bytes as usize];
                writeln!(w, "                w.put_slice(&{tag_bytes:?});")?;

                if needs_head_ptr {
                    if is_unit_variant(&variant.ty) {
                        writeln!(w, "                let r = {head_ptr_name}::None;")?;
                    } else if head.has_ptr {
                        writeln!(w, "                let head_ptr = {lutra_bin}::ReversePointer::new(w);")?;
                        writeln!(w, "                let r = {head_ptr_name}::{va_name}(head_ptr);")?;
                    } else {
                        writeln!(w, "                let inner_head_ptr = inner.encode_head(w);")?;
                        writeln!(w, "                let r = {head_ptr_name}::{va_name}({lutra_bin}::boxed::Box::new(inner_head_ptr));")?;
                    }
                } else if head.inner_bytes > 0 {
                    writeln!(w, "                inner.encode_head(w);")?;
                }

                if va_format.padding_bytes > 0 {
                    write!(w, "                w.put_bytes(0, {});", va_format.padding_bytes)?;
                }
                if needs_head_ptr {
                    writeln!(w, "                r")?;
                }

                writeln!(w, "            }},")?;
            }
            writeln!(w, "        }}")?;
            writeln!(w, "    }}")?;
            writeln!(w, "    fn encode_body(&self, head: {head_ptr_name}, w: &mut {lutra_bin}::bytes::BytesMut) {{")?;
            if needs_head_ptr {
                writeln!(w, "        match self {{")?;

                for variant in variants {
                    let va_name = crate::snake_to_sentence(&variant.name);

                    write!(w, "            Self::{va_name}")?;
                    if !is_unit_variant(&variant.ty) {
                        write!(w, "(inner)")?;
                    }
                    writeln!(w, " => {{")?;

                    if is_unit_variant(&variant.ty) {
                        // unit does not have a body
                    } else if head.has_ptr {
                        writeln!(w, "                let {head_ptr_name}::{va_name}(offset_ptr) = head else {{ unreachable!() }};")?;
                        writeln!(w, "                offset_ptr.write_cur_len(w);")?;
                        writeln!(w, "                let inner_head_ptr = inner.encode_head(w);")?;
                        writeln!(w, "                inner.encode_body(inner_head_ptr, w);")?;
                    } else {
                        writeln!(w, "                let {head_ptr_name}::{va_name}(inner_head_ptr) = head else {{ unreachable!() }};")?;
                        writeln!(w, "                inner.encode_body(*inner_head_ptr, w);")?;
                    }

                    writeln!(w, "            }},")?;
                }

                writeln!(w, "        }}")?;
            }
            writeln!(w, "    }}")?;
            writeln!(w, "}}")?;

            if needs_head_ptr {
                writeln!(w, "#[allow(non_camel_case_types, dead_code)]")?;
                writeln!(w, "pub enum {head_ptr_name} {{")?;
                writeln!(w, "    None,")?;
                for variant in variants {
                    if is_unit_variant(&variant.ty) {
                        continue;
                    }
                    let va_name = crate::snake_to_sentence(&variant.name);

                    write!(w, "    {va_name}")?;

                    if head.has_ptr {
                        write!(w, "({lutra_bin}::ReversePointer)")?;
                    } else {
                        write!(w, "({lutra_bin}::boxed::Box<<")?;
                        write_ty_ref(w, &variant.ty, false, ctx)?;
                        write!(w, " as {lutra_bin}::Encode>::HeadPtr>)")?;
                    }

                    writeln!(w, ",")?;
                }
                writeln!(w, "}}")?;
            }
        }

        _ => unimplemented!(),
    }

    let head_size = &ty
        .layout
        .as_ref()
        .unwrap_or_else(|| panic!("ty is missing layout: {}", lutra_bin::ir::print_ty(ty)))
        .head_size;
    writeln!(w, "impl {lutra_bin}::Layout for {name} {{")?;
    writeln!(w, "    fn head_size() -> usize {{")?;
    writeln!(w, "        {head_size}")?;
    writeln!(w, "    }}")?;
    writeln!(w, "}}\n")?;

    match &ty.kind {
        ir::TyKind::Primitive(_) | ir::TyKind::Array(_) | ir::TyKind::Ident(_) => {
            writeln!(w, "impl {lutra_bin}::Decode for {name} {{")?;
            writeln!(
                w,
                "    fn decode(buf: &[u8]) -> {lutra_bin}::Result<Self> {{"
            )?;

            write!(w, "        Ok(Self(")?;
            write_ty_ref(w, ty, true, ctx)?;
            writeln!(w, "::decode(buf)?))")?;

            writeln!(w, "    }}")?;
            writeln!(w, "}}\n")?;
        }

        ir::TyKind::Enum(variants) if is_option_enum(variants) => {
            writeln!(w, "impl {lutra_bin}::Decode for {name} {{")?;
            writeln!(
                w,
                "    fn decode(buf: &[u8]) -> {lutra_bin}::Result<Self> {{"
            )?;

            write!(w, "        Ok(Self(")?;
            write_ty_ref(w, ty, true, ctx)?;
            writeln!(w, "::decode(buf)?))")?;

            writeln!(w, "    }}")?;
            writeln!(w, "}}\n")?;
        }

        ir::TyKind::Enum(variants) if is_result_enum(variants, &ty.variants_recursive) => {
            writeln!(w, "impl {lutra_bin}::Decode for {name} {{")?;
            writeln!(
                w,
                "    fn decode(buf: &[u8]) -> {lutra_bin}::Result<Self> {{"
            )?;

            write!(w, "        Ok(Self(")?;
            write_ty_ref(w, ty, true, ctx)?;
            writeln!(w, "::decode(buf)?))")?;

            writeln!(w, "    }}")?;
            writeln!(w, "}}\n")?;
        }

        ir::TyKind::Tuple(fields) => {
            if fields.is_empty() {
                writeln!(w, "#[allow(unused_variables)]")?;
            }

            writeln!(w, "impl {lutra_bin}::Decode for {name} {{")?;
            writeln!(w, "    fn decode(buf: &[u8]) -> {lutra_bin}::Result<Self> {{")?;

            let field_offsets = layout::tuple_field_offsets(ty);
            for (index, (field, offset)) in fields.iter().zip(field_offsets).enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);
                let field_ty = &field.ty;

                write!(w, "        let {field_name} = ")?;

                write_ty_ref(w, field_ty, true, ctx)?;

                writeln!(w, "::decode(buf.skip({offset}))?;")?;
            }

            writeln!(w, "        Ok({name} {{")?;
            for (index, field) in fields.iter().enumerate() {
                let field_name = crate::tuple_field_name(&field.name, index);
                writeln!(w, "            {field_name},")?;
            }
            writeln!(w, "        }})")?;

            writeln!(w, "    }}")?;
            writeln!(w, "}}\n")?;
        }

        ir::TyKind::Enum(variants) => {
            writeln!(w, "impl {lutra_bin}::Decode for {name} {{")?;
            writeln!(
                w,
                "    fn decode(buf: &[u8]) -> {lutra_bin}::Result<Self> {{"
            )?;

            let head = layout::enum_head_format(variants, &ty.variants_recursive);

            // tag
            writeln!(w, "        let mut tag_bytes = buf.read_n({}).to_vec();", head.tag_bytes)?;
            writeln!(w, "        tag_bytes.resize(8, 0);")?;
            writeln!(w, "        let tag = u64::from_le_bytes(tag_bytes.try_into().unwrap()) as usize;")?;

            if variants.iter().any(|v| !is_unit_variant(&v.ty)) {
                writeln!(w, "        let buf = buf.skip({});", head.tag_bytes)?;
            }

            writeln!(w, "        Ok(match tag {{")?;
            for (index, variant) in variants.iter().enumerate() {
                let va_name = crate::snake_to_sentence(&variant.name);

                writeln!(w, "            {index} => {{")?;

                if is_unit_variant(&variant.ty) {
                } else if head.has_ptr {
                    writeln!(w, "                let offset = u32::from_le_bytes(buf.read_const::<4>());")?;

                    write!(w, "                let inner = ")?;
                    write_ty_ref(w, &variant.ty, true, ctx)?;
                    writeln!(w, "::decode(buf.skip(offset as usize))?;")?;
                } else {
                    write!(w, "                let inner = ")?;
                    write_ty_ref(w, &variant.ty, true, ctx)?;
                    writeln!(w, "::decode(buf)?;")?;
                }

                let needs_box = variant_needs_box(ty, index);

                if is_unit_variant(&variant.ty) {
                    writeln!(w, "                {name}::{va_name}", )?;
                } else if needs_box {
                    writeln!(w, "                {name}::{va_name}({lutra_bin}::boxed::Box::new(inner))")?;
                } else {
                    writeln!(w, "                {name}::{va_name}(inner)")?;
                }

                writeln!(w, "            }},")?;
            }
            writeln!(w, "            _ => return Err({lutra_bin}::Error::InvalidData)")?;
            writeln!(w, "        }})")?;
            writeln!(w, "    }}")?;
            writeln!(w, "}}\n")?;
        }

        _ => unimplemented!(),
    }

    Ok(())
}