mir_types/

display.rs

use std::fmt;

use crate::atomic::Atomic;
use crate::union::Type;

/// Write `items` separated by `sep` straight into the formatter, avoiding the
/// intermediate `Vec<String>` + `join` allocations.
fn write_joined<T: fmt::Display>(
    f: &mut fmt::Formatter<'_>,
    items: impl IntoIterator<Item = T>,
    sep: &str,
) -> fmt::Result {
    for (i, item) in items.into_iter().enumerate() {
        if i > 0 {
            f.write_str(sep)?;
        }
        write!(f, "{item}")?;
    }
    Ok(())
}

/// True when `t` is precisely `mixed` and nothing else — deliberately
/// stricter than [`Type::is_mixed`], which also treats an unconstrained
/// template parameter as mixed. A template placeholder is a meaningful part
/// of a generic signature (e.g. `array<TKey, TValue>`) and must still be
/// printed, whereas a literal, unconstrained `mixed` is a default that adds
/// no information and can be collapsed away.
fn is_exactly_mixed(t: &Type) -> bool {
    matches!(t.types.as_slice(), [Atomic::TMixed])
}

/// Write a comma-separated callable/closure parameter type list, printing
/// `mixed` for untyped params.
fn write_param_types(f: &mut fmt::Formatter<'_>, params: &[crate::atomic::FnParam]) -> fmt::Result {
    for (i, p) in params.iter().enumerate() {
        if i > 0 {
            f.write_str(", ")?;
        }
        match &p.ty {
            Some(ty) => write!(f, "{ty}")?,
            None => f.write_str("mixed")?,
        }
    }
    Ok(())
}

/// PHP's `iterable` is defined as exactly `array|Traversable`, so a union
/// containing a matching `TArray{key, value}` + `Traversable` pair prints no
/// more information as those two members than it would as `iterable`. Returns
/// the pair's indices (lower, higher) and the rendered replacement text.
///
/// The `Traversable` member only counts as a match when it's unparameterized
/// (the bare-`iterable` decomposition) or when its type params are exactly
/// `[key, value]` (the `iterable<K, V>` decomposition) — a bare `Traversable`
/// paired with a *more specific* array (e.g. `array<int, string>|Traversable`)
/// must NOT collapse, since the bare `Traversable` side carries no such
/// key/value guarantee and collapsing would overclaim precision.
fn iterable_span(types: &[Atomic]) -> Option<(usize, usize, String)> {
    for (ai, a) in types.iter().enumerate() {
        let Atomic::TArray { key, value } = a else {
            continue;
        };
        for (ti, t) in types.iter().enumerate() {
            if ti == ai {
                continue;
            }
            let Atomic::TNamedObject { fqcn, type_params } = t else {
                continue;
            };
            if fqcn.as_ref() != "Traversable" {
                continue;
            }
            let is_default_key_value =
                is_exactly_mixed(value) && (is_exactly_mixed(key) || key.is_array_key());
            let matches = if type_params.is_empty() {
                // A bare (unparameterized) Traversable makes no key/value
                // guarantee, so it only pairs safely with the fully generic
                // `array` — pairing it with a more specific array would
                // claim the Traversable side shares that specificity too.
                is_default_key_value
            } else {
                type_params.len() == 2
                    && &type_params[0] == key.as_ref()
                    && &type_params[1] == value.as_ref()
            };
            if !matches {
                continue;
            }
            let rendered = if is_default_key_value {
                "iterable".to_string()
            } else {
                format!("iterable<{key}, {value}>")
            };
            return Some((ai.min(ti), ai.max(ti), rendered));
        }
    }
    None
}

impl fmt::Display for Type {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.types.is_empty() {
            return write!(f, "never");
        }
        if let Some((lo, hi, rendered)) = iterable_span(&self.types) {
            let mut first = true;
            for (i, t) in self.types.iter().enumerate() {
                if i == hi {
                    continue;
                }
                if !first {
                    f.write_str("|")?;
                }
                first = false;
                if i == lo {
                    f.write_str(&rendered)?;
                } else {
                    write!(f, "{t}")?;
                }
            }
            return Ok(());
        }
        write_joined(f, self.types.iter(), "|")
    }
}

/// String literal text with its non-UTF-8 bytes written as `\xNN`.
pub struct LiteralText<'a>(pub &'a str);

impl fmt::Display for LiteralText<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if !self
            .0
            .chars()
            .any(|c| ('\u{F700}'..='\u{F7FF}').contains(&c))
        {
            return f.write_str(self.0);
        }
        for c in self.0.chars() {
            match u32::from(c) {
                // Bytes that are not valid UTF-8 are stored as U+F700 + byte.
                b @ 0xF700..=0xF7FF => write!(f, "\\x{:02x}", b - 0xF700)?,
                _ => write!(f, "{c}")?,
            }
        }
        Ok(())
    }
}

impl fmt::Display for Atomic {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Atomic::TString => write!(f, "string"),
            Atomic::TLiteralString(s) => write!(f, "\"{}\"", LiteralText(s)),
            Atomic::TCallableString => write!(f, "callable-string"),
            Atomic::TClassString(None) => write!(f, "class-string"),
            Atomic::TClassString(Some(cls)) => write!(f, "class-string<{cls}>"),
            Atomic::TNonEmptyString => write!(f, "non-empty-string"),
            Atomic::TNumericString => write!(f, "numeric-string"),

            Atomic::TInt => write!(f, "int"),
            Atomic::TLiteralInt(n) => write!(f, "{n}"),
            Atomic::TIntRange { min, max } => match (min, max) {
                (None, None) => write!(f, "int"),
                (lo, hi) => {
                    let lo = lo.map_or_else(|| "min".to_string(), |n| n.to_string());
                    let hi = hi.map_or_else(|| "max".to_string(), |n| n.to_string());
                    write!(f, "int<{lo}, {hi}>")
                }
            },
            Atomic::TPositiveInt => write!(f, "positive-int"),
            Atomic::TNegativeInt => write!(f, "negative-int"),
            Atomic::TNonNegativeInt => write!(f, "non-negative-int"),

            Atomic::TFloat | Atomic::TIntegralFloat => write!(f, "float"),
            Atomic::TLiteralFloat(high, low) => {
                let bits = ((*high as u64) << 32) | (*low as u32 as u64);
                let value = f64::from_bits(bits);
                write!(f, "{value}")
            }

            Atomic::TBool => write!(f, "bool"),
            Atomic::TTrue => write!(f, "true"),
            Atomic::TFalse => write!(f, "false"),

            Atomic::TNull => write!(f, "null"),
            Atomic::TVoid => write!(f, "void"),
            Atomic::TNever => write!(f, "never"),
            Atomic::TMixed => write!(f, "mixed"),
            Atomic::TScalar => write!(f, "scalar"),
            Atomic::TNumeric => write!(f, "numeric"),

            Atomic::TObject => write!(f, "object"),
            Atomic::TNamedObject { fqcn, type_params } => {
                // `Traversable<mixed, mixed>`/`Generator<mixed, mixed, mixed, mixed>`
                // carry no more information than the bare class name — every
                // param resolving to the unconstrained default is exactly the
                // case an omitted type-param list would represent.
                if type_params.is_empty() || type_params.iter().all(is_exactly_mixed) {
                    write!(f, "{fqcn}")
                } else {
                    write!(f, "{fqcn}<")?;
                    write_joined(f, type_params.iter(), ", ")?;
                    f.write_str(">")
                }
            }
            Atomic::TStaticObject { fqcn } => write!(f, "static({fqcn})"),
            Atomic::TSelf { fqcn } => write!(f, "self({fqcn})"),
            Atomic::TParent { fqcn } => write!(f, "parent({fqcn})"),

            Atomic::TCallable {
                params,
                return_type,
                is_pure,
            } => {
                if *is_pure {
                    f.write_str("pure-")?;
                }
                match (params, return_type) {
                    (None, None) => f.write_str("callable"),
                    (Some(params), return_type) => {
                        f.write_str("callable(")?;
                        write_param_types(f, params)?;
                        match return_type {
                            Some(r) => write!(f, "): {r}"),
                            None => f.write_str("): mixed"),
                        }
                    }
                    (None, Some(ret)) => write!(f, "callable(): {ret}"),
                }
            }
            Atomic::TClosure { data } => {
                if data.is_pure {
                    f.write_str("pure-")?;
                }
                f.write_str("Closure(")?;
                write_param_types(f, &data.params)?;
                write!(f, "): {}", data.return_type)
            }

            Atomic::TArray { key, value } => {
                // `array<mixed, mixed>` and `array<array-key, mixed>` are both
                // just `array` — `array-key` (int|string) is already the
                // maximal legal key domain, so it's as much a "default" key
                // as `mixed` is.
                if is_exactly_mixed(value) && (is_exactly_mixed(key) || key.is_array_key()) {
                    write!(f, "array")
                } else {
                    write!(f, "array<{key}, {value}>")
                }
            }
            Atomic::TList { value } => {
                if is_exactly_mixed(value) {
                    write!(f, "list")
                } else {
                    write!(f, "list<{value}>")
                }
            }
            Atomic::TNonEmptyArray { key, value } => {
                if is_exactly_mixed(value) && (is_exactly_mixed(key) || key.is_array_key()) {
                    write!(f, "non-empty-array")
                } else {
                    write!(f, "non-empty-array<{key}, {value}>")
                }
            }
            Atomic::TNonEmptyList { value } => {
                if is_exactly_mixed(value) {
                    write!(f, "non-empty-list")
                } else {
                    write!(f, "non-empty-list<{value}>")
                }
            }
            Atomic::TObjectShape { properties } => {
                f.write_str("object{")?;
                for (i, (k, v)) in properties.iter().enumerate() {
                    if i > 0 {
                        f.write_str(", ")?;
                    }
                    match k {
                        crate::atomic::ArrayKey::String(s) => f.write_str(s)?,
                        crate::atomic::ArrayKey::Int(n) => write!(f, "{n}")?,
                    }
                    if v.optional {
                        f.write_str("?")?;
                    }
                    write!(f, ": {}", v.ty)?;
                }
                f.write_str("}")
            }
            Atomic::TKeyedArray { properties, .. } => {
                f.write_str("array{")?;
                for (i, (k, v)) in properties.iter().enumerate() {
                    if i > 0 {
                        f.write_str(", ")?;
                    }
                    match k {
                        crate::atomic::ArrayKey::String(s) => write!(f, "'{}'", LiteralText(s))?,
                        crate::atomic::ArrayKey::Int(n) => write!(f, "{n}")?,
                    }
                    if v.optional {
                        f.write_str("?")?;
                    }
                    write!(f, ": {}", v.ty)?;
                }
                f.write_str("}")
            }

            Atomic::TTemplateParam { name, .. } => write!(f, "{name}"),
            Atomic::TKeyOf { target } => write!(f, "key-of<{target}>"),
            Atomic::TValueOf { target } => write!(f, "value-of<{target}>"),
            Atomic::TConditional { data } => {
                let (subject, if_true, if_false) = (&data.subject, &data.if_true, &data.if_false);
                match &data.param_name {
                    Some(name) => write!(f, "(${name} is {subject} ? {if_true} : {if_false})"),
                    None => write!(f, "({subject} is ? {if_true} : {if_false})"),
                }
            }

            Atomic::TInterfaceString(None) => write!(f, "interface-string"),
            Atomic::TInterfaceString(Some(iface)) => write!(f, "interface-string<{iface}>"),
            Atomic::TEnumString => write!(f, "enum-string"),
            Atomic::TTraitString => write!(f, "trait-string"),
            Atomic::TLiteralEnumCase {
                enum_fqcn,
                case_name,
            } => {
                write!(f, "{enum_fqcn}::{case_name}")
            }

            Atomic::TIntersection { parts } => {
                // Skip exact-duplicate parts (e.g. a redundant `Foo&Foo`) —
                // hierarchy-aware redundancy (like `Iterator&Traversable`)
                // needs class info this crate doesn't have, so only drop
                // parts that are structurally identical to an earlier one.
                let mut printed: Vec<&Type> = Vec::new();
                let mut first = true;
                for part in parts.iter() {
                    if printed.contains(&part) {
                        continue;
                    }
                    printed.push(part);
                    if !first {
                        f.write_str("&")?;
                    }
                    first = false;
                    write!(f, "{part}")?;
                }
                Ok(())
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn int_range_unbounded_displays_as_int() {
        assert_eq!(
            format!(
                "{}",
                Atomic::TIntRange {
                    min: None,
                    max: None
                }
            ),
            "int"
        );
    }

    #[test]
    fn int_range_bounded_min_displays_range() {
        assert_eq!(
            format!(
                "{}",
                Atomic::TIntRange {
                    min: Some(0),
                    max: None
                }
            ),
            "int<0, max>"
        );
    }

    #[test]
    fn int_range_bounded_max_displays_range() {
        assert_eq!(
            format!(
                "{}",
                Atomic::TIntRange {
                    min: None,
                    max: Some(100)
                }
            ),
            "int<min, 100>"
        );
    }

    #[test]
    fn int_range_fully_bounded_displays_range() {
        assert_eq!(
            format!(
                "{}",
                Atomic::TIntRange {
                    min: Some(1),
                    max: Some(10)
                }
            ),
            "int<1, 10>"
        );
    }

    #[test]
    fn unbounded_int_range_in_union_displays_as_int() {
        let mut u = Type::empty();
        u.add_type(Atomic::TIntRange {
            min: None,
            max: None,
        });
        u.add_type(Atomic::TFalse);
        assert_eq!(format!("{u}"), "int|false");
    }

    #[test]
    fn array_of_mixed_mixed_collapses_to_array() {
        let atomic = Atomic::TArray {
            key: Box::new(Type::mixed()),
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "array");
    }

    #[test]
    fn array_of_array_key_mixed_collapses_to_array() {
        let atomic = Atomic::TArray {
            key: Box::new(Type::array_key()),
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "array");
    }

    #[test]
    fn array_of_int_mixed_does_not_collapse() {
        let atomic = Atomic::TArray {
            key: Box::new(Type::int()),
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "array<int, mixed>");
    }

    #[test]
    fn array_of_mixed_string_does_not_collapse() {
        let atomic = Atomic::TArray {
            key: Box::new(Type::mixed()),
            value: Box::new(Type::string()),
        };
        assert_eq!(format!("{atomic}"), "array<mixed, string>");
    }

    #[test]
    fn non_empty_array_of_mixed_mixed_collapses() {
        let atomic = Atomic::TNonEmptyArray {
            key: Box::new(Type::mixed()),
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "non-empty-array");
    }

    #[test]
    fn list_of_mixed_collapses_to_list() {
        let atomic = Atomic::TList {
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "list");
    }

    #[test]
    fn list_of_string_does_not_collapse() {
        let atomic = Atomic::TList {
            value: Box::new(Type::string()),
        };
        assert_eq!(format!("{atomic}"), "list<string>");
    }

    #[test]
    fn non_empty_list_of_mixed_collapses() {
        let atomic = Atomic::TNonEmptyList {
            value: Box::new(Type::mixed()),
        };
        assert_eq!(format!("{atomic}"), "non-empty-list");
    }

    #[test]
    fn named_object_all_mixed_params_collapses_to_bare_name() {
        let atomic = Atomic::TNamedObject {
            fqcn: "Traversable".into(),
            type_params: crate::union::vec_to_type_params(vec![Type::mixed(), Type::mixed()]),
        };
        assert_eq!(format!("{atomic}"), "Traversable");
    }

    #[test]
    fn named_object_with_one_concrete_param_does_not_collapse() {
        let atomic = Atomic::TNamedObject {
            fqcn: "Traversable".into(),
            type_params: crate::union::vec_to_type_params(vec![Type::int(), Type::mixed()]),
        };
        assert_eq!(format!("{atomic}"), "Traversable<int, mixed>");
    }

    #[test]
    fn named_object_with_mixed_bounded_template_param_does_not_collapse() {
        // An unresolved `T` template parameter (even one bounded by `mixed`)
        // is a meaningful part of a generic signature and must never be
        // confused with a literal, information-free `mixed` default.
        let template_param = Atomic::TTemplateParam {
            name: "T".into(),
            as_type: Box::new(Type::mixed()),
            defining_entity: "MyClass".into(),
        };
        let atomic = Atomic::TNamedObject {
            fqcn: "MyClass".into(),
            type_params: crate::union::vec_to_type_params(vec![Type::single(template_param)]),
        };
        assert_eq!(format!("{atomic}"), "MyClass<T>");
    }

    fn bare_traversable() -> Atomic {
        Atomic::TNamedObject {
            fqcn: "Traversable".into(),
            type_params: crate::union::empty_type_params(),
        }
    }

    #[test]
    fn array_mixed_mixed_or_traversable_collapses_to_iterable() {
        let mut u = Type::single(Atomic::TArray {
            key: Box::new(Type::array_key()),
            value: Box::new(Type::mixed()),
        });
        u.add_type(bare_traversable());
        assert_eq!(format!("{u}"), "iterable");
    }

    #[test]
    fn parameterized_array_or_matching_traversable_collapses_to_iterable() {
        let key = Type::string();
        let value = Type::int();
        let mut u = Type::single(Atomic::TArray {
            key: Box::new(key.clone()),
            value: Box::new(value.clone()),
        });
        u.add_type(Atomic::TNamedObject {
            fqcn: "Traversable".into(),
            type_params: crate::union::vec_to_type_params(vec![key, value]),
        });
        assert_eq!(format!("{u}"), "iterable<string, int>");
    }

    #[test]
    fn iterable_collapse_preserves_other_union_members() {
        let mut u = Type::single(Atomic::TArray {
            key: Box::new(Type::array_key()),
            value: Box::new(Type::mixed()),
        });
        u.add_type(bare_traversable());
        u.add_type(Atomic::TNull);
        assert_eq!(format!("{u}"), "iterable|null");
    }

    #[test]
    fn array_with_mismatched_bare_traversable_does_not_collapse() {
        // A bare (unparameterized) `Traversable` carries no key/value
        // guarantee, so pairing it with a *more specific* array must not be
        // rendered as `iterable<int, string>` — that would overclaim that the
        // `Traversable` side is bound to the same key/value types too.
        let mut u = Type::single(Atomic::TArray {
            key: Box::new(Type::int()),
            value: Box::new(Type::string()),
        });
        u.add_type(bare_traversable());
        assert_eq!(format!("{u}"), "array<int, string>|Traversable");
    }

    #[test]
    fn array_with_non_matching_parameterized_traversable_does_not_collapse() {
        let mut u = Type::single(Atomic::TArray {
            key: Box::new(Type::int()),
            value: Box::new(Type::string()),
        });
        u.add_type(Atomic::TNamedObject {
            fqcn: "Traversable".into(),
            type_params: crate::union::vec_to_type_params(vec![Type::string(), Type::int()]),
        });
        assert_eq!(
            format!("{u}"),
            "array<int, string>|Traversable<string, int>"
        );
    }

    fn named_object(fqcn: &str) -> Atomic {
        Atomic::TNamedObject {
            fqcn: fqcn.into(),
            type_params: crate::union::empty_type_params(),
        }
    }

    #[test]
    fn intersection_drops_exact_duplicate_part() {
        let atomic = Atomic::TIntersection {
            parts: crate::union::vec_to_type_params(vec![
                Type::single(named_object("Foo")),
                Type::single(named_object("Foo")),
            ]),
        };
        assert_eq!(format!("{atomic}"), "Foo");
    }

    #[test]
    fn intersection_keeps_distinct_parts() {
        let atomic = Atomic::TIntersection {
            parts: crate::union::vec_to_type_params(vec![
                Type::single(named_object("Countable")),
                Type::single(named_object("Traversable")),
            ]),
        };
        assert_eq!(format!("{atomic}"), "Countable&Traversable");
    }

    #[test]
    fn intersection_drops_duplicate_among_three_parts() {
        let atomic = Atomic::TIntersection {
            parts: crate::union::vec_to_type_params(vec![
                Type::single(named_object("Foo")),
                Type::single(named_object("Bar")),
                Type::single(named_object("Foo")),
            ]),
        };
        assert_eq!(format!("{atomic}"), "Foo&Bar");
    }
}