swamp-types 0.2.9

/*
 * Copyright (c) Peter Bjorklund. All rights reserved. https://github.com/swamp/swamp
 * Licensed under the MIT License. See LICENSE in the project root for license information.
 */

mod cache;
mod calc_compat;
mod flags;
pub mod prelude;
mod pretty_print;
mod supporting_types;
mod type_kind;

use crate::flags::TypeFlags;
pub use crate::type_kind::TypeKind;
use std::fmt::{Display, Formatter};
use std::rc::Rc;

#[derive(PartialEq, Clone, Eq, Hash, Copy, Debug)]
pub struct TypeId(u32);

impl TypeId {
    pub const EMPTY: u32 = 0xffffffff;

    #[must_use]
    pub const fn new(id: u32) -> Self {
        Self(id)
    }

    #[must_use]
    pub const fn inner(&self) -> u32 {
        self.0
    }
}

impl Display for TypeId {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Type {
    pub id: TypeId,
    pub flags: TypeFlags,
    pub kind: Rc<TypeKind>,
}

pub type TypeRef = Rc<Type>;

impl Display for Type {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}|{}", self.id, self.kind)
    }
}

impl Type {
    #[inline]
    #[must_use]
    pub const fn is_scalar(&self) -> bool {
        self.flags.contains(TypeFlags::IS_SCALAR)
    }

    #[inline]
    #[must_use]
    pub const fn can_be_stored_in_field(&self) -> bool {
        self.flags.contains(TypeFlags::IS_STORAGE)
    }

    #[inline]
    #[must_use]
    pub const fn can_be_stored_in_transient_field(&self) -> bool {
        self.flags.contains(TypeFlags::IS_BLITTABLE)
    }

    #[inline]
    #[must_use]
    pub const fn can_be_stored_in_variable(&self) -> bool {
        self.flags.contains(TypeFlags::IS_BLITTABLE)
    }

    #[must_use] pub fn is_option(&self) -> bool {
        matches!(&*self.kind, TypeKind::Optional(_))
    }

    #[inline]
    #[must_use]
    pub const fn is_storage(&self) -> bool {
        self.flags.contains(TypeFlags::IS_STORAGE)
    }

    #[inline]
    #[must_use]
    pub const fn allowed_as_return_type(&self) -> bool {
        self.flags.contains(TypeFlags::IS_ALLOWED_RETURN)
    }

    #[inline]
    #[must_use]
    pub const fn allowed_as_parameter_type(&self) -> bool {
        self.flags.contains(TypeFlags::IS_ALLOWED_RETURN)
    }

    #[inline]
    #[must_use]
    pub const fn is_blittable(&self) -> bool {
        self.flags.contains(TypeFlags::IS_BLITTABLE)
    }

    /// Check if this type requires explicit collection storage allocation from caller
    /// This includes all aggregate types including optionals that need memory
    /// allocation and proper setup of the r0 register by the caller
    #[must_use]
    pub fn collection_view_that_needs_explicit_storage(&self) -> bool {
        match &*self.kind {
            // Dynamic collections that need explicit storage
            TypeKind::DynamicLengthVecView(_)
            | TypeKind::DynamicLengthMapView(_, _)
            | TypeKind::StackView(_)
            | TypeKind::QueueView(_)
            | TypeKind::SparseView(_)
            | TypeKind::GridView(_)
            | TypeKind::SliceView(_) => true,

            // Optional types that contain types needing storage
            TypeKind::Optional(inner_type) => {
                inner_type.collection_view_that_needs_explicit_storage()
            }

            _ => false,
        }
    }
}