mir_codebase/
storage.rs

1use std::sync::Arc;
2
3use indexmap::IndexMap;
4use mir_types::Union;
5use serde::{Deserialize, Serialize};
6
7// ---------------------------------------------------------------------------
8// Shared primitives
9// ---------------------------------------------------------------------------
10
11#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
12pub enum Visibility {
13    Public,
14    Protected,
15    Private,
16}
17
18impl Visibility {
19    pub fn is_at_least(&self, required: Visibility) -> bool {
20        *self <= required
21    }
22}
23
24impl std::fmt::Display for Visibility {
25    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
26        match self {
27            Visibility::Public => write!(f, "public"),
28            Visibility::Protected => write!(f, "protected"),
29            Visibility::Private => write!(f, "private"),
30        }
31    }
32}
33
34#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
35pub struct TemplateParam {
36    pub name: Arc<str>,
37    pub bound: Option<Union>,
38    /// The entity (class or function FQN) that declared this template param.
39    pub defining_entity: Arc<str>,
40    pub variance: mir_types::Variance,
41}
42
43#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
44pub struct FnParam {
45    pub name: Arc<str>,
46    pub ty: Option<Union>,
47    pub default: Option<Union>,
48    pub is_variadic: bool,
49    pub is_byref: bool,
50    pub is_optional: bool,
51}
52
53// ---------------------------------------------------------------------------
54// Location — file + byte offsets
55// ---------------------------------------------------------------------------
56
57#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
58pub struct Location {
59    pub file: Arc<str>,
60    /// Byte offset of the start of the declaration in the source.
61    pub start: u32,
62    pub end: u32,
63    /// 1-based line number of the declaration.
64    pub line: u32,
65    /// 0-based Unicode char-count (code-point) column offset of the declaration start.
66    pub col: u16,
67}
68
69impl Location {
70    pub fn new(file: Arc<str>, start: u32, end: u32) -> Self {
71        Self {
72            file,
73            start,
74            end,
75            line: 1,
76            col: 0,
77        }
78    }
79
80    pub fn with_line_col(file: Arc<str>, start: u32, end: u32, line: u32, col: u16) -> Self {
81        Self {
82            file,
83            start,
84            end,
85            line,
86            col,
87        }
88    }
89}
90
91// ---------------------------------------------------------------------------
92// Assertion — `@psalm-assert`, `@psalm-assert-if-true`, etc.
93// ---------------------------------------------------------------------------
94
95#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
96pub enum AssertionKind {
97    Assert,
98    AssertIfTrue,
99    AssertIfFalse,
100}
101
102#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
103pub struct Assertion {
104    pub kind: AssertionKind,
105    pub param: Arc<str>,
106    pub ty: Union,
107}
108
109// ---------------------------------------------------------------------------
110// MethodStorage
111// ---------------------------------------------------------------------------
112
113#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
114pub struct MethodStorage {
115    pub name: Arc<str>,
116    pub fqcn: Arc<str>,
117    pub params: Vec<FnParam>,
118    /// Type from annotation (`@return` / native type hint). `None` means unannotated.
119    pub return_type: Option<Union>,
120    /// Type inferred from body analysis (filled in during pass 2).
121    pub inferred_return_type: Option<Union>,
122    pub visibility: Visibility,
123    pub is_static: bool,
124    pub is_abstract: bool,
125    pub is_final: bool,
126    pub is_constructor: bool,
127    pub template_params: Vec<TemplateParam>,
128    pub assertions: Vec<Assertion>,
129    pub throws: Vec<Arc<str>>,
130    pub is_deprecated: bool,
131    pub is_internal: bool,
132    pub is_pure: bool,
133    pub location: Option<Location>,
134}
135
136impl MethodStorage {
137    pub fn effective_return_type(&self) -> Option<&Union> {
138        self.return_type
139            .as_ref()
140            .or(self.inferred_return_type.as_ref())
141    }
142}
143
144// ---------------------------------------------------------------------------
145// PropertyStorage
146// ---------------------------------------------------------------------------
147
148#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
149pub struct PropertyStorage {
150    pub name: Arc<str>,
151    pub ty: Option<Union>,
152    pub inferred_ty: Option<Union>,
153    pub visibility: Visibility,
154    pub is_static: bool,
155    pub is_readonly: bool,
156    pub default: Option<Union>,
157    pub location: Option<Location>,
158}
159
160// ---------------------------------------------------------------------------
161// ConstantStorage
162// ---------------------------------------------------------------------------
163
164#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
165pub struct ConstantStorage {
166    pub name: Arc<str>,
167    pub ty: Union,
168    pub visibility: Option<Visibility>,
169    pub location: Option<Location>,
170}
171
172// ---------------------------------------------------------------------------
173// ClassStorage
174// ---------------------------------------------------------------------------
175
176#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
177pub struct ClassStorage {
178    pub fqcn: Arc<str>,
179    pub short_name: Arc<str>,
180    pub parent: Option<Arc<str>>,
181    pub interfaces: Vec<Arc<str>>,
182    pub traits: Vec<Arc<str>>,
183    pub own_methods: IndexMap<Arc<str>, Arc<MethodStorage>>,
184    pub own_properties: IndexMap<Arc<str>, PropertyStorage>,
185    pub own_constants: IndexMap<Arc<str>, ConstantStorage>,
186    pub template_params: Vec<TemplateParam>,
187    /// Type arguments from `@extends ParentClass<T1, T2>` — maps parent's template params to concrete types.
188    pub extends_type_args: Vec<Union>,
189    pub is_abstract: bool,
190    pub is_final: bool,
191    pub is_readonly: bool,
192    /// Populated during finalization: all ancestor FQCNs (parents + interfaces, transitively).
193    pub all_parents: Vec<Arc<str>>,
194    pub is_deprecated: bool,
195    pub is_internal: bool,
196    pub location: Option<Location>,
197}
198
199impl ClassStorage {
200    pub fn get_method(&self, name: &str) -> Option<&MethodStorage> {
201        // PHP method names are case-insensitive; caller should pass lowercase name.
202        // Only searches own_methods — inherited method resolution is done by Codebase::get_method.
203        self.own_methods.get(name).map(Arc::as_ref).or_else(|| {
204            self.own_methods
205                .iter()
206                .find(|(k, _)| k.as_ref().eq_ignore_ascii_case(name))
207                .map(|(_, v)| v.as_ref())
208        })
209    }
210
211    pub fn get_property(&self, name: &str) -> Option<&PropertyStorage> {
212        self.own_properties.get(name)
213    }
214
215    pub fn implements_or_extends(&self, fqcn: &str) -> bool {
216        self.fqcn.as_ref() == fqcn || self.all_parents.iter().any(|p| p.as_ref() == fqcn)
217    }
218}
219
220// ---------------------------------------------------------------------------
221// InterfaceStorage
222// ---------------------------------------------------------------------------
223
224#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
225pub struct InterfaceStorage {
226    pub fqcn: Arc<str>,
227    pub short_name: Arc<str>,
228    pub extends: Vec<Arc<str>>,
229    pub own_methods: IndexMap<Arc<str>, Arc<MethodStorage>>,
230    pub own_constants: IndexMap<Arc<str>, ConstantStorage>,
231    pub template_params: Vec<TemplateParam>,
232    pub all_parents: Vec<Arc<str>>,
233    pub location: Option<Location>,
234}
235
236// ---------------------------------------------------------------------------
237// TraitStorage
238// ---------------------------------------------------------------------------
239
240#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
241pub struct TraitStorage {
242    pub fqcn: Arc<str>,
243    pub short_name: Arc<str>,
244    pub own_methods: IndexMap<Arc<str>, Arc<MethodStorage>>,
245    pub own_properties: IndexMap<Arc<str>, PropertyStorage>,
246    pub own_constants: IndexMap<Arc<str>, ConstantStorage>,
247    pub template_params: Vec<TemplateParam>,
248    /// Traits used by this trait (`use OtherTrait;` inside a trait body).
249    pub traits: Vec<Arc<str>>,
250    pub location: Option<Location>,
251}
252
253// ---------------------------------------------------------------------------
254// EnumStorage
255// ---------------------------------------------------------------------------
256
257#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
258pub struct EnumCaseStorage {
259    pub name: Arc<str>,
260    pub value: Option<Union>,
261    pub location: Option<Location>,
262}
263
264#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
265pub struct EnumStorage {
266    pub fqcn: Arc<str>,
267    pub short_name: Arc<str>,
268    pub scalar_type: Option<Union>,
269    pub interfaces: Vec<Arc<str>>,
270    pub cases: IndexMap<Arc<str>, EnumCaseStorage>,
271    pub own_methods: IndexMap<Arc<str>, Arc<MethodStorage>>,
272    pub own_constants: IndexMap<Arc<str>, ConstantStorage>,
273    pub location: Option<Location>,
274}
275
276// ---------------------------------------------------------------------------
277// FunctionStorage
278// ---------------------------------------------------------------------------
279
280#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
281pub struct FunctionStorage {
282    pub fqn: Arc<str>,
283    pub short_name: Arc<str>,
284    pub params: Vec<FnParam>,
285    pub return_type: Option<Union>,
286    pub inferred_return_type: Option<Union>,
287    pub template_params: Vec<TemplateParam>,
288    pub assertions: Vec<Assertion>,
289    pub throws: Vec<Arc<str>>,
290    pub is_deprecated: bool,
291    pub is_pure: bool,
292    pub location: Option<Location>,
293}
294
295impl FunctionStorage {
296    pub fn effective_return_type(&self) -> Option<&Union> {
297        self.return_type
298            .as_ref()
299            .or(self.inferred_return_type.as_ref())
300    }
301}
302
303// ---------------------------------------------------------------------------
304// StubSlice — serializable bundle of definitions from one extension's stubs
305// ---------------------------------------------------------------------------
306
307/// A snapshot of all PHP definitions contributed by a single stub file set.
308///
309/// Produced by `mir-stubs-gen` at code-generation time and deserialized at
310/// runtime to inject definitions into the `Codebase`.
311#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
312pub struct StubSlice {
313    pub classes: Vec<ClassStorage>,
314    pub interfaces: Vec<InterfaceStorage>,
315    pub traits: Vec<TraitStorage>,
316    pub enums: Vec<EnumStorage>,
317    pub functions: Vec<FunctionStorage>,
318    #[serde(default)]
319    pub constants: Vec<(Arc<str>, Union)>,
320    /// Source file this slice was collected from. `None` for bundled stub slices
321    /// that were pre-computed and are not tied to a specific on-disk file.
322    #[serde(default)]
323    pub file: Option<Arc<str>>,
324    /// Types of `@var`-annotated global variables collected from this file.
325    /// Populated by `DefinitionCollector`; merged into `Codebase::global_vars`
326    /// by [`crate::Codebase::inject_stub_slice`] when `file` is `Some`.
327    #[serde(default)]
328    pub global_vars: Vec<(Arc<str>, Union)>,
329}
mir_codebase/storage.rs

mir_codebase/
storage.rs
