koto_runtime 0.6.0

The runtime used by the Koto programming language
Documentation
use {
    crate::{
        num2, num4, ExternalFunction, ExternalValue, IntRange, ValueIterator, ValueList, ValueMap,
        ValueNumber, ValueString, ValueTuple, ValueVec,
    },
    koto_bytecode::Chunk,
    parking_lot::RwLock,
    std::{
        cmp::Ordering,
        fmt,
        hash::{Hash, Hasher},
        sync::Arc,
    },
};

#[derive(Clone, Debug)]
pub enum Value {
    Empty,
    Bool(bool),
    Number(ValueNumber),
    Num2(num2::Num2),
    Num4(num4::Num4),
    Range(IntRange),
    List(ValueList),
    Tuple(ValueTuple),
    Map(ValueMap),
    Str(ValueString),
    Function(RuntimeFunction),
    Generator(RuntimeFunction),
    Iterator(ValueIterator),
    ExternalFunction(ExternalFunction),
    ExternalValue(Arc<RwLock<dyn ExternalValue>>),
    // Internal value types
    IndexRange(IndexRange),
    TemporaryTuple(RegisterSlice),
    ExternalDataId,
}

#[derive(Clone, Debug)]
pub enum ValueRef<'a> {
    Empty,
    Bool(&'a bool),
    Number(&'a ValueNumber),
    Num2(&'a num2::Num2),
    Num4(&'a num4::Num4),
    Range(&'a IntRange),
    List(&'a ValueList),
    Tuple(&'a ValueTuple),
    Map(&'a ValueMap),
    Str(&'a str),
    Function(&'a RuntimeFunction),
    Generator(&'a RuntimeFunction),
    Iterator(&'a ValueIterator),
    ExternalFunction(&'a ExternalFunction),
    ExternalValue(&'a Arc<RwLock<dyn ExternalValue>>),
    IndexRange(&'a IndexRange),
    TemporaryTuple(&'a RegisterSlice),
    ExternalDataId,
}

impl Value {
    #[inline]
    pub fn as_ref(&self) -> ValueRef {
        match self {
            Value::Empty => ValueRef::Empty,
            Value::Bool(b) => ValueRef::Bool(b),
            Value::Number(n) => ValueRef::Number(n),
            Value::Num2(n) => ValueRef::Num2(n),
            Value::Num4(n) => ValueRef::Num4(n),
            Value::Str(s) => ValueRef::Str(&s),
            Value::List(l) => ValueRef::List(l),
            Value::Map(m) => ValueRef::Map(m),
            Value::Tuple(m) => ValueRef::Tuple(m),
            Value::Range(r) => ValueRef::Range(r),
            Value::IndexRange(r) => ValueRef::IndexRange(r),
            Value::Function(f) => ValueRef::Function(f),
            Value::Generator(g) => ValueRef::Generator(g),
            Value::Iterator(i) => ValueRef::Iterator(i),
            Value::ExternalFunction(f) => ValueRef::ExternalFunction(f),
            Value::ExternalValue(v) => ValueRef::ExternalValue(v),
            Value::TemporaryTuple(t) => ValueRef::TemporaryTuple(t),
            Value::ExternalDataId => ValueRef::ExternalDataId,
        }
    }
}

impl Default for Value {
    fn default() -> Self {
        Value::Empty
    }
}

impl fmt::Display for Value {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use Value::*;
        match self {
            Empty => f.write_str("()"),
            Bool(b) => f.write_str(&b.to_string()),
            Number(n) => f.write_str(&n.to_string()),
            Num2(n) => f.write_str(&n.to_string()),
            Num4(n) => f.write_str(&n.to_string()),
            Str(s) => {
                if f.alternate() {
                    write!(f, "\"{}\"", s)
                } else {
                    f.write_str(s)
                }
            }
            List(l) => f.write_str(&l.to_string()),
            Tuple(t) => f.write_str(&t.to_string()),
            Map(m) => f.write_str(&m.to_string()),
            Range(IntRange { start, end }) => write!(f, "{}..{}", start, end),
            Function(_) => write!(f, "||"),
            Generator(_) => write!(f, "Generator"),
            Iterator(_) => write!(f, "Iterator"),
            ExternalFunction(_) => write!(f, "||"),
            ExternalValue(ref value) => f.write_str(&value.read().to_string()),
            IndexRange(self::IndexRange { .. }) => f.write_str("IndexRange"),
            TemporaryTuple(RegisterSlice { start, count }) => {
                write!(f, "TemporaryTuple [{}..{}]", start, start + count)
            }
            ExternalDataId => write!(f, "External Data"),
        }
    }
}

impl PartialEq for Value {
    fn eq(&self, other: &Self) -> bool {
        use Value::*;

        match (self, other) {
            (Number(a), Number(b)) => a == b,
            (Num2(a), Num2(b)) => a == b,
            (Num4(a), Num4(b)) => a == b,
            (Bool(a), Bool(b)) => a == b,
            (Str(a), Str(b)) => a == b,
            (List(a), List(b)) => a == b,
            (Tuple(a), Tuple(b)) => a == b,
            (Map(a), Map(b)) => a == b,
            (Range(a), Range(b)) => a == b,
            (IndexRange(a), IndexRange(b)) => a == b,
            (Function(a), Function(b)) => a == b,
            (Empty, Empty) => true,
            (ExternalDataId, ExternalDataId) => true,
            _ => false,
        }
    }
}

impl<'a> PartialEq for ValueRef<'a> {
    fn eq(&self, other: &Self) -> bool {
        use ValueRef::*;

        match (self, other) {
            (Number(a), Number(b)) => a == b,
            (Num2(a), Num2(b)) => a == b,
            (Num4(a), Num4(b)) => a == b,
            (Bool(a), Bool(b)) => a == b,
            (Str(a), Str(b)) => a == b,
            (List(a), List(b)) => a == b,
            (Tuple(a), Tuple(b)) => a == b,
            (Map(a), Map(b)) => a == b,
            (Range(a), Range(b)) => a == b,
            (IndexRange(a), IndexRange(b)) => a == b,
            (Function(a), Function(b)) => a == b,
            (Empty, Empty) => true,
            (ExternalDataId, ExternalDataId) => true,
            _ => false,
        }
    }
}

impl Eq for Value {}

impl PartialOrd for Value {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        use Value::*;

        match (self, other) {
            (Empty, Empty) => Some(Ordering::Equal),
            (Empty, _) => Some(Ordering::Less),
            (_, Empty) => Some(Ordering::Greater),
            (Number(a), Number(b)) => a.partial_cmp(b),
            (Num2(a), Num2(b)) => a.partial_cmp(b),
            (Num4(a), Num4(b)) => a.partial_cmp(b),
            (Str(a), Str(b)) => a.partial_cmp(b),
            (a, b) => panic!(format!("partial_cmp unsupported for {} and {}", a, b)),
        }
    }
}

impl Ord for Value {
    fn cmp(&self, other: &Self) -> Ordering {
        use Value::*;

        match (self, other) {
            (Empty, Empty) => Ordering::Equal,
            (Empty, _) => Ordering::Less,
            (_, Empty) => Ordering::Greater,
            (Number(a), Number(b)) => a.cmp(b),
            (Str(a), Str(b)) => a.cmp(b),
            (a, b) => panic!(format!("cmp unsupported for {} and {}", a, b)),
        }
    }
}

impl Hash for Value {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.as_ref().hash(state)
    }
}

impl<'a> Hash for ValueRef<'a> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        use ValueRef::*;

        std::mem::discriminant(self).hash(state);

        match self {
            Empty | ExternalDataId => {}
            Bool(b) => b.hash(state),
            Number(n) => n.hash(state),
            Num2(n) => n.hash(state),
            Num4(n) => n.hash(state),
            Str(s) => s.hash(state),
            Range(IntRange { start, end }) => {
                state.write_isize(*start);
                state.write_isize(*end);
            }
            IndexRange(self::IndexRange { start, end }) => {
                state.write_usize(*start);
                if let Some(end) = end {
                    state.write_usize(*end);
                }
            }
            _ => panic!("Hash is only supported for immutable value types"),
        }
    }
}

impl From<bool> for Value {
    fn from(value: bool) -> Self {
        Self::Bool(value)
    }
}

impl From<&str> for Value {
    fn from(value: &str) -> Self {
        Self::Str(value.into())
    }
}

impl From<ValueIterator> for Value {
    fn from(value: ValueIterator) -> Self {
        Self::Iterator(value)
    }
}

#[derive(Clone, Debug)]
pub struct RuntimeFunction {
    pub chunk: Arc<Chunk>,
    pub ip: usize,
    pub arg_count: u8,
    pub instance_function: bool,
    pub variadic: bool,
    pub captures: Option<ValueList>,
}

impl PartialEq for RuntimeFunction {
    fn eq(&self, other: &Self) -> bool {
        self.chunk == other.chunk
            && self.ip == other.ip
            && self.arg_count == other.arg_count
            && self.captures == other.captures
    }
}

impl Hash for RuntimeFunction {
    fn hash<H: Hasher>(&self, state: &mut H) {
        state.write_usize(Arc::as_ptr(&self.chunk) as *const () as usize);
        self.ip.hash(state);
        self.arg_count.hash(state);
        if let Some(captures) = &self.captures {
            captures.data().hash(state);
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct IndexRange {
    pub start: usize,
    pub end: Option<usize>,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct RegisterSlice {
    pub start: u8,
    pub count: u8,
}

pub fn deep_copy_value(value: &Value) -> Value {
    use Value::{List, Map, Tuple};

    match value {
        List(l) => {
            let result = l
                .data()
                .iter()
                .map(|v| deep_copy_value(v))
                .collect::<ValueVec>();
            List(ValueList::with_data(result))
        }
        Tuple(t) => {
            let result = t
                .data()
                .iter()
                .map(|v| deep_copy_value(v))
                .collect::<Vec<_>>();
            Tuple(result.into())
        }
        Map(m) => {
            let result = m
                .data()
                .iter()
                .map(|(k, v)| (k.clone(), deep_copy_value(v)))
                .collect();
            Map(ValueMap::with_data(result))
        }
        _ => value.clone(),
    }
}

pub fn type_as_string(value: &Value) -> String {
    use Value::*;
    match &value {
        Empty => "Empty".to_string(),
        Bool(_) => "Bool".to_string(),
        Number(ValueNumber::F64(_)) => "Float".to_string(),
        Number(ValueNumber::I64(_)) => "Int".to_string(),
        Num2(_) => "Num2".to_string(),
        Num4(_) => "Num4".to_string(),
        List(_) => "List".to_string(),
        Range { .. } => "Range".to_string(),
        IndexRange { .. } => "IndexRange".to_string(),
        Map(_) => "Map".to_string(),
        Str(_) => "String".to_string(),
        Tuple(_) => "Tuple".to_string(),
        Function { .. } => "Function".to_string(),
        Generator { .. } => "Generator".to_string(),
        ExternalFunction(_) => "ExternalFunction".to_string(),
        ExternalValue(value) => value.read().value_type(),
        Iterator(_) => "Iterator".to_string(),
        TemporaryTuple { .. } => "TemporaryTuple".to_string(),
        ExternalDataId => "ExternalDataId".to_string(),
    }
}

pub fn make_external_value(value: impl ExternalValue) -> Value {
    Value::ExternalValue(Arc::new(RwLock::new(value)))
}

pub fn value_is_callable(value: &Value) -> bool {
    use Value::*;
    matches!(value, Function{..} | ExternalFunction(_))
}

pub fn value_is_immutable(value: &Value) -> bool {
    use Value::*;
    matches!(
        value,
        Empty | ExternalDataId | Bool(_) | Number(_) | Num2(_) | Num4(_) | Range(_) | Str(_)
    )
}

pub fn value_is_iterable(value: &Value) -> bool {
    use Value::*;
    matches!(
        value,
        Range(_) | List(_) | Tuple(_) | Map(_) | Str(_) | Iterator(_)
    )
}

pub fn value_size(value: &Value) -> usize {
    use Value::*;

    match value {
        List(l) => l.len(),
        Str(s) => s.len(),
        Tuple(t) => t.data().len(),
        TemporaryTuple(RegisterSlice { count, .. }) => *count as usize,
        Map(m) => m.len(),
        Num2(_) => 2,
        Num4(_) => 4,
        Range(IntRange { start, end }) => (end - start) as usize,
        _ => 1,
    }
}

pub fn add_values(value_a: &Value, value_b: &Value) -> Option<Value> {
    use Value::*;

    let result = match (value_a, value_b) {
        (Number(a), Number(b)) => Number(a + b),
        (Number(a), Num2(b)) => Num2(a + b),
        (Num2(a), Num2(b)) => Num2(a + b),
        (Num2(a), Number(b)) => Num2(a + b),
        (Number(a), Num4(b)) => Num4(a + b),
        (Num4(a), Num4(b)) => Num4(a + b),
        (Num4(a), Number(b)) => Num4(a + b),
        (List(a), List(b)) => {
            let mut result = ValueVec::new();
            result.extend(a.data().iter().chain(b.data().iter()).cloned());
            List(ValueList::with_data(result))
        }
        (List(a), Tuple(b)) => {
            let mut result = ValueVec::new();
            result.extend(a.data().iter().chain(b.data().iter()).cloned());
            List(ValueList::with_data(result))
        }
        (Map(a), Map(b)) => {
            let mut result = a.data().clone();
            result.extend(&b.data());
            Map(ValueMap::with_data(result))
        }
        (Str(a), Str(b)) => {
            let result = a.to_string() + b.as_ref();
            Str(result.into())
        }
        _ => {
            return None;
        }
    };

    Some(result)
}

pub fn multiply_values(value_a: &Value, value_b: &Value) -> Option<Value> {
    use Value::*;

    let result = match (value_a, value_b) {
        (Number(a), Number(b)) => Number(a * b),
        (Number(a), Num2(b)) => Num2(a * b),
        (Num2(a), Num2(b)) => Num2(a * b),
        (Num2(a), Number(b)) => Num2(a * b),
        (Number(a), Num4(b)) => Num4(a * b),
        (Num4(a), Num4(b)) => Num4(a * b),
        (Num4(a), Number(b)) => Num4(a * b),
        _ => {
            return None;
        }
    };

    Some(result)
}