mir-codebase 0.5.0

Codebase storage and resolution for the mir PHP static analyzer
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
//! Visible-members query for autocomplete / LSP completions.
//!
//! Given a `Union` type, returns all methods, properties, and constants that
//! are visible on that type, walking the full inheritance hierarchy.

use std::sync::Arc;

use mir_types::{Atomic, Union};

use crate::codebase::Codebase;
use crate::storage::Visibility;

/// A single member visible on a type.
#[derive(Debug, Clone)]
pub struct MemberInfo {
    /// Member name (without `$` prefix for properties).
    pub name: Arc<str>,
    /// What kind of member this is.
    pub kind: MemberKind,
    /// The resolved type of this member (return type for methods, property type, constant type).
    pub ty: Option<Union>,
    /// Visibility (public/protected/private).
    pub visibility: Visibility,
    /// Whether this is a static member.
    pub is_static: bool,
    /// The FQCN of the class that declares this member.
    pub declaring_class: Arc<str>,
    /// Whether this member is deprecated.
    pub is_deprecated: bool,
    /// Method parameters (empty for properties/constants).
    pub params: Vec<crate::storage::FnParam>,
}

/// The kind of class member.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MemberKind {
    Method,
    Property,
    Constant,
    EnumCase,
}

impl Codebase {
    /// Return all members (methods, properties, constants) visible on the given type.
    ///
    /// Walks the full class hierarchy including parents, interfaces, traits, and enums.
    /// For union types, returns the union of members from all constituent types.
    pub fn visible_members(&self, ty: &Union) -> Vec<MemberInfo> {
        let mut result = Vec::new();
        let mut seen = std::collections::HashSet::new();

        for atomic in &ty.types {
            if let Atomic::TNamedObject { fqcn, .. } = atomic {
                self.collect_members_for_fqcn(fqcn, &mut result, &mut seen);
            }
        }

        result
    }

    /// Collect all visible members for a single FQCN.
    fn collect_members_for_fqcn(
        &self,
        fqcn: &str,
        out: &mut Vec<MemberInfo>,
        seen: &mut std::collections::HashSet<(String, MemberKind)>,
    ) {
        // --- Class ---
        if let Some(cls) = self.classes.get(fqcn) {
            // Methods: all_methods already includes inherited + trait methods.
            for (name, method) in &cls.all_methods {
                let key = (name.to_string(), MemberKind::Method);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Method,
                        ty: method.effective_return_type().cloned(),
                        visibility: method.visibility,
                        is_static: method.is_static,
                        declaring_class: method.fqcn.clone(),
                        is_deprecated: method.is_deprecated,
                        params: method.params.clone(),
                    });
                }
            }
            // Also check own_methods for anything not in all_methods
            for (name, method) in &cls.own_methods {
                let key = (name.to_string(), MemberKind::Method);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Method,
                        ty: method.effective_return_type().cloned(),
                        visibility: method.visibility,
                        is_static: method.is_static,
                        declaring_class: method.fqcn.clone(),
                        is_deprecated: method.is_deprecated,
                        params: method.params.clone(),
                    });
                }
            }

            // Properties: walk own + ancestors (all_parents includes parent chain + traits)
            let all_parents = cls.all_parents.clone();
            // Own properties first
            for (name, prop) in &cls.own_properties {
                let key = (name.to_string(), MemberKind::Property);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Property,
                        ty: prop.ty.clone().or_else(|| prop.inferred_ty.clone()),
                        visibility: prop.visibility,
                        is_static: prop.is_static,
                        declaring_class: cls.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
            // Own constants
            for (name, con) in &cls.own_constants {
                let key = (name.to_string(), MemberKind::Constant);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Constant,
                        ty: Some(con.ty.clone()),
                        visibility: con.visibility.unwrap_or(Visibility::Public),
                        is_static: true,
                        declaring_class: cls.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
            drop(cls);

            // Ancestor properties and constants
            for ancestor_fqcn in &all_parents {
                if let Some(ancestor) = self.classes.get(ancestor_fqcn.as_ref()) {
                    for (name, prop) in &ancestor.own_properties {
                        let key = (name.to_string(), MemberKind::Property);
                        if seen.insert(key) {
                            out.push(MemberInfo {
                                name: name.clone(),
                                kind: MemberKind::Property,
                                ty: prop.ty.clone().or_else(|| prop.inferred_ty.clone()),
                                visibility: prop.visibility,
                                is_static: prop.is_static,
                                declaring_class: ancestor.fqcn.clone(),
                                is_deprecated: false,
                                params: vec![],
                            });
                        }
                    }
                    for (name, con) in &ancestor.own_constants {
                        let key = (name.to_string(), MemberKind::Constant);
                        if seen.insert(key) {
                            out.push(MemberInfo {
                                name: name.clone(),
                                kind: MemberKind::Constant,
                                ty: Some(con.ty.clone()),
                                visibility: con.visibility.unwrap_or(Visibility::Public),
                                is_static: true,
                                declaring_class: ancestor.fqcn.clone(),
                                is_deprecated: false,
                                params: vec![],
                            });
                        }
                    }
                }
                // Trait properties
                if let Some(tr) = self.traits.get(ancestor_fqcn.as_ref()) {
                    for (name, prop) in &tr.own_properties {
                        let key = (name.to_string(), MemberKind::Property);
                        if seen.insert(key) {
                            out.push(MemberInfo {
                                name: name.clone(),
                                kind: MemberKind::Property,
                                ty: prop.ty.clone().or_else(|| prop.inferred_ty.clone()),
                                visibility: prop.visibility,
                                is_static: prop.is_static,
                                declaring_class: tr.fqcn.clone(),
                                is_deprecated: false,
                                params: vec![],
                            });
                        }
                    }
                }
            }

            // Trait properties for directly-used traits (not in all_parents)
            let traits = {
                if let Some(cls) = self.classes.get(fqcn) {
                    cls.traits.clone()
                } else {
                    vec![]
                }
            };
            for trait_fqcn in &traits {
                if let Some(tr) = self.traits.get(trait_fqcn.as_ref()) {
                    for (name, prop) in &tr.own_properties {
                        let key = (name.to_string(), MemberKind::Property);
                        if seen.insert(key) {
                            out.push(MemberInfo {
                                name: name.clone(),
                                kind: MemberKind::Property,
                                ty: prop.ty.clone().or_else(|| prop.inferred_ty.clone()),
                                visibility: prop.visibility,
                                is_static: prop.is_static,
                                declaring_class: tr.fqcn.clone(),
                                is_deprecated: false,
                                params: vec![],
                            });
                        }
                    }
                }
            }

            return;
        }

        // --- Interface ---
        if let Some(iface) = self.interfaces.get(fqcn) {
            for (name, method) in &iface.own_methods {
                let key = (name.to_string(), MemberKind::Method);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Method,
                        ty: method.effective_return_type().cloned(),
                        visibility: method.visibility,
                        is_static: method.is_static,
                        declaring_class: method.fqcn.clone(),
                        is_deprecated: method.is_deprecated,
                        params: method.params.clone(),
                    });
                }
            }
            for (name, con) in &iface.own_constants {
                let key = (name.to_string(), MemberKind::Constant);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Constant,
                        ty: Some(con.ty.clone()),
                        visibility: con.visibility.unwrap_or(Visibility::Public),
                        is_static: true,
                        declaring_class: iface.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
            let parents = iface.all_parents.clone();
            drop(iface);
            for parent_fqcn in &parents {
                // Recurse into parent interfaces
                self.collect_members_for_fqcn(parent_fqcn, out, seen);
            }
            return;
        }

        // --- Enum ---
        if let Some(en) = self.enums.get(fqcn) {
            // Enum cases
            for (name, case) in &en.cases {
                let key = (name.to_string(), MemberKind::EnumCase);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::EnumCase,
                        ty: case.value.clone(),
                        visibility: Visibility::Public,
                        is_static: true,
                        declaring_class: en.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
            // Enum methods
            for (name, method) in &en.own_methods {
                let key = (name.to_string(), MemberKind::Method);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Method,
                        ty: method.effective_return_type().cloned(),
                        visibility: method.visibility,
                        is_static: method.is_static,
                        declaring_class: method.fqcn.clone(),
                        is_deprecated: method.is_deprecated,
                        params: method.params.clone(),
                    });
                }
            }
            // Enum constants
            for (name, con) in &en.own_constants {
                let key = (name.to_string(), MemberKind::Constant);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Constant,
                        ty: Some(con.ty.clone()),
                        visibility: con.visibility.unwrap_or(Visibility::Public),
                        is_static: true,
                        declaring_class: en.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
            return;
        }

        // --- Trait (rare: variable typed as a trait) ---
        if let Some(tr) = self.traits.get(fqcn) {
            for (name, method) in &tr.own_methods {
                let key = (name.to_string(), MemberKind::Method);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Method,
                        ty: method.effective_return_type().cloned(),
                        visibility: method.visibility,
                        is_static: method.is_static,
                        declaring_class: method.fqcn.clone(),
                        is_deprecated: method.is_deprecated,
                        params: method.params.clone(),
                    });
                }
            }
            for (name, prop) in &tr.own_properties {
                let key = (name.to_string(), MemberKind::Property);
                if seen.insert(key) {
                    out.push(MemberInfo {
                        name: name.clone(),
                        kind: MemberKind::Property,
                        ty: prop.ty.clone().or_else(|| prop.inferred_ty.clone()),
                        visibility: prop.visibility,
                        is_static: prop.is_static,
                        declaring_class: tr.fqcn.clone(),
                        is_deprecated: false,
                        params: vec![],
                    });
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::storage::*;
    use indexmap::IndexMap;

    fn make_method(name: &str, fqcn: &str) -> MethodStorage {
        MethodStorage {
            name: Arc::from(name),
            fqcn: Arc::from(fqcn),
            params: vec![],
            return_type: Some(Union::single(Atomic::TString)),
            inferred_return_type: None,
            visibility: Visibility::Public,
            is_static: false,
            is_abstract: false,
            is_final: false,
            is_constructor: false,
            template_params: vec![],
            assertions: vec![],
            throws: vec![],
            is_deprecated: false,
            is_internal: false,
            is_pure: false,
            location: None,
        }
    }

    #[test]
    fn visible_members_includes_inherited() {
        let cb = Codebase::new();

        // Parent class with a method
        let mut parent_methods = IndexMap::new();
        parent_methods.insert(
            Arc::from("parentMethod"),
            make_method("parentMethod", "Parent"),
        );
        cb.classes.insert(
            Arc::from("Parent"),
            ClassStorage {
                fqcn: Arc::from("Parent"),
                short_name: Arc::from("Parent"),
                parent: None,
                interfaces: vec![],
                traits: vec![],
                own_methods: parent_methods,
                own_properties: IndexMap::new(),
                own_constants: IndexMap::new(),
                template_params: vec![],
                is_abstract: false,
                is_final: false,
                is_readonly: false,
                all_methods: IndexMap::new(),
                all_parents: vec![],
                is_deprecated: false,
                is_internal: false,
                location: None,
            },
        );

        // Child class with its own method
        let mut child_methods = IndexMap::new();
        child_methods.insert(
            Arc::from("childMethod"),
            make_method("childMethod", "Child"),
        );
        cb.classes.insert(
            Arc::from("Child"),
            ClassStorage {
                fqcn: Arc::from("Child"),
                short_name: Arc::from("Child"),
                parent: Some(Arc::from("Parent")),
                interfaces: vec![],
                traits: vec![],
                own_methods: child_methods,
                own_properties: IndexMap::new(),
                own_constants: IndexMap::new(),
                template_params: vec![],
                is_abstract: false,
                is_final: false,
                is_readonly: false,
                all_methods: IndexMap::new(),
                all_parents: vec![],
                is_deprecated: false,
                is_internal: false,
                location: None,
            },
        );

        cb.finalize();

        let ty = Union::single(Atomic::TNamedObject {
            fqcn: Arc::from("Child"),
            type_params: vec![],
        });
        let members = cb.visible_members(&ty);
        let names: Vec<&str> = members.iter().map(|m| m.name.as_ref()).collect();
        assert!(names.contains(&"childMethod"), "should have own method");
        assert!(
            names.contains(&"parentMethod"),
            "should have inherited method"
        );
    }

    #[test]
    fn visible_members_union_type() {
        let cb = Codebase::new();

        let mut a_methods = IndexMap::new();
        a_methods.insert(Arc::from("aMethod"), make_method("aMethod", "A"));
        cb.classes.insert(
            Arc::from("A"),
            ClassStorage {
                fqcn: Arc::from("A"),
                short_name: Arc::from("A"),
                parent: None,
                interfaces: vec![],
                traits: vec![],
                own_methods: a_methods,
                own_properties: IndexMap::new(),
                own_constants: IndexMap::new(),
                template_params: vec![],
                is_abstract: false,
                is_final: false,
                is_readonly: false,
                all_methods: IndexMap::new(),
                all_parents: vec![],
                is_deprecated: false,
                is_internal: false,
                location: None,
            },
        );

        let mut b_methods = IndexMap::new();
        b_methods.insert(Arc::from("bMethod"), make_method("bMethod", "B"));
        cb.classes.insert(
            Arc::from("B"),
            ClassStorage {
                fqcn: Arc::from("B"),
                short_name: Arc::from("B"),
                parent: None,
                interfaces: vec![],
                traits: vec![],
                own_methods: b_methods,
                own_properties: IndexMap::new(),
                own_constants: IndexMap::new(),
                template_params: vec![],
                is_abstract: false,
                is_final: false,
                is_readonly: false,
                all_methods: IndexMap::new(),
                all_parents: vec![],
                is_deprecated: false,
                is_internal: false,
                location: None,
            },
        );

        cb.finalize();

        let ty = Union::merge(
            &Union::single(Atomic::TNamedObject {
                fqcn: Arc::from("A"),
                type_params: vec![],
            }),
            &Union::single(Atomic::TNamedObject {
                fqcn: Arc::from("B"),
                type_params: vec![],
            }),
        );
        let members = cb.visible_members(&ty);
        let names: Vec<&str> = members.iter().map(|m| m.name.as_ref()).collect();
        assert!(names.contains(&"aMethod"));
        assert!(names.contains(&"bMethod"));
    }
}