lutra-compiler 0.6.0

Compiler for Lutra query language
Documentation
use enum_as_inner::EnumAsInner;

use crate::Span;
use crate::pr::path::Path;
use crate::resolver::NS_STD;

use super::Ref;

#[derive(Debug, Clone)]
pub struct Ty {
    pub kind: TyKind,

    pub span: Option<Span>,

    /// Name inferred from the type's definition.
    pub name: Option<String>,

    /// When this expr is the root of a new scope, this holds the id of
    /// that scope. This will always be set for [TyKind::Function], but
    /// might be set for other nodes too.
    pub scope_id: Option<usize>,

    /// When this type expr is an ident, this holds information
    /// what is being referenced by the ident.
    pub target: Option<Ref>,

    pub variants_force_ptr: Vec<u16>,
}

/// Memory layout of a type.
#[derive(Debug, Clone)]
pub struct TyLayout {
    /// Number of bits required to store the type's the head
    /// (the part whose size is known at compile time).
    pub head_size: u32,

    /// Position of the body pointer within the head.
    /// It is measured bytes from the start of the head.
    /// Pointer itself is relative to own position (and the start of the head).
    pub body_ptrs: Vec<u32>,
}

#[derive(Debug, Clone, PartialEq, Hash, EnumAsInner, strum::AsRefStr)]
pub enum TyKind {
    /// Identifier that still needs to be resolved.
    Ident(Path),

    /// Type of a built-in primitive type
    Primitive(TyPrimitive),

    /// Type of tuples (product)
    Tuple(Vec<TyTupleField>),

    /// Type of arrays
    Array(Box<Ty>),

    /// Syntactic sugar for enum { none, some: T }
    Option(Box<Ty>),

    /// Type of functions with defined params and return types.
    Enum(Vec<TyEnumVariant>),

    /// Type of functions with defined params and return types.
    Func(TyFunc),

    /// Tuple that is constructed by iterating over fields of a tuple
    TupleComprehension(TyTupleComprehension),
    // /// Tuples that have fields of `base` tuple, but don't have fields of `except` tuple.
    // /// Implies that `base` has all fields of `except`.
    // Exclude { base: Box<Ty>, except: Box<Ty> },
}

#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TyTupleField {
    pub name: Option<String>,

    pub unpack: bool,

    pub ty: Ty,
}

#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TyEnumVariant {
    pub name: String,
    pub ty: Ty,
}

/// Built-in sets.
#[derive(Debug, Clone, PartialEq, Eq, Hash, strum::Display)]
#[allow(non_camel_case_types)]
pub enum TyPrimitive {
    prim8,
    prim16,
    prim32,
    prim64,
}

// Type of a function
#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TyFunc {
    /// Types of func params
    pub params: Vec<TyFuncParam>,

    /// Type of the function body
    pub body: Option<Box<Ty>>,

    pub ty_params: Vec<TyParam>,
}

/// Parameter of type of a function
#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TyFuncParam {
    pub constant: bool,
    pub label: Option<String>,
    pub ty: Option<Ty>,
}

impl TyFuncParam {
    pub fn simple(ty: Option<Ty>) -> Self {
        TyFuncParam {
            constant: false,
            label: None,
            ty,
        }
    }
}

// Type parameter
#[derive(Debug, Clone)]
pub struct TyParam {
    /// Assigned name of this generic type param
    pub name: String,

    pub domain: TyDomain,

    pub span: Option<Span>,
}

/// Type domain.
/// Given some unknown type, domain describes restrictions that this type must
/// adhere to, for the program to be valid.
#[derive(Debug, Clone)]
pub enum TyDomain {
    /// Can be any type
    Open,

    /// Must be one of the following
    OneOf(Vec<Ty>),

    /// Must be a tuple with following fields
    TupleHasFields(Vec<TyDomainTupleField>),

    /// Must be a tuple with exactly N fields
    TupleLen { n: usize },

    /// Must be an enum with following variants
    EnumVariants(Vec<TyDomainEnumVariant>),
}

#[derive(Clone)]
pub struct TyDomainTupleField {
    pub location: super::Lookup,
    pub ty: Ty,

    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct TyDomainEnumVariant {
    pub name: String,
    pub ty: Ty,
}

#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TyTupleComprehension {
    pub tuple: Box<Ty>,

    pub variable_name: String,
    pub variable_ty: String,

    pub body_name: Option<String>,
    pub body_ty: Box<Ty>,
}

impl Ty {
    pub fn new(kind: impl Into<TyKind>) -> Ty {
        Ty {
            kind: kind.into(),
            span: None,
            name: None,
            target: None,
            scope_id: None,
            variants_force_ptr: Vec::new(),
        }
    }

    pub fn new_with_span(kind: impl Into<TyKind>, span: Span) -> Ty {
        Ty {
            kind: kind.into(),
            span: Some(span),
            name: None,
            target: None,
            scope_id: None,
            variants_force_ptr: Vec::new(),
        }
    }

    pub fn new_std(name: &str) -> Self {
        Ty::new(TyKind::Ident(Path::new([NS_STD, name])))
    }

    pub fn with_span(mut self, span: Span) -> Self {
        self.span = Some(span);
        self
    }
}

impl From<TyPrimitive> for TyKind {
    fn from(value: TyPrimitive) -> Self {
        TyKind::Primitive(value)
    }
}

impl From<TyFunc> for TyKind {
    fn from(value: TyFunc) -> Self {
        TyKind::Func(value)
    }
}

impl From<Path> for TyKind {
    fn from(value: Path) -> Self {
        TyKind::Ident(value)
    }
}

impl PartialEq for Ty {
    fn eq(&self, other: &Self) -> bool {
        self.kind == other.kind
    }
}

impl Eq for Ty {}

impl std::hash::Hash for Ty {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.kind.hash(state);
    }
}

impl PartialEq for TyParam {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name
        // && self.domain == other.domain
    }
}

impl Eq for TyParam {}

impl std::hash::Hash for TyParam {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.name.hash(state);
        // self.domain.hash(state);
    }
}

impl TyTupleField {
    pub(crate) fn matches_name(&self, name: &str) -> bool {
        self.name.as_ref().is_some_and(|n| n == name)
    }
}

impl std::fmt::Debug for TyDomainTupleField {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("TyDomainTupleField")
            .field("location", &self.location)
            .field("ty", &self.ty)
            .finish()
    }
}