lutra-bin 0.5.1

Binary format library for Lutra: IR/RR encoding, decoding, and value representation
Documentation
use crate::layout;
use crate::string;
use crate::vec;

use bytes::{BufMut, BytesMut};

use crate::{Layout, Result};

pub trait Encode {
    type HeadPtr;

    fn encode(&self) -> vec::Vec<u8> {
        let mut buf = BytesMut::new();
        let ptr = self.encode_head(&mut buf);
        self.encode_body(ptr, &mut buf);
        buf.to_vec()
    }

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr;

    fn encode_body(&self, head: Self::HeadPtr, buf: &mut BytesMut);
}

impl<T> Encode for &T
where
    T: Encode,
{
    type HeadPtr = T::HeadPtr;

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        T::encode_head(self, buf)
    }

    fn encode_body(&self, head: Self::HeadPtr, buf: &mut BytesMut) {
        T::encode_body(self, head, buf)
    }
}

impl Encode for bool {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_u8(*self as u8);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}

impl Encode for i8 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_i8(*self)
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for i16 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_i16_le(*self)
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for i32 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_i32_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for i64 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_i64_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for u8 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_u8(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for u16 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_u16_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for u32 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_u32_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for u64 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_u64_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for f32 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_f32_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}
impl Encode for f64 {
    type HeadPtr = ();

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        buf.put_f64_le(*self);
    }

    fn encode_body(&self, _head: Self::HeadPtr, _buf: &mut BytesMut) {}
}

impl Encode for str {
    type HeadPtr = ReversePointer;

    fn encode_head(&self, buf: &mut BytesMut) -> ReversePointer {
        let offset = ReversePointer::new(buf);
        buf.put_u32_le(self.len() as u32);
        offset
    }

    fn encode_body(&self, offset: Self::HeadPtr, buf: &mut BytesMut) {
        offset.write_cur_len(buf);
        buf.put_slice(self.as_bytes());
    }
}
impl Encode for string::String {
    type HeadPtr = ReversePointer;

    fn encode_head(&self, buf: &mut BytesMut) -> ReversePointer {
        (self as &str).encode_head(buf)
    }

    fn encode_body(&self, offset: Self::HeadPtr, buf: &mut BytesMut) {
        (self as &str).encode_body(offset, buf)
    }
}
impl<E: Encode> Encode for vec::Vec<E> {
    type HeadPtr = ReversePointer;

    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        self.as_slice().encode_head(buf)
    }

    fn encode_body(&self, head: Self::HeadPtr, buf: &mut BytesMut) {
        self.as_slice().encode_body(head, buf)
    }
}
impl<E: Encode> Encode for [E] {
    type HeadPtr = ReversePointer;

    fn encode_head(&self, buf: &mut BytesMut) -> ReversePointer {
        let offset = ReversePointer::new(buf);
        buf.put_u32_le(self.len() as u32);
        offset
    }

    fn encode_body(&self, offset_ptr: Self::HeadPtr, buf: &mut BytesMut) {
        offset_ptr.write_cur_len(buf);

        let mut heads: vec::Vec<_> = vec::Vec::with_capacity(self.len());
        for i in self {
            heads.push(i.encode_head(buf));
        }

        for (i, h) in self.iter().zip(heads.into_iter()) {
            i.encode_body(h, buf);
        }
    }
}
impl<E: Encode + Layout> Encode for Option<E> {
    type HeadPtr = Option<Result<E::HeadPtr, ReversePointer>>;

    #[allow(clippy::collapsible_else_if)]
    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        let tag: u8 = if self.is_none() { 0 } else { 1 };
        buf.put_u8(tag);

        let inner_head_size = E::head_size();
        let has_ptr = inner_head_size > 32;

        if has_ptr {
            if self.is_some() {
                let offset = ReversePointer::new(buf);
                Some(Err(offset))
            } else {
                buf.put_bytes(0, 4);
                None
            }
        } else {
            if let Some(inner) = self {
                let inner_head_ptr = inner.encode_head(buf);
                Some(Ok(inner_head_ptr))
            } else {
                buf.put_bytes(0, inner_head_size.div_ceil(8));
                None
            }
        }
    }

    fn encode_body(&self, head: Self::HeadPtr, buf: &mut BytesMut) {
        let Some(inner) = self else { return };

        let inner_head_size = E::head_size();
        let has_ptr = inner_head_size > 32;

        let head = head.unwrap();

        if has_ptr {
            let Err(offset_ptr) = head else {
                unreachable!()
            };
            offset_ptr.write_cur_len(buf);

            let head_ptr = inner.encode_head(buf);
            inner.encode_body(head_ptr, buf)
        } else {
            let Ok(head) = head else { unreachable!() };
            inner.encode_body(head, buf)
        }
    }
}

impl<T: Encode + Layout, E: Encode + Layout> Encode for core::result::Result<T, E> {
    type HeadPtr =
        core::result::Result<core::result::Result<T::HeadPtr, E::HeadPtr>, ReversePointer>;

    #[allow(clippy::collapsible_else_if)]
    fn encode_head(&self, buf: &mut BytesMut) -> Self::HeadPtr {
        let t_head_bits = T::head_size();
        let e_head_bits = E::head_size();
        let max_head_bits = t_head_bits.max(e_head_bits);
        let has_ptr = max_head_bits > 32;
        let inner_bytes = if has_ptr {
            4
        } else {
            max_head_bits.div_ceil(8)
        };

        let tag: u8 = if self.is_ok() { 0 } else { 1 };
        buf.put_u8(tag);

        if has_ptr {
            let ptr = ReversePointer::new(buf);
            Err(ptr)
        } else {
            match self {
                Ok(inner) => {
                    let head_ptr = inner.encode_head(buf);
                    buf.put_bytes(0, inner_bytes - t_head_bits.div_ceil(8));
                    Ok(Ok(head_ptr))
                }
                Err(inner) => {
                    let head_ptr = inner.encode_head(buf);
                    buf.put_bytes(0, inner_bytes - e_head_bits.div_ceil(8));
                    Ok(Err(head_ptr))
                }
            }
        }
    }

    fn encode_body(&self, head: Self::HeadPtr, buf: &mut BytesMut) {
        match head {
            Err(ptr) => {
                ptr.write_cur_len(buf);
                match self {
                    Ok(inner) => {
                        let hp = inner.encode_head(buf);
                        inner.encode_body(hp, buf);
                    }
                    Err(inner) => {
                        let hp = inner.encode_head(buf);
                        inner.encode_body(hp, buf);
                    }
                }
            }
            Ok(Ok(head)) => {
                let Ok(inner) = self else { unreachable!() };
                inner.encode_body(head, buf);
            }
            Ok(Err(head)) => {
                let Err(inner) = self else { unreachable!() };
                inner.encode_body(head, buf);
            }
        }
    }
}

impl Encode for () {
    type HeadPtr = ();

    fn encode_head(&self, _buf: &mut BytesMut) {}

    fn encode_body(&self, _: (), _buf: &mut BytesMut) {}
}

/// Pointer to a location where an offset should be written to.
#[derive(Debug, Clone, Copy)]
pub struct ReversePointer {
    /// Location offset within the buffer.
    location: usize,
}

impl ReversePointer {
    pub fn new(buf: &mut BytesMut) -> ReversePointer {
        let r = ReversePointer {
            location: buf.len(),
        };
        buf.put_bytes(0, 4);
        r
    }

    pub fn new_at(location: usize) -> ReversePointer {
        ReversePointer { location }
    }

    pub fn unwrap(&self) -> usize {
        self.location
    }

    pub fn write_cur_len(self, w: &mut [u8]) {
        self.write(w, w.len())
    }

    pub fn write(self, w: &mut [u8], absolute_ptr: usize) {
        let relative = absolute_ptr - self.location;
        w[self.location..(self.location + 4)].copy_from_slice(&(relative as u32).to_le_bytes());
    }
}

pub fn encode_enum_head_tag(
    format: &layout::EnumFormat,
    tag: u64,
    buf: &mut BytesMut,
) -> Option<ReversePointer> {
    // tag
    let tag_slice = &tag.to_le_bytes()[0..format.tag_bytes as usize];
    buf.put_slice(tag_slice);

    if format.has_ptr {
        // inner pointer
        let variant = &format.variants[tag as usize];
        if !variant.is_unit {
            Some(ReversePointer::new(buf))
        } else {
            // this is unit variant, no need for a pointer
            None
        }
    } else {
        // no pointer, head of inner should follow directly
        None
    }
}

pub fn encode_enum_head_padding(format: &layout::EnumFormat, tag: u64, buf: &mut BytesMut) {
    let variant = &format.variants[tag as usize];
    if variant.padding_bytes > 0 {
        buf.put_bytes(0, variant.padding_bytes as usize);
    }
}