saltwater 0.10.0

use super::hir::{Symbol, Variable};
use crate::intern::InternedStr;
#[cfg(test)]
use proptest_derive::Arbitrary;
use std::fmt::{self, Formatter};
pub use struct_ref::{StructRef, StructType};

mod struct_ref {
    use std::cell::RefCell;
    use std::rc::Rc;

    use super::Variable;

    thread_local!(
        /// The global storage for all struct definitions.
        ///
        /// The type is read like so:
        /// RefCell: A container with interior mutability, used because `LocalKey`
        /// returns an immutable reference.
        /// Vec: A growable list of definitions.
        /// Rc: A hack so that the members can be accessed across function boundaries,
        /// see the documentation for `StructRef::get`.
        /// Vec<Symbol>: The members of a single struct definition.
        static TYPES: RefCell<Vec<Rc<Vec<Variable>>>> = Default::default()
    );

    /// A reference to a struct definition. Allows self-referencing structs.
    #[derive(Copy, Clone, Debug, Eq)]
    pub struct StructRef(usize);

    impl PartialEq for StructRef {
        fn eq(&self, other: &Self) -> bool {
            // see if we can do this the cheap way first;
            // otherwise fall back to comparing every member
            self.0 == other.0 || self.get() == other.get()
        }
    }

    impl Default for StructRef {
        fn default() -> Self {
            Self::new()
        }
    }

    impl StructRef {
        /// Create a reference to a new struct.
        pub fn new() -> StructRef {
            TYPES.with(|list| {
                let mut types = list.borrow_mut();
                let index = types.len();
                types.push(Rc::new(vec![]));
                StructRef(index)
            })
        }

        /// Returns the definition for a given struct.
        ///
        /// Examples:
        /// ```
        /// use saltwater::data::types::StructRef;
        /// let struct_ref = StructRef::new();
        /// let members = struct_ref.get();
        /// for symbol in members.iter() {
        ///     println!("{:?}", symbol);
        /// }
        /// ```
        // Implementation hack: because thread_local items cannot be returned
        // from a closure, this uses an Rc so that it can be `clone`d cheaply.
        // The clone is necessary so the members do not reference TYPES.
        pub fn get(self) -> Rc<Vec<Variable>> {
            TYPES.with(|list| list.borrow()[self.0].clone())
        }

        /// Change the definition for a struct.
        ///
        /// It is a logic error to use this for anything other than defining
        /// forward-declared structs.
        ///
        /// Examples:
        ///
        /// ```compile_fail
        /// use saltwater::data::types::StructRef;
        /// let struct_ref = StructRef::new();
        /// struct_ref.update(vec![Symbol::new()]);
        /// ```
        pub(crate) fn update<V>(self, members: V)
        where
            V: Into<Rc<Vec<Variable>>>,
        {
            TYPES.with(|list| {
                let mut types = list.borrow_mut();
                types[self.0] = members.into();
            });
        }
    }

    /// Structs can be either named or anonymous.
    #[derive(Clone, Debug, PartialEq)]
    pub enum StructType {
        /// Named structs can have forward declarations and be defined at any point
        /// in the program. In order to support self referential structs, named structs
        /// contain an indirect reference to their members, which can be dereferenced with
        /// `StructRef::get`.
        ///
        /// To update a forward declaration, use `StructRef::update`.
        Named(super::InternedStr, StructRef),
        /// Anonymous structs carry all their information with them,
        /// there's no need (or way) to use StructRef.
        Anonymous(Rc<Vec<Variable>>),
    }

    impl StructType {
        /// Get the members of a struct, regardless of which variant it is
        pub fn members(&self) -> Rc<Vec<Variable>> {
            match self {
                StructType::Anonymous(members) => Rc::clone(members),
                StructType::Named(_, struct_ref) => struct_ref.get(),
            }
        }
        /// Return whether the struct has no members.
        ///
        /// For `Named` structs, this occurs whenever we have seen
        /// a forward declaration but no definition.
        ///
        /// For `Anonymous` structs, this occurs only when there has been a
        /// type error of some sort.
        pub fn is_empty(&self) -> bool {
            match self {
                StructType::Anonymous(members) => members.is_empty(),
                StructType::Named(_, struct_ref) => struct_ref.get().is_empty(),
            }
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
pub enum Type {
    Void,
    Bool,
    Char(bool), // signed or unsigned
    Short(bool),
    Int(bool),
    Long(bool),
    Float,
    Double,
    // TODO: separate Qualifiers into LvalQualifiers and FunctionQualifiers
    Pointer(Box<Type>, super::hir::Qualifiers),
    Array(Box<Type>, ArrayType),
    Function(FunctionType),
    Union(StructType),
    Struct(StructType),
    /// Enums should always have members, since tentative definitions are not allowed
    Enum(Option<InternedStr>, Vec<(InternedStr, i64)>),
    /// This is the type used for variadic arguments.
    VaList,
    /// A semantic error occured while parsing this type.
    Error,
}

#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(test, derive(Arbitrary))]
pub enum ArrayType {
    Fixed(u64),
    Unbounded,
}

// NOTE: K&R declarations are not supported at this time
#[derive(Clone, Debug)]
pub struct FunctionType {
    // TODO: allow FunctionQualifiers as well
    pub return_type: Box<Type>,
    // why Metadata instead of Type?
    // 1. we need to know qualifiers for the params. if we made that part of Type,
    //    we'd need qualifiers for every step along the way
    //    (consider that int a[][][] parses as 4 nested types).
    // 2. when we do scoping, we need to know the names of formal parameters
    //    (as opposed to concrete arguments).
    //    this is as good a place to store them as any.
    pub params: Vec<Symbol>,
    pub varargs: bool,
}

impl Type {
    /// https://stackoverflow.com/questions/14821936/what-is-a-scalar-object-in-c#14822074
    #[inline]
    pub(crate) fn is_scalar(&self) -> bool {
        use Type::*;
        match self {
            Enum(_, _) => true,
            k if k.is_arithmetic() || k.is_pointer() => true,
            _ => false,
        }
    }
    #[inline]
    pub(crate) fn is_bool(&self) -> bool {
        match self {
            Type::Bool => true,
            _ => false,
        }
    }
    #[inline]
    // returns whether `self` is a signed integer type
    pub fn is_signed(&self) -> bool {
        use Type::*;
        match self {
            Bool | Char(true) | Short(true) | Int(true) | Long(true) | Enum(_, _) => true,
            _ => false,
        }
    }
    #[inline]
    pub fn is_integral(&self) -> bool {
        use Type::*;
        match self {
            Bool | Char(_) | Short(_) | Int(_) | Long(_) | Enum(_, _) => true,
            _ => false,
        }
    }
    #[inline]
    pub fn is_floating(&self) -> bool {
        match self {
            Type::Float | Type::Double => true,
            _ => false,
        }
    }
    #[inline]
    pub(crate) fn is_arithmetic(&self) -> bool {
        self.is_integral() || self.is_floating()
    }
    #[inline]
    pub fn is_pointer(&self) -> bool {
        match self {
            Type::Pointer(_, _) => true,
            _ => false,
        }
    }
    #[inline]
    pub fn is_function(&self) -> bool {
        match self {
            Type::Function(_) => true,
            _ => false,
        }
    }
}

impl PartialEq for FunctionType {
    fn eq(&self, other: &Self) -> bool {
        // no prototype: any parameters are allowed
        // TODO: issue a warning if a function has empty parameters, it's a holdover
        // from C89
        self.params.is_empty()
            || other.params.is_empty()
            || self.varargs == other.varargs
            && self.return_type == other.return_type
            // don't require parameter names and storage_class to match
            && self.params
                .iter()
                .zip(other.params.iter())
                .all(|(a, b)| {
                    let (this_param, other_param) = (a.get(), b.get());
                    this_param.ctype == other_param.ctype
                        && this_param.qualifiers == other_param.qualifiers
                })
    }
}

impl std::fmt::Display for Type {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        print_type(self, None, f)
    }
}

fn write_struct_type(struct_type: &StructType, f: &mut Formatter) -> fmt::Result {
    match struct_type {
        StructType::Named(name, _) => {
            write!(f, "{}", name)?;
        }
        StructType::Anonymous(members) => {
            writeln!(f, "{{")?;
            for member in members.iter() {
                writeln!(f, "    {};", member)?;
            }
            write!(f, "}}")?;
        }
    }
    Ok(())
}

pub(super) fn print_type(
    ctype: &Type,
    name: Option<InternedStr>,
    f: &mut Formatter,
) -> fmt::Result {
    fn unroll_type(ctype: &Type) -> Vec<&Type> {
        let mut types = Vec::new();
        let mut next_type = ctype;
        loop {
            types.push(next_type);
            next_type = match next_type {
                Type::Array(of, _) => of.as_ref(),
                Type::Pointer(to, _) => to.as_ref(),
                Type::Function(FunctionType { return_type, .. }) => return_type.as_ref(),
                _ => break,
            };
        }
        types
    }

    use std::fmt::Write;
    use Type::*;

    let unrolled_type = unroll_type(ctype);

    let mut prefixes = Vec::new();
    let mut postfixes = Vec::new();

    // Need to skip the last item because that's the final type that needs to be
    // put in as the specifier
    for (index, declarator_type) in unrolled_type[..unrolled_type.len() - 1].iter().enumerate() {
        match declarator_type {
            Array(_, array_type) => {
                prefixes.push(String::new());
                postfixes.push(match array_type {
                    ArrayType::Fixed(length) => format!("[{}]", length),
                    ArrayType::Unbounded => "[]".to_string(),
                });
            }
            Type::Function(function_type) => {
                prefixes.push(String::new());

                let params = &function_type.params;
                let mut buff = String::new();
                write!(buff, "(")?;
                for (index, symbol) in params.iter().enumerate() {
                    let symbol = symbol.get();
                    write!(buff, "{}", symbol)?;
                    if index != params.len() - 1 || function_type.varargs {
                        write!(buff, ", ")?;
                    }
                }

                if function_type.varargs {
                    write!(buff, "...")?;
                }

                write!(buff, ")")?;
                postfixes.push(buff);
            }
            Pointer(_, qs) => {
                let needs_parens = match unrolled_type[index + 1] {
                    Array(_, _) | Function(_) => true,
                    _ => false,
                };

                prefixes.push(format!(
                    "{}*{}",
                    if needs_parens { "(" } else { "" },
                    if *qs != Default::default() {
                        format!("{} ", qs)
                    } else {
                        String::new()
                    }
                ));

                if needs_parens {
                    postfixes.push(")".to_string());
                } else {
                    postfixes.push(String::new());
                }
            }
            _ => unreachable!(),
        }
    }

    let final_type = unrolled_type[unrolled_type.len() - 1];
    match final_type {
        Char(signed) | Short(signed) | Int(signed) | Long(signed) => {
            write!(
                f,
                "{}{}",
                if *signed { "" } else { "unsigned " },
                match final_type {
                    Char(_) => "char",
                    Short(_) => "short",
                    Int(_) => "int",
                    Long(_) => "long",
                    _ => unreachable!(),
                }
            )?;
        }
        Bool => write!(f, "_Bool")?,
        Float => write!(f, "float")?,
        Double => write!(f, "double")?,
        Void => write!(f, "void")?,
        Enum(Some(ident), _) => write!(f, "enum {}", ident)?,
        Enum(None, _) => write!(f, "<anonymous enum>")?,
        Union(struct_type) => {
            write!(f, "union ")?;
            write_struct_type(struct_type, f)?;
        }
        Struct(struct_type) => {
            write!(f, "struct ")?;
            write_struct_type(struct_type, f)?;
        }
        VaList => write!(f, "va_list")?,
        Error => write!(f, "<type error>")?,
        // These are unreachable because if they were part of the type, the
        // would have been unrolled. Only specifier types are valid final types
        // in the unrolling algorithm.
        Array(_, _) | Pointer(_, _) | Function(_) => unreachable!(),
    }

    if unrolled_type.len() > 1 || name.unwrap_or_default() != InternedStr::default() {
        write!(f, " ")?;
    }

    for prefix in prefixes.iter().rev() {
        write!(f, "{}", prefix)?;
    }

    if let Some(name) = name {
        write!(f, "{}", name)?;
    }

    for postfix in postfixes.iter() {
        write!(f, "{}", postfix)?;
    }

    Ok(())
}

#[cfg(test)]
pub(crate) mod tests {
    use proptest::prelude::*;

    use super::{ArrayType, InternedStr, Type};
    use crate::data::hir::Qualifiers;

    pub(crate) fn arb_type() -> impl Strategy<Value = Type> {
        let leaf = prop_oneof![
            Just(Type::Void),
            Just(Type::Bool),
            any::<bool>().prop_map(Type::Char),
            any::<bool>().prop_map(Type::Short),
            any::<bool>().prop_map(Type::Int),
            any::<bool>().prop_map(Type::Long),
            Just(Type::Float),
            Just(Type::Double),
            // enum
            any::<(Option<InternedStr>, Vec<(InternedStr, i64)>)>()
                .prop_map(|(name, members)| Type::Enum(name, members)),
            Just(Type::VaList),
            Just(Type::Error),
        ];

        leaf.prop_recursive(8, 256, 10, |inner| {
            prop_oneof![
                (inner.clone(), any::<Qualifiers>())
                    .prop_map(|(t, q)| Type::Pointer(Box::new(t), q)),
                (inner, any::<ArrayType>()).prop_map(|(t, at)| Type::Array(Box::new(t), at)),
                //Type::Function(FunctionType),
                //Type::Union(StructType),
                //Type::Struct(StructType),
            ]
        })
    }

    use crate::analyze::test::{assert_decl_display, assert_no_change};

    #[test]
    fn test_big_one() {
        assert_decl_display("struct { int i; } S;", "struct {\n    int i;\n} S;");
        assert_no_change("int f();");
        assert_no_change("int bar;");
        assert_no_change("int *foo;");
        assert_decl_display("**const*volatile a;", "int **const *volatile a;");
        assert_no_change("int (*a[])();");
        assert_decl_display("int (*(*f))(int);", "int (**f)(int);");
        assert_no_change("int *(*jynelson)(int (*)(int));");
        assert_no_change("int f(int, ...);");
    }
}