layline-codegen 0.5.0

Rust source generation for layline.
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
//! A bit-addressed message: a bit cursor over the body, one read per field, zero padding to the byte.

use proc_macro2::{Ident, Literal, TokenStream};
use quote::{format_ident, quote};

use super::body::Own;
use super::cursor::too_deep;
use super::patch::{Target, fits};
use super::table::{row_tokens, span_of_kind};
use super::{Check, MessageParts};
use crate::root::Prelude;
use crate::walk::tokens::ident;
use crate::walk::{emit_message_field, kind_ty, path, row, scalar_ty};
use crate::{BitOrder, Error, Field, Kind, MessageDef, Presence, Root, Scalar, Segment};

/// A value in encode: by reference and by value.
type Held<'a> = (&'a TokenStream, &'a TokenStream);

/// Convert the cursor's `u64` to one field's type.
fn bit_decode(kind: &Kind, raw: &TokenStream, root: &Root) -> TokenStream {
    let Prelude { i64, .. } = root.prelude();
    match kind {
        Kind::Scalar(Scalar::U(64)) => quote!(#raw),
        Kind::Scalar(s @ Scalar::U(_)) => {
            let ty = scalar_ty(*s);
            quote!(#raw as #ty)
        }
        Kind::Scalar(s @ Scalar::I(n)) => {
            let ty = scalar_ty(*s);
            let wide = if *n == 64 {
                quote!((#raw as #i64))
            } else {
                let shift = Literal::u64_unsuffixed(64 - *n);
                quote!((((#raw << #shift) as #i64) >> #shift))
            };
            if *n == 64 { wide } else { quote!(#wide as #ty) }
        }
        Kind::Scalar(Scalar::F32) => {
            let f32 = root.prelude().primitive("f32");
            let u32 = root.prelude().primitive("u32");
            quote!(<#f32>::from_bits(#raw as #u32))
        }
        Kind::Scalar(Scalar::F64) => {
            let f64 = root.prelude().primitive("f64");
            quote!(<#f64>::from_bits(#raw))
        }
        other => {
            let ty = kind_ty(other, root);
            quote!(<#ty as #root::FieldCodec>::from_raw(#raw))
        }
    }
}

/// Convert one field to the `u64` the cursor writes.
fn bit_encode(kind: &Kind, (by_ref, by_value): Held<'_>, root: &Root) -> TokenStream {
    let Prelude { i64, u64, .. } = root.prelude();
    match kind {
        Kind::Scalar(Scalar::U(64)) => quote!(#by_value),
        Kind::Scalar(Scalar::U(_)) => quote!(#by_value as #u64),
        Kind::Scalar(Scalar::I(64)) => quote!(#by_value as #u64),
        Kind::Scalar(Scalar::I(_)) => quote!((#by_value as #i64) as #u64),
        Kind::Scalar(Scalar::F32) => quote!(#by_value.to_bits() as #u64),
        Kind::Scalar(Scalar::F64) => quote!(#by_value.to_bits()),
        other => {
            let ty = kind_ty(other, root);
            quote!(<#ty as #root::FieldCodec>::to_raw(#by_ref))
        }
    }
}

/// Assert that a codec field's declared width equals the codec's `BITS`.
fn bit_codec_check(owner: &str, f: &Field, root: &Root) -> Option<Check> {
    let Kind::Codec { ty, bits } = &f.kind else {
        return None;
    };
    let path = path(ty);
    let bits = Literal::u64_unsuffixed(*bits);
    let msg = format!(
        "{owner}: the width of field `{}` differs from `<{ty} as FieldCodec>::BITS`. \
         Declare the codec's width",
        f.name
    );
    Some(Check {
        field: f.name.clone(),
        tokens: quote! {
            const _: () = ::core::assert!(
                <#path as #root::FieldCodec>::BITS as ::core::primitive::u64 == #bits,
                #msg
            );
        },
    })
}

/// Generate a bit-addressed message.
///
/// Encode writes presence bits and padding. Decode reads the bits and skips the padding.
pub(super) fn bits_parts(
    m: &MessageDef,
    derives: &[crate::Derive],
    root: &Root,
) -> Result<(MessageParts, Vec<row::SegmentDef>), Error> {
    let Prelude { ok, some, none, result, u8, u32, usize, bool, .. } = root.prelude();
    let name = ident(&m.name);
    let msb = matches!(m.bits, Some(BitOrder::Msb));

    let skip = crate::walk::tokens::serde_skip(derives, &m.derives);
    let declared = bit_declared(m)?;
    let flags = bit_flags(&declared);

    let mut fields = TokenStream::new();
    let mut checks: Vec<Check> = Vec::new();
    let mut parse = TokenStream::new();
    let mut build = TokenStream::new();
    let mut writes = TokenStream::new();
    let mut rows: Vec<row::SegmentDef> = Vec::new();
    // Bits since the last optional or variable-size row, or since the body's start.
    let mut at = 0u64;
    let mut segment: Option<String> = None;

    for (f, presence) in &declared {
        let width = f.kind.width();
        let ident = ident(&f.name);
        let optional = !matches!(presence, BitPresence::Always);
        fields.extend(emit_message_field(f, optional, root, &skip));
        build.extend(quote!(#ident,));
        checks.extend(bit_codec_check(&m.name, f, root));

        let read = bit_read(&f.name, &f.kind, msb, root);
        let field = (f.name.as_str(), &f.kind);
        let by_ref = Own::Struct.by_ref(&f.name);
        let write_held = bit_write(field, (&by_ref, &Own::Struct.get(&f.name)), msb, root);
        let write_inner = bit_write(field, (&quote!(__v), &quote!((*__v))), msb, root);

        let start = match presence {
            // The presence bit is at `at`, so the field it gates begins one bit later.
            BitPresence::Present => bit_start(&segment, at + 1),
            _ => bit_start(&segment, at),
        };
        let when = match presence {
            BitPresence::Always => None,
            BitPresence::Present => Some(row::Presence::Bit),
            BitPresence::Mask { field, mask, set: true } => {
                Some(row::Presence::Flag { field: field.clone(), mask: *mask })
            }
            BitPresence::Mask { field, mask, set: false } => {
                Some(row::Presence::Clear { field: field.clone(), mask: *mask })
            }
        };

        match presence {
            BitPresence::Always => {
                parse.extend(quote! { let #ident = #read; });
                if flags.iter().any(|(flag, _)| *flag == f.name) {
                    let pos = bit_pos_ident(&f.name);
                    writes.extend(quote! { let #pos = #root::BitWriter::position(&__bits); });
                }
                writes.extend(write_held);
            }
            BitPresence::Present => {
                parse.extend(quote! {
                    let #ident = if __bits.bit()? { #some(#read) } else { #none };
                });
                writes.extend(quote! {
                    match #by_ref {
                        #some(__v) => {
                            __bits.bit(true)?;
                            #write_inner
                        }
                        #none => __bits.bit(false)?,
                    }
                });
            }
            BitPresence::Mask { field, mask, set } => {
                let test = bit_flag_test(&declared, field, *mask, *set, root);
                parse.extend(quote! {
                    let #ident = if #test { #some(#read) } else { #none };
                });
                writes.extend(quote! {
                    if let #some(__v) = #by_ref {
                        #write_inner
                    }
                });
            }
        }

        rows.push(row::SegmentDef {
            name: f.name.clone(),
            start,
            span: span_of_kind(&f.kind),
            when,
            decoded_by: match &f.kind {
                Kind::Var { ty } => Some(ty.clone()),
                _ => None,
            },
            table: None,
            covers: None,
        });

        if optional || f.kind.bits().is_none() {
            segment = Some(f.name.clone());
            at = 0;
        } else {
            at += width;
        }
    }

    // Flags are written before the fields they absent, then patched once presence is known.
    for (flag, governed) in &flags {
        let f = declared
            .iter()
            .map(|(f, _)| f)
            .find(|f| f.name == *flag)
            .expect("`validate` resolves every flag to an earlier field");
        let pos = bit_pos_ident(flag);
        let w = Literal::u64_unsuffixed(f.kind.width());
        let held = bit_encode(&f.kind, (&Own::Struct.by_ref(flag), &Own::Struct.get(flag)), root);
        let all = Literal::u64_unsuffixed(governed.iter().fold(0u64, |all, (mask, ..)| all | mask));
        let set = governed.iter().map(|(mask, of, set)| {
            let opt = Own::Struct.get(of);
            let mask = Literal::u64_unsuffixed(*mask);
            let marked = if *set { quote!(#opt.is_some()) } else { quote!(#opt.is_none()) };
            quote!(| (if #marked { #mask } else { 0 }))
        });
        writes.extend(quote! {
            __bits.patch(#pos, #w, (#held & !#all) #(#set)*);
        });
    }

    let table = rows.iter().map(|row| row_tokens(row, root));
    let (owner, str_ty) = (m.name.as_str(), root.prelude().primitive("str"));
    let too_deep = too_deep(root);
    let codec = quote! {
        impl #root::Message for #name {
            const NAME: &'static #str_ty = #owner;

            type Ctx = ();

            /// Each field in wire order, with its start and length.
            const SEGMENTS: &'static [#root::table::SegmentDef<'static>] = &[#(#table)*];

            const OPEN_ENDED: #bool = false;

            fn decode_with_nested(
                body: &[#u8],
                __depth: #u32,
                __ctx: (),
            ) -> #result<(Self, #usize), #root::ParseError> {
                #too_deep
                let mut __bits = #root::BitReader::<#msb>::new(body);
                #parse
                #ok((Self { #build }, __bits.bytes_consumed()))
            }

            fn encode_into_with<__B: #root::Buffer>(
                &self,
                out: &mut __B,
                __ctx: (),
            ) -> #result<(), #root::Overflow> {
                let mut __bits = #root::BitWriter::<_, #msb>::new(out);
                #writes
                #ok(())
            }
        }
    };

    Ok((MessageParts { fields, checks, blocks: TokenStream::new(), codec }, rows))
}

/// When a field of a bit-addressed message is present.
enum BitPresence {
    Always,
    /// When the bit just before the field is set.
    Present,
    /// When bits of an earlier field are set, or with `set` false, clear. A bare `bool` flag is
    /// its single bit.
    Mask {
        field: String,
        /// The bits that make this field present.
        mask: u64,
        /// Whether set bits mean present.
        set: bool,
    },
}

/// A bit-addressed message's fields in wire order, each with its presence.
fn bit_declared(m: &MessageDef) -> Result<Vec<(Field, BitPresence)>, Error> {
    let mut declared: Vec<(Field, BitPresence)> = Vec::new();
    for seg in &m.segments {
        match seg {
            Segment::Block(block) => {
                declared.extend(block.iter().map(|f| (f.clone(), BitPresence::Always)));
            }
            Segment::Opt { when, field } => {
                let presence = match when.tests() {
                    _ if matches!(when, Presence::Bit) => BitPresence::Present,
                    Some((flag, mask, set)) => BitPresence::Mask { field: flag.into(), mask, set },
                    None => {
                        return Err(Error::Refused(format!(
                            "{}: `{}` is present when bytes remain, which a bit-addressed message cannot test. \
                             Use `#[present]`, or a flag in an earlier field",
                            m.name, field.name,
                        )));
                    }
                };
                declared.push((field.clone(), presence));
            }
            Segment::Value { name, kind: kind @ Kind::Var { .. }, doc, .. } => {
                let mut f = Field::new(name, kind.clone());
                f.doc = doc.clone();
                declared.push((f, BitPresence::Always));
            }
            other => {
                return Err(Error::Refused(format!(
                    "{}: `{}` cannot be in a bit-addressed message. \
                     Use fixed fields, optional fields or `VarCodec` values",
                    m.name,
                    other.name().unwrap_or("?"),
                )));
            }
        }
    }
    Ok(declared)
}

/// The bits of a flag that one optional field reads: `(mask, field, set)`, where `set` is whether
/// set bits mean present.
type Governed = (u64, String, bool);

/// Each flag field, with the bits it gates, in declaration order.
fn bit_flags(declared: &[(Field, BitPresence)]) -> Vec<(String, Vec<Governed>)> {
    let mut flags: Vec<(String, Vec<Governed>)> = Vec::new();
    for (f, presence) in declared {
        let BitPresence::Mask { field, mask, set } = presence else { continue };
        let bit = (*mask, f.name.clone(), *set);
        match flags.iter_mut().find(|(flag, _)| flag == field) {
            Some((_, bits)) => bits.push(bit),
            None => flags.push((field.clone(), vec![bit])),
        }
    }
    flags
}

/// The local holding the bit position a flag field was written at.
fn bit_pos_ident(flag: &str) -> Ident {
    format_ident!("__flag_{}", flag)
}

/// The presence test for a `#[when]` field, over its flag's decoded local.
fn bit_flag_test(
    declared: &[(Field, BitPresence)],
    flag: &str,
    mask: u64,
    set: bool,
    root: &Root,
) -> TokenStream {
    let ident = ident(flag);
    let kind = declared
        .iter()
        .find(|(f, _)| f.name == flag)
        .map(|(f, _)| &f.kind)
        .expect("`validate` resolves every flag to an earlier field");
    if matches!(kind, Kind::Scalar(Scalar::Bool)) && mask == 1 {
        return if set { quote!(#ident) } else { quote!(!#ident) };
    }
    let raw = bit_encode(kind, (&quote!(&#ident), &quote!(#ident)), root);
    let mask = Literal::u64_unsuffixed(mask);
    if set { quote!((#raw & #mask) != 0) } else { quote!((#raw & #mask) == 0) }
}

/// Read one field from the cursor, as an expression.
fn bit_read(name: &str, kind: &Kind, msb: bool, root: &Root) -> TokenStream {
    let Prelude { err, .. } = root.prelude();
    match kind {
        Kind::Var { ty } => {
            let p = path(ty);
            quote! {
                {
                    let __at = #root::BitReader::position(&__bits);
                    let (__v, __used) = <#p as #root::BitCodec<#msb>>::decode(body, __at)?;
                    if __used == 0 {
                        return #err(#root::ParseError::Malformed { field: #name, at: __at / 8 });
                    }
                    __bits.skip(__used)?;
                    __v
                }
            }
        }
        other => {
            let w = Literal::u64_unsuffixed(other.width());
            let value = bit_decode(other, &quote!(__raw), root);
            quote! {
                {
                    let __raw = __bits.read(#w)?;
                    #value
                }
            }
        }
    }
}

/// Write one field to the cursor, panicking if the value does not fit its width.
fn bit_write((name, kind): (&str, &Kind), held: Held<'_>, msb: bool, root: &Root) -> TokenStream {
    let (by_ref, by_value) = held;
    if let Kind::Var { .. } = kind {
        return quote! { #root::BitCodec::<#msb>::encode(#by_ref, &mut __bits)?; };
    }
    let bits = kind.width();
    let w = Literal::u64_unsuffixed(bits);
    let msg = format!("field `{name}`: value does not fit #[bits({bits})]");
    let raw = bit_encode(kind, held, root);
    let fits = match kind {
        Kind::Scalar(Scalar::Bool) | Kind::Codec { .. } if bits < 64 => {
            Some(quote! { ::core::assert!(#raw >> #w == 0, #msg); })
        }
        Kind::Scalar(Scalar::U(n) | Scalar::I(n)) if *n < 64 => {
            let (ty, i64) = (kind_ty(kind, root), root.prelude().i64);
            Some(fits(Target::Field(&ty, bits), &quote!(#by_value as #i64), &msg, root))
        }
        _ => None,
    };
    quote! {
        #fits
        __bits.write(#raw, #w)?;
    }
}

/// Where a row starts: a bit of the body, or bits past the last variable-size row.
fn bit_start(segment: &Option<String>, at: u64) -> row::Start {
    match segment {
        None => row::Start::At(at),
        Some(segment) => row::Start::After { segment: segment.clone(), bits: at },
    }
}