mago-codex 1.40.2

PHP type system representation, comparison logic, and codebase metadata for static analysis.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use mago_phpdoc_syntax::cst::TemplateTagValueVariance;

#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Variance {
    Invariant,
    Covariant,
    Contravariant,
}

impl From<TemplateTagValueVariance> for Variance {
    fn from(variance: TemplateTagValueVariance) -> Self {
        match variance {
            TemplateTagValueVariance::Invariant => Variance::Invariant,
            TemplateTagValueVariance::Covariant => Variance::Covariant,
            TemplateTagValueVariance::Contravariant => Variance::Contravariant,
        }
    }
}

impl Variance {
    #[inline]
    #[must_use]
    pub const fn is_invariant(&self) -> bool {
        matches!(self, Variance::Invariant)
    }

    #[inline]
    #[must_use]
    pub const fn is_covariant(&self) -> bool {
        matches!(self, Variance::Covariant)
    }

    #[inline]
    #[must_use]
    pub const fn is_contravariant(&self) -> bool {
        matches!(self, Variance::Contravariant)
    }

    #[inline]
    #[must_use]
    pub const fn is_readonly(&self) -> bool {
        matches!(self, Variance::Covariant | Variance::Invariant)
    }

    /// Combines an outer variance context with an inner variance context.
    ///
    /// This is used when resolving nested templates, e.g., `Outer<Inner<T>>`.
    /// The variance of `T` relative to the outermost context depends on both
    /// the variance of `T` within `Inner` and the variance of `Inner` within `Outer`.
    ///
    /// Rules:
    ///
    /// - Anything combined with Invariant results in Invariant.
    /// - Covariant + Covariant = Covariant
    /// - Contravariant + Contravariant = Covariant
    /// - Covariant + Contravariant = Contravariant
    /// - Contravariant + Covariant = Contravariant
    #[inline]
    #[must_use]
    pub const fn combine(outer_variance: Self, inner_variance: Self) -> Self {
        match (outer_variance, inner_variance) {
            // If either is invariant, the result is invariant
            (Variance::Invariant, _) | (_, Variance::Invariant) => Variance::Invariant,
            // Co + Co = Co
            (Variance::Covariant, Variance::Covariant) => Variance::Covariant,
            // Contra + Contra = Co (double negative flips back)
            (Variance::Contravariant, Variance::Contravariant) => Variance::Covariant,
            // Co + Contra = Contra
            (Variance::Covariant, Variance::Contravariant) => Variance::Contravariant,
            // Contra + Co = Contra
            (Variance::Contravariant, Variance::Covariant) => Variance::Contravariant,
        }
    }
}

impl std::fmt::Display for Variance {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Variance::Invariant => write!(f, "invariant"),
            Variance::Covariant => write!(f, "covariant"),
            Variance::Contravariant => write!(f, "contravariant"),
        }
    }
}