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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
/// Statement analyzer — walks statement nodes threading context through
/// control flow (if/else, loops, try/catch, return).
use std::sync::Arc;
use php_ast::ast::StmtKind;
use mir_codebase::Codebase;
use mir_issues::{Issue, IssueBuffer, IssueKind, Location};
use mir_types::{ArrayKey, Atomic, Union};
use crate::context::Context;
use crate::expr::ExpressionAnalyzer;
use crate::narrowing::narrow_from_condition;
use crate::php_version::PhpVersion;
use crate::symbol::ResolvedSymbol;
// ---------------------------------------------------------------------------
// StatementsAnalyzer
// ---------------------------------------------------------------------------
pub struct StatementsAnalyzer<'a> {
pub codebase: &'a Codebase,
pub file: Arc<str>,
pub source: &'a str,
pub source_map: &'a php_rs_parser::source_map::SourceMap,
pub issues: &'a mut IssueBuffer,
pub symbols: &'a mut Vec<ResolvedSymbol>,
pub php_version: PhpVersion,
/// Accumulated inferred return types for the current function.
pub return_types: Vec<Union>,
/// Break-context stack: one entry per active loop nesting level.
/// Each entry collects the context states at every `break` in that loop.
break_ctx_stack: Vec<Vec<Context>>,
}
impl<'a> StatementsAnalyzer<'a> {
pub fn new(
codebase: &'a Codebase,
file: Arc<str>,
source: &'a str,
source_map: &'a php_rs_parser::source_map::SourceMap,
issues: &'a mut IssueBuffer,
symbols: &'a mut Vec<ResolvedSymbol>,
php_version: PhpVersion,
) -> Self {
Self {
codebase,
file,
source,
source_map,
issues,
symbols,
php_version,
return_types: Vec::new(),
break_ctx_stack: Vec::new(),
}
}
pub fn analyze_stmts<'arena, 'src>(
&mut self,
stmts: &php_ast::ast::ArenaVec<'arena, php_ast::ast::Stmt<'arena, 'src>>,
ctx: &mut Context,
) {
for stmt in stmts.iter() {
// @psalm-suppress / @suppress per-statement (call-site suppression)
let suppressions = self.extract_statement_suppressions(stmt.span);
let before = self.issues.issue_count();
if ctx.diverges {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) = self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start + 1)
};
self.issues.add(
Issue::new(
IssueKind::UnreachableCode,
Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
)
.with_snippet(
crate::parser::span_text(self.source, stmt.span).unwrap_or_default(),
),
);
if !suppressions.is_empty() {
self.issues.suppress_range(before, &suppressions);
}
break;
}
// Extract @var annotation for this statement.
let var_annotation = self.extract_var_annotation(stmt.span);
// Pre-narrow: `@var Type $varname` before any statement narrows that variable.
// Special cases: before `return` or before `foreach ... as $valvar` (value override).
if let Some((Some(ref var_name), ref var_ty)) = var_annotation {
ctx.set_var(var_name.as_str(), var_ty.clone());
}
self.analyze_stmt(stmt, ctx);
// Post-narrow: `@var Type $varname` before `$varname = expr()` overrides
// the inferred type with the annotated type. Only applies when the assignment
// target IS the annotated variable.
if let Some((Some(ref var_name), ref var_ty)) = var_annotation {
if let php_ast::ast::StmtKind::Expression(e) = &stmt.kind {
if let php_ast::ast::ExprKind::Assign(a) = &e.kind {
if matches!(&a.op, php_ast::ast::AssignOp::Assign) {
if let php_ast::ast::ExprKind::Variable(lhs_name) = &a.target.kind {
let lhs = lhs_name.trim_start_matches('$');
if lhs == var_name.as_str() {
ctx.set_var(var_name.as_str(), var_ty.clone());
}
}
}
}
}
}
if !suppressions.is_empty() {
self.issues.suppress_range(before, &suppressions);
}
}
}
pub fn analyze_stmt<'arena, 'src>(
&mut self,
stmt: &php_ast::ast::Stmt<'arena, 'src>,
ctx: &mut Context,
) {
match &stmt.kind {
// ---- Expression statement ----------------------------------------
StmtKind::Expression(expr) => {
let expr_ty = self.expr_analyzer(ctx).analyze(expr, ctx);
if expr_ty.is_never() {
ctx.diverges = true;
}
// For standalone assert($condition) calls, narrow from the condition.
if let php_ast::ast::ExprKind::FunctionCall(call) = &expr.kind {
if let php_ast::ast::ExprKind::Identifier(fn_name) = &call.name.kind {
if fn_name.eq_ignore_ascii_case("assert") {
if let Some(arg) = call.args.first() {
narrow_from_condition(
&arg.value,
ctx,
true,
self.codebase,
&self.file,
);
}
}
}
}
}
// ---- Echo ---------------------------------------------------------
StmtKind::Echo(exprs) => {
for expr in exprs.iter() {
// Taint check (M19): echoing tainted data → XSS
if crate::taint::is_expr_tainted(expr, ctx) {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) = self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
let mut issue = mir_issues::Issue::new(
IssueKind::TaintedHtml,
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
);
// Extract snippet from the echo statement span.
let start = stmt.span.start as usize;
let end = stmt.span.end as usize;
if start < self.source.len() {
let end = end.min(self.source.len());
let span_text = &self.source[start..end];
if let Some(first_line) = span_text.lines().next() {
issue = issue.with_snippet(first_line.trim().to_string());
}
}
self.issues.add(issue);
}
self.expr_analyzer(ctx).analyze(expr, ctx);
}
}
// ---- Return -------------------------------------------------------
StmtKind::Return(opt_expr) => {
if let Some(expr) = opt_expr {
let ret_ty = self.expr_analyzer(ctx).analyze(expr, ctx);
// If there's a bare `@var Type` (no variable name) on the return statement,
// use the annotated type for the return-type compatibility check.
// `@var Type $name` with a variable name narrows the variable (handled in
// analyze_stmts loop), not the return type.
let check_ty =
if let Some((None, var_ty)) = self.extract_var_annotation(stmt.span) {
var_ty
} else {
ret_ty.clone()
};
// Check against declared return type
if let Some(declared) = &ctx.fn_return_type.clone() {
// Check return type compatibility. Special case: `void` functions must not
// return any value (named_object_return_compatible considers TVoid compatible
// with TNull, so handle void separately to avoid false suppression).
if (declared.is_void() && !check_ty.is_void() && !check_ty.is_mixed())
|| (!check_ty.is_subtype_of_simple(declared)
&& !declared.is_mixed()
&& !check_ty.is_mixed()
&& !named_object_return_compatible(&check_ty, declared, self.codebase, &self.file)
// Also check without null (handles `null|T` where T implements declared).
// Guard: if check_ty is purely null, remove_null() is empty and would
// vacuously return true, incorrectly suppressing the error.
&& (check_ty.remove_null().is_empty() || !named_object_return_compatible(&check_ty.remove_null(), declared, self.codebase, &self.file))
&& !declared_return_has_template(declared, self.codebase)
&& !declared_return_has_template(&check_ty, self.codebase)
&& !return_arrays_compatible(&check_ty, declared, self.codebase, &self.file)
// Skip coercions: declared is more specific than actual
&& !declared.is_subtype_of_simple(&check_ty)
&& !declared.remove_null().is_subtype_of_simple(&check_ty)
// Skip when actual is compatible after removing null/false.
// Guard against empty union (e.g. pure-null type): removing null
// from `null` alone gives an empty union which vacuously passes
// is_subtype_of_simple — that would incorrectly suppress the error.
&& (check_ty.remove_null().is_empty() || !check_ty.remove_null().is_subtype_of_simple(declared))
&& !check_ty.remove_false().is_subtype_of_simple(declared)
// Suppress LessSpecificReturnStatement (level 4): actual is a
// supertype of declared (not flagged at default error level).
&& !named_object_return_compatible(declared, &check_ty, self.codebase, &self.file)
&& !named_object_return_compatible(&declared.remove_null(), &check_ty.remove_null(), self.codebase, &self.file))
{
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) = self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(
mir_issues::Issue::new(
IssueKind::InvalidReturnType {
expected: format!("{declared}"),
actual: format!("{ret_ty}"),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
)
.with_snippet(
crate::parser::span_text(self.source, stmt.span)
.unwrap_or_default(),
),
);
}
}
self.return_types.push(ret_ty);
} else {
self.return_types.push(Union::single(Atomic::TVoid));
// Bare `return;` from a non-void declared function is an error.
if let Some(declared) = &ctx.fn_return_type.clone() {
if !declared.is_void() && !declared.is_mixed() {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) = self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(
mir_issues::Issue::new(
IssueKind::InvalidReturnType {
expected: format!("{declared}"),
actual: "void".to_string(),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
)
.with_snippet(
crate::parser::span_text(self.source, stmt.span)
.unwrap_or_default(),
),
);
}
}
}
ctx.diverges = true;
}
// ---- Throw --------------------------------------------------------
StmtKind::Throw(expr) => {
let thrown_ty = self.expr_analyzer(ctx).analyze(expr, ctx);
// Validate that the thrown type extends Throwable
for atomic in &thrown_ty.types {
match atomic {
mir_types::Atomic::TNamedObject { fqcn, .. } => {
let resolved = self.codebase.resolve_class_name(&self.file, fqcn);
let is_throwable = resolved == "Throwable"
|| resolved == "Exception"
|| resolved == "Error"
|| fqcn.as_ref() == "Throwable"
|| fqcn.as_ref() == "Exception"
|| fqcn.as_ref() == "Error"
|| self.codebase.extends_or_implements(&resolved, "Throwable")
|| self.codebase.extends_or_implements(&resolved, "Exception")
|| self.codebase.extends_or_implements(&resolved, "Error")
|| self.codebase.extends_or_implements(fqcn, "Throwable")
|| self.codebase.extends_or_implements(fqcn, "Exception")
|| self.codebase.extends_or_implements(fqcn, "Error")
// Suppress if class has unknown ancestors (might be Throwable)
|| self.codebase.has_unknown_ancestor(&resolved)
|| self.codebase.has_unknown_ancestor(fqcn)
// Suppress if class is not in codebase at all (could be extension class)
|| (!self.codebase.type_exists(&resolved) && !self.codebase.type_exists(fqcn));
if !is_throwable {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) =
self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(mir_issues::Issue::new(
IssueKind::InvalidThrow {
ty: fqcn.to_string(),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
));
}
}
// self/static/parent resolve to the class itself — check via fqcn
mir_types::Atomic::TSelf { fqcn }
| mir_types::Atomic::TStaticObject { fqcn }
| mir_types::Atomic::TParent { fqcn } => {
let resolved = self.codebase.resolve_class_name(&self.file, fqcn);
let is_throwable = resolved == "Throwable"
|| resolved == "Exception"
|| resolved == "Error"
|| self.codebase.extends_or_implements(&resolved, "Throwable")
|| self.codebase.extends_or_implements(&resolved, "Exception")
|| self.codebase.extends_or_implements(&resolved, "Error")
|| self.codebase.extends_or_implements(fqcn, "Throwable")
|| self.codebase.extends_or_implements(fqcn, "Exception")
|| self.codebase.extends_or_implements(fqcn, "Error")
|| self.codebase.has_unknown_ancestor(&resolved)
|| self.codebase.has_unknown_ancestor(fqcn);
if !is_throwable {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) =
self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(mir_issues::Issue::new(
IssueKind::InvalidThrow {
ty: fqcn.to_string(),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
));
}
}
mir_types::Atomic::TMixed | mir_types::Atomic::TObject => {}
_ => {
let (line, col_start) = self.offset_to_line_col(stmt.span.start);
let (line_end, col_end) = if stmt.span.start < stmt.span.end {
let (end_line, end_col) = self.offset_to_line_col(stmt.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(mir_issues::Issue::new(
IssueKind::InvalidThrow {
ty: format!("{thrown_ty}"),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
));
}
}
}
ctx.diverges = true;
}
// ---- If -----------------------------------------------------------
StmtKind::If(if_stmt) => {
let pre_ctx = ctx.clone();
// Analyse condition expression
let cond_type = self.expr_analyzer(ctx).analyze(&if_stmt.condition, ctx);
let pre_diverges = ctx.diverges;
// True branch
let mut then_ctx = ctx.fork();
narrow_from_condition(
&if_stmt.condition,
&mut then_ctx,
true,
self.codebase,
&self.file,
);
// Capture narrowing-only unreachability before body analysis —
// body divergence (continue/return/throw) must not trigger
// RedundantCondition for valid conditions.
let then_unreachable_from_narrowing = then_ctx.diverges;
// Skip analyzing a statically-unreachable branch (prevents false
// positives in dead branches caused by overly conservative types).
if !then_ctx.diverges {
self.analyze_stmt(if_stmt.then_branch, &mut then_ctx);
}
// ElseIf branches (flatten into separate else-if chain)
let mut elseif_ctxs: Vec<Context> = vec![];
for elseif in if_stmt.elseif_branches.iter() {
// Start from the pre-if context narrowed by the if condition being false
// (an elseif body only runs when the if condition is false).
let mut pre_elseif = ctx.fork();
narrow_from_condition(
&if_stmt.condition,
&mut pre_elseif,
false,
self.codebase,
&self.file,
);
let pre_elseif_diverges = pre_elseif.diverges;
// Check reachability of the elseif body (condition narrowed true)
// and its implicit "skip" path (condition narrowed false) to detect
// redundant elseif conditions.
let mut elseif_true_ctx = pre_elseif.clone();
narrow_from_condition(
&elseif.condition,
&mut elseif_true_ctx,
true,
self.codebase,
&self.file,
);
let mut elseif_false_ctx = pre_elseif.clone();
narrow_from_condition(
&elseif.condition,
&mut elseif_false_ctx,
false,
self.codebase,
&self.file,
);
if !pre_elseif_diverges
&& (elseif_true_ctx.diverges || elseif_false_ctx.diverges)
{
let (line, col_start) =
self.offset_to_line_col(elseif.condition.span.start);
let (line_end, col_end) =
if elseif.condition.span.start < elseif.condition.span.end {
let (end_line, end_col) =
self.offset_to_line_col(elseif.condition.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
let elseif_cond_type = self
.expr_analyzer(ctx)
.analyze(&elseif.condition, &mut ctx.fork());
self.issues.add(
mir_issues::Issue::new(
IssueKind::RedundantCondition {
ty: format!("{elseif_cond_type}"),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
)
.with_snippet(
crate::parser::span_text(self.source, elseif.condition.span)
.unwrap_or_default(),
),
);
}
// Analyze the elseif body using the narrowed-true context.
let mut branch_ctx = elseif_true_ctx;
self.expr_analyzer(&branch_ctx)
.analyze(&elseif.condition, &mut branch_ctx);
if !branch_ctx.diverges {
self.analyze_stmt(&elseif.body, &mut branch_ctx);
}
elseif_ctxs.push(branch_ctx);
}
// Else branch
let mut else_ctx = ctx.fork();
narrow_from_condition(
&if_stmt.condition,
&mut else_ctx,
false,
self.codebase,
&self.file,
);
let else_unreachable_from_narrowing = else_ctx.diverges;
if !else_ctx.diverges {
if let Some(else_branch) = &if_stmt.else_branch {
self.analyze_stmt(else_branch, &mut else_ctx);
}
}
// Emit RedundantCondition if narrowing proves one branch is statically unreachable.
if !pre_diverges
&& (then_unreachable_from_narrowing || else_unreachable_from_narrowing)
{
let (line, col_start) = self.offset_to_line_col(if_stmt.condition.span.start);
let (line_end, col_end) =
if if_stmt.condition.span.start < if_stmt.condition.span.end {
let (end_line, end_col) =
self.offset_to_line_col(if_stmt.condition.span.end);
(end_line, end_col)
} else {
(line, col_start)
};
self.issues.add(
mir_issues::Issue::new(
IssueKind::RedundantCondition {
ty: format!("{cond_type}"),
},
mir_issues::Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
)
.with_snippet(
crate::parser::span_text(self.source, if_stmt.condition.span)
.unwrap_or_default(),
),
);
}
// Merge all branches: start with the if/else pair, then fold each
// elseif in as an additional possible execution path. Using the
// accumulated ctx (not pre_ctx) as the "else" argument ensures every
// branch contributes to the final type environment.
*ctx = Context::merge_branches(&pre_ctx, then_ctx, Some(else_ctx));
for ec in elseif_ctxs {
*ctx = Context::merge_branches(&pre_ctx, ec, Some(ctx.clone()));
}
}
// ---- While --------------------------------------------------------
StmtKind::While(w) => {
self.expr_analyzer(ctx).analyze(&w.condition, ctx);
let pre = ctx.clone();
// Entry context: narrow on true condition
let mut entry = ctx.fork();
narrow_from_condition(&w.condition, &mut entry, true, self.codebase, &self.file);
let post = self.analyze_loop_widened(&pre, entry, |sa, iter| {
sa.analyze_stmt(w.body, iter);
sa.expr_analyzer(iter).analyze(&w.condition, iter);
});
*ctx = post;
}
// ---- Do-while -----------------------------------------------------
StmtKind::DoWhile(dw) => {
let pre = ctx.clone();
let entry = ctx.fork();
let post = self.analyze_loop_widened(&pre, entry, |sa, iter| {
sa.analyze_stmt(dw.body, iter);
sa.expr_analyzer(iter).analyze(&dw.condition, iter);
});
*ctx = post;
}
// ---- For ----------------------------------------------------------
StmtKind::For(f) => {
// Init expressions run once before the loop
for init in f.init.iter() {
self.expr_analyzer(ctx).analyze(init, ctx);
}
let pre = ctx.clone();
let mut entry = ctx.fork();
for cond in f.condition.iter() {
self.expr_analyzer(&entry).analyze(cond, &mut entry);
}
let post = self.analyze_loop_widened(&pre, entry, |sa, iter| {
sa.analyze_stmt(f.body, iter);
for update in f.update.iter() {
sa.expr_analyzer(iter).analyze(update, iter);
}
for cond in f.condition.iter() {
sa.expr_analyzer(iter).analyze(cond, iter);
}
});
*ctx = post;
}
// ---- Foreach ------------------------------------------------------
StmtKind::Foreach(fe) => {
let arr_ty = self.expr_analyzer(ctx).analyze(&fe.expr, ctx);
let (key_ty, mut value_ty) = infer_foreach_types(&arr_ty);
// Apply `@var Type $varname` annotation on the foreach value variable.
// The annotation always wins — it is the developer's explicit type assertion.
if let Some(vname) = crate::expr::extract_simple_var(&fe.value) {
if let Some((Some(ann_var), ann_ty)) = self.extract_var_annotation(stmt.span) {
if ann_var == vname {
value_ty = ann_ty;
}
}
}
let pre = ctx.clone();
let mut entry = ctx.fork();
// Bind key variable on loop entry
if let Some(key_expr) = &fe.key {
if let Some(var_name) = crate::expr::extract_simple_var(key_expr) {
entry.set_var(var_name, key_ty.clone());
}
}
// Bind value variable on loop entry.
// The value may be a simple variable or a list/array destructure pattern.
let value_var = crate::expr::extract_simple_var(&fe.value);
let value_destructure_vars = crate::expr::extract_destructure_vars(&fe.value);
if let Some(ref vname) = value_var {
entry.set_var(vname.as_str(), value_ty.clone());
} else {
for vname in &value_destructure_vars {
entry.set_var(vname, Union::mixed());
}
}
let post = self.analyze_loop_widened(&pre, entry, |sa, iter| {
// Re-bind key/value each iteration (array may change)
if let Some(key_expr) = &fe.key {
if let Some(var_name) = crate::expr::extract_simple_var(key_expr) {
iter.set_var(var_name, key_ty.clone());
}
}
if let Some(ref vname) = value_var {
iter.set_var(vname.as_str(), value_ty.clone());
} else {
for vname in &value_destructure_vars {
iter.set_var(vname, Union::mixed());
}
}
sa.analyze_stmt(fe.body, iter);
});
*ctx = post;
}
// ---- Switch -------------------------------------------------------
StmtKind::Switch(sw) => {
let _subject_ty = self.expr_analyzer(ctx).analyze(&sw.expr, ctx);
// Extract the subject variable name for narrowing (if it's a simple var)
let subject_var: Option<String> = match &sw.expr.kind {
php_ast::ast::ExprKind::Variable(name) => {
Some(name.as_str().trim_start_matches('$').to_string())
}
_ => None,
};
// Detect `switch(true)` — case conditions are used as narrowing expressions
let switch_on_true = matches!(&sw.expr.kind, php_ast::ast::ExprKind::Bool(true));
let pre_ctx = ctx.clone();
// Push a break-context bucket so that `break` inside cases saves
// the case's context for merging into the post-switch result.
self.break_ctx_stack.push(Vec::new());
let has_default = sw.cases.iter().any(|c| c.value.is_none());
// First pass: analyse each case body independently from pre_ctx.
// Break statements inside a body save their context to break_ctx_stack
// automatically; we just collect the per-case contexts here.
let mut case_results: Vec<Context> = Vec::new();
for case in sw.cases.iter() {
let mut case_ctx = pre_ctx.fork();
if let Some(val) = &case.value {
if switch_on_true {
// `switch(true) { case $x instanceof Y: }` — narrow from condition
narrow_from_condition(
val,
&mut case_ctx,
true,
self.codebase,
&self.file,
);
} else if let Some(ref var_name) = subject_var {
// Narrow subject var to the literal type of the case value
let narrow_ty = match &val.kind {
php_ast::ast::ExprKind::Int(n) => {
Some(Union::single(Atomic::TLiteralInt(*n)))
}
php_ast::ast::ExprKind::String(s) => {
Some(Union::single(Atomic::TLiteralString(Arc::from(&**s))))
}
php_ast::ast::ExprKind::Bool(b) => Some(Union::single(if *b {
Atomic::TTrue
} else {
Atomic::TFalse
})),
php_ast::ast::ExprKind::Null => Some(Union::single(Atomic::TNull)),
_ => None,
};
if let Some(narrowed) = narrow_ty {
case_ctx.set_var(var_name, narrowed);
}
}
self.expr_analyzer(&case_ctx).analyze(val, &mut case_ctx);
}
self.analyze_stmts(&case.body, &mut case_ctx);
case_results.push(case_ctx);
}
// Second pass: propagate divergence backwards through the fallthrough
// chain. A non-diverging case (no break/return/throw) flows into the
// next case at runtime, so if that next case effectively diverges, this
// case effectively diverges too.
//
// Example:
// case 1: $y = "a"; // no break — chains into case 2
// case 2: return; // diverges
//
// Case 1 is effectively diverging because its only exit is through
// case 2's return. Adding case 1 to fallthrough_ctxs would be wrong.
let n = case_results.len();
let mut effective_diverges = vec![false; n];
for i in (0..n).rev() {
if case_results[i].diverges {
effective_diverges[i] = true;
} else if i + 1 < n {
// Non-diverging body: falls through to the next case.
effective_diverges[i] = effective_diverges[i + 1];
}
// else: last case with no break/return — falls to end of switch.
}
// Build fallthrough_ctxs from cases that truly exit via the end of
// the switch (not through a subsequent diverging case).
let mut all_cases_diverge = true;
let mut fallthrough_ctxs: Vec<Context> = Vec::new();
for (i, case_ctx) in case_results.into_iter().enumerate() {
if !effective_diverges[i] {
all_cases_diverge = false;
fallthrough_ctxs.push(case_ctx);
}
}
// Pop break contexts — each `break` in a case body pushed its
// context here, representing that case's effect on post-switch state.
let break_ctxs = self.break_ctx_stack.pop().unwrap_or_default();
// Build the post-switch merged context:
// Start with pre_ctx if no default case (switch might not match anything)
// or if not all cases diverge via return/throw.
let mut merged = if has_default
&& all_cases_diverge
&& break_ctxs.is_empty()
&& fallthrough_ctxs.is_empty()
{
// All paths return/throw — post-switch is unreachable
let mut m = pre_ctx.clone();
m.diverges = true;
m
} else {
// Start from pre_ctx (covers the "no case matched" path when there
// is no default, plus ensures pre-existing variables are preserved).
pre_ctx.clone()
};
for bctx in break_ctxs {
merged = Context::merge_branches(&pre_ctx, bctx, Some(merged));
}
for fctx in fallthrough_ctxs {
merged = Context::merge_branches(&pre_ctx, fctx, Some(merged));
}
*ctx = merged;
}
// ---- Try/catch/finally -------------------------------------------
StmtKind::TryCatch(tc) => {
let pre_ctx = ctx.clone();
let mut try_ctx = ctx.fork();
self.analyze_stmts(&tc.body, &mut try_ctx);
// Build a base context for catch blocks that merges pre and try contexts.
// Variables that might have been set during the try body are "possibly assigned"
// in the catch (they may or may not have been set before the exception fired).
let catch_base = Context::merge_branches(&pre_ctx, try_ctx.clone(), None);
let mut non_diverging_catches: Vec<Context> = vec![];
for catch in tc.catches.iter() {
let mut catch_ctx = catch_base.clone();
// Check that all caught exception types exist.
for catch_ty in catch.types.iter() {
self.check_name_undefined_class(catch_ty);
}
if let Some(var) = catch.var {
// Bind the caught exception variable; union all caught types
let exc_ty = if catch.types.is_empty() {
Union::single(Atomic::TObject)
} else {
let mut u = Union::empty();
for catch_ty in catch.types.iter() {
let raw = crate::parser::name_to_string(catch_ty);
let resolved = self.codebase.resolve_class_name(&self.file, &raw);
u.add_type(Atomic::TNamedObject {
fqcn: resolved.into(),
type_params: vec![],
});
}
u
};
catch_ctx.set_var(var.trim_start_matches('$'), exc_ty);
}
self.analyze_stmts(&catch.body, &mut catch_ctx);
if !catch_ctx.diverges {
non_diverging_catches.push(catch_ctx);
}
}
// If ALL catch branches diverge (return/throw/continue/break),
// code after the try/catch is only reachable from the try body.
// Use try_ctx directly so variables assigned in try are definitely set.
let mut result = if non_diverging_catches.is_empty() {
let mut r = try_ctx;
r.diverges = false; // the try body itself may not have diverged
r
} else {
// Some catches don't diverge — merge try with all non-diverging catches.
// Chain the merges: start with try_ctx, then fold in each catch branch.
let mut r = try_ctx;
for catch_ctx in non_diverging_catches {
r = Context::merge_branches(&pre_ctx, r, Some(catch_ctx));
}
r
};
// Finally runs unconditionally — analyze but don't merge vars
if let Some(finally_stmts) = &tc.finally {
let mut finally_ctx = result.clone();
finally_ctx.inside_finally = true;
self.analyze_stmts(finally_stmts, &mut finally_ctx);
if finally_ctx.diverges {
result.diverges = true;
}
}
*ctx = result;
}
// ---- Block --------------------------------------------------------
StmtKind::Block(stmts) => {
self.analyze_stmts(stmts, ctx);
}
// ---- Break --------------------------------------------------------
StmtKind::Break(_) => {
// Save the context at the break point so the post-loop context
// accounts for this early-exit path.
if let Some(break_ctxs) = self.break_ctx_stack.last_mut() {
break_ctxs.push(ctx.clone());
}
// Context after an unconditional break is dead; don't continue
// emitting issues for code after this point.
ctx.diverges = true;
}
// ---- Continue ----------------------------------------------------
StmtKind::Continue(_) => {
// continue goes back to the loop condition — no context to save,
// the widening pass already re-analyses the body.
ctx.diverges = true;
}
// ---- Unset --------------------------------------------------------
StmtKind::Unset(vars) => {
for var in vars.iter() {
if let php_ast::ast::ExprKind::Variable(name) = &var.kind {
ctx.unset_var(name.as_str().trim_start_matches('$'));
}
}
}
// ---- Static variable declaration ---------------------------------
StmtKind::StaticVar(vars) => {
for sv in vars.iter() {
let ty = Union::mixed(); // static vars are indeterminate on entry
ctx.set_var(sv.name.trim_start_matches('$'), ty);
}
}
// ---- Global declaration ------------------------------------------
StmtKind::Global(vars) => {
for var in vars.iter() {
if let php_ast::ast::ExprKind::Variable(name) = &var.kind {
let var_name = name.as_str().trim_start_matches('$');
let ty = self
.codebase
.global_vars
.get(var_name)
.map(|r| r.clone())
.unwrap_or_else(Union::mixed);
ctx.set_var(var_name, ty);
}
}
}
// ---- Declare -----------------------------------------------------
StmtKind::Declare(d) => {
for (name, _val) in d.directives.iter() {
if *name == "strict_types" {
ctx.strict_types = true;
}
}
if let Some(body) = &d.body {
self.analyze_stmt(body, ctx);
}
}
// ---- Nested declarations (inside function bodies) ----------------
StmtKind::Function(decl) => {
// Nested named function — analyze its body in the same issue buffer
// so that undefined-function/class calls inside it are reported.
let params: Vec<mir_codebase::FnParam> = decl
.params
.iter()
.map(|p| mir_codebase::FnParam {
name: std::sync::Arc::from(p.name.trim_start_matches('$')),
ty: None,
default: p.default.as_ref().map(|_| Union::mixed()),
is_variadic: p.variadic,
is_byref: p.by_ref,
is_optional: p.default.is_some() || p.variadic,
})
.collect();
let mut fn_ctx =
Context::for_function(¶ms, None, None, None, None, ctx.strict_types, true);
let mut sa = StatementsAnalyzer::new(
self.codebase,
self.file.clone(),
self.source,
self.source_map,
self.issues,
self.symbols,
self.php_version,
);
sa.analyze_stmts(&decl.body, &mut fn_ctx);
}
StmtKind::Class(decl) => {
// Nested class declaration — analyze each method body in the same
// issue buffer so that undefined-function/class calls are reported.
let class_name = decl.name.unwrap_or("<anonymous>");
let resolved = self.codebase.resolve_class_name(&self.file, class_name);
let fqcn: Arc<str> = Arc::from(resolved.as_str());
let parent_fqcn = self
.codebase
.classes
.get(fqcn.as_ref())
.and_then(|c| c.parent.clone());
for member in decl.members.iter() {
let php_ast::ast::ClassMemberKind::Method(method) = &member.kind else {
continue;
};
let Some(body) = &method.body else { continue };
let (params, return_ty) = self
.codebase
.get_method(fqcn.as_ref(), method.name)
.as_deref()
.map(|m| (m.params.clone(), m.return_type.clone()))
.unwrap_or_else(|| {
let ast_params = method
.params
.iter()
.map(|p| mir_codebase::FnParam {
name: p.name.trim_start_matches('$').into(),
ty: None,
default: p.default.as_ref().map(|_| mir_types::Union::mixed()),
is_variadic: p.variadic,
is_byref: p.by_ref,
is_optional: p.default.is_some() || p.variadic,
})
.collect();
(ast_params, None)
});
let is_ctor = method.name == "__construct";
let mut method_ctx = Context::for_method(
¶ms,
return_ty,
Some(fqcn.clone()),
parent_fqcn.clone(),
Some(fqcn.clone()),
ctx.strict_types,
is_ctor,
method.is_static,
);
let mut sa = StatementsAnalyzer::new(
self.codebase,
self.file.clone(),
self.source,
self.source_map,
self.issues,
self.symbols,
self.php_version,
);
sa.analyze_stmts(body, &mut method_ctx);
}
}
StmtKind::Interface(_) | StmtKind::Trait(_) | StmtKind::Enum(_) => {
// Interfaces/traits/enums are collected in Pass 1 — skip here
}
// ---- Namespace / use (at file level, already handled in Pass 1) --
StmtKind::Namespace(_) | StmtKind::Use(_) | StmtKind::Const(_) => {}
// ---- Inert --------------------------------------------------------
StmtKind::InlineHtml(_)
| StmtKind::Nop
| StmtKind::Goto(_)
| StmtKind::Label(_)
| StmtKind::HaltCompiler(_) => {}
StmtKind::Error => {}
}
}
// -----------------------------------------------------------------------
// Helper: create a short-lived ExpressionAnalyzer borrowing our fields
// -----------------------------------------------------------------------
fn expr_analyzer<'b>(&'b mut self, _ctx: &Context) -> ExpressionAnalyzer<'b>
where
'a: 'b,
{
ExpressionAnalyzer::new(
self.codebase,
self.file.clone(),
self.source,
self.source_map,
self.issues,
self.symbols,
self.php_version,
)
}
/// Convert a byte offset to a Unicode char-count column on a given line.
/// Returns (line, col) where col is a 0-based Unicode code-point count.
fn offset_to_line_col(&self, offset: u32) -> (u32, u16) {
let lc = self.source_map.offset_to_line_col(offset);
let line = lc.line + 1;
let byte_offset = offset as usize;
let line_start_byte = if byte_offset == 0 {
0
} else {
self.source[..byte_offset]
.rfind('\n')
.map(|p| p + 1)
.unwrap_or(0)
};
let col = self.source[line_start_byte..byte_offset].chars().count() as u16;
(line, col)
}
/// Emit `UndefinedClass` for a `Name` AST node if the resolved class does not exist.
fn check_name_undefined_class(&mut self, name: &php_ast::ast::Name<'_, '_>) {
let raw = crate::parser::name_to_string(name);
let resolved = self.codebase.resolve_class_name(&self.file, &raw);
if matches!(resolved.as_str(), "self" | "static" | "parent") {
return;
}
if self.codebase.type_exists(&resolved) {
return;
}
let span = name.span();
let (line, col_start) = self.offset_to_line_col(span.start);
let (line_end, col_end) = self.offset_to_line_col(span.end);
self.issues.add(Issue::new(
IssueKind::UndefinedClass { name: resolved },
Location {
file: self.file.clone(),
line,
line_end,
col_start,
col_end: col_end.max(col_start + 1),
},
));
}
// -----------------------------------------------------------------------
// @psalm-suppress / @suppress per-statement
// -----------------------------------------------------------------------
/// Extract suppression names from the `@psalm-suppress` / `@suppress`
/// annotation in the docblock immediately preceding `span`.
fn extract_statement_suppressions(&self, span: php_ast::Span) -> Vec<String> {
let Some(doc) = crate::parser::find_preceding_docblock(self.source, span.start) else {
return vec![];
};
let mut suppressions = Vec::new();
for line in doc.lines() {
let line = line.trim().trim_start_matches('*').trim();
let rest = if let Some(r) = line.strip_prefix("@psalm-suppress ") {
r
} else if let Some(r) = line.strip_prefix("@suppress ") {
r
} else {
continue;
};
for name in rest.split_whitespace() {
suppressions.push(name.to_string());
}
}
suppressions
}
/// Extract `@var Type [$varname]` from the docblock immediately preceding `span`.
/// Returns `(optional_var_name, resolved_type)` if an annotation exists.
/// The type is resolved through the codebase's file-level imports/namespace.
fn extract_var_annotation(
&self,
span: php_ast::Span,
) -> Option<(Option<String>, mir_types::Union)> {
let doc = crate::parser::find_preceding_docblock(self.source, span.start)?;
let parsed = crate::parser::DocblockParser::parse(&doc);
let ty = parsed.var_type?;
let resolved = resolve_union_for_file(ty, self.codebase, &self.file);
Some((parsed.var_name, resolved))
}
// -----------------------------------------------------------------------
// Fixed-point loop widening (M12)
// -----------------------------------------------------------------------
/// Analyse a loop body with a fixed-point widening algorithm (≤ 3 passes).
///
/// * `pre` — context *before* the loop (used as the merge base)
/// * `entry` — context on first iteration entry (may be narrowed / seeded)
/// * `body` — closure that analyses one loop iteration, receives `&mut Self`
/// and `&mut Context` for the current iteration context
///
/// Returns the post-loop context that merges:
/// - the stable widened context after normal loop exit
/// - any contexts captured at `break` statements
fn analyze_loop_widened<F>(&mut self, pre: &Context, entry: Context, mut body: F) -> Context
where
F: FnMut(&mut Self, &mut Context),
{
const MAX_ITERS: usize = 3;
// Push a fresh break-context bucket for this loop level
self.break_ctx_stack.push(Vec::new());
let mut current = entry;
current.inside_loop = true;
for _ in 0..MAX_ITERS {
let prev_vars = current.vars.clone();
let mut iter = current.clone();
body(self, &mut iter);
let next = Context::merge_branches(pre, iter, None);
if vars_stabilized(&prev_vars, &next.vars) {
current = next;
break;
}
current = next;
}
// Widen any variable still unstable after MAX_ITERS to `mixed`
widen_unstable(&pre.vars, &mut current.vars);
// Pop break contexts and merge them into the post-loop result
let break_ctxs = self.break_ctx_stack.pop().unwrap_or_default();
for bctx in break_ctxs {
current = Context::merge_branches(pre, current, Some(bctx));
}
current
}
}
// ---------------------------------------------------------------------------
// Loop widening helpers
// ---------------------------------------------------------------------------
/// Returns true when every variable present in `prev` has the same type in
/// `next`, indicating the fixed-point has been reached.
fn vars_stabilized(
prev: &indexmap::IndexMap<String, Union>,
next: &indexmap::IndexMap<String, Union>,
) -> bool {
if prev.len() != next.len() {
return false;
}
prev.iter()
.all(|(k, v)| next.get(k).map(|u| u == v).unwrap_or(false))
}
/// For any variable whose type changed relative to `pre_vars`, widen to
/// `mixed`. Called after MAX_ITERS to avoid non-termination.
fn widen_unstable(
pre_vars: &indexmap::IndexMap<String, Union>,
current_vars: &mut indexmap::IndexMap<String, Union>,
) {
for (name, ty) in current_vars.iter_mut() {
if pre_vars.get(name).map(|p| p != ty).unwrap_or(true) && !ty.is_mixed() {
*ty = Union::mixed();
}
}
}
// ---------------------------------------------------------------------------
// foreach key/value type inference
// ---------------------------------------------------------------------------
fn infer_foreach_types(arr_ty: &Union) -> (Union, Union) {
if arr_ty.is_mixed() {
return (Union::mixed(), Union::mixed());
}
for atomic in &arr_ty.types {
match atomic {
Atomic::TArray { key, value } | Atomic::TNonEmptyArray { key, value } => {
return (*key.clone(), *value.clone());
}
Atomic::TList { value } | Atomic::TNonEmptyList { value } => {
return (Union::single(Atomic::TInt), *value.clone());
}
Atomic::TKeyedArray { properties, .. } => {
let mut keys = Union::empty();
let mut values = Union::empty();
for (k, prop) in properties {
let key_atomic = match k {
ArrayKey::String(s) => Atomic::TLiteralString(s.clone()),
ArrayKey::Int(i) => Atomic::TLiteralInt(*i),
};
keys = Union::merge(&keys, &Union::single(key_atomic));
values = Union::merge(&values, &prop.ty);
}
// Empty keyed array (e.g. `$arr = []` before push) — treat both as
// mixed to avoid propagating Union::empty() as a variable type.
let keys = if keys.is_empty() {
Union::mixed()
} else {
keys
};
let values = if values.is_empty() {
Union::mixed()
} else {
values
};
return (keys, values);
}
Atomic::TString => {
return (Union::single(Atomic::TInt), Union::single(Atomic::TString));
}
_ => {}
}
}
(Union::mixed(), Union::mixed())
}
// ---------------------------------------------------------------------------
// Named-object return type compatibility check
// ---------------------------------------------------------------------------
/// Returns true if `actual` is compatible with `declared` considering class
/// hierarchy, self/static resolution, and short-name vs FQCN mismatches.
fn named_object_return_compatible(
actual: &Union,
declared: &Union,
codebase: &Codebase,
file: &str,
) -> bool {
actual.types.iter().all(|actual_atom| {
// Extract the actual FQCN — handles TNamedObject, TSelf, TStaticObject, TParent
let actual_fqcn: &Arc<str> = match actual_atom {
Atomic::TNamedObject { fqcn, .. } => fqcn,
Atomic::TSelf { fqcn } => fqcn,
Atomic::TStaticObject { fqcn } => fqcn,
Atomic::TParent { fqcn } => fqcn,
// TNull: compatible if declared also includes null
Atomic::TNull => return declared.types.iter().any(|d| matches!(d, Atomic::TNull)),
// TVoid: compatible with void declared
Atomic::TVoid => {
return declared
.types
.iter()
.any(|d| matches!(d, Atomic::TVoid | Atomic::TNull))
}
// TNever is the bottom type — compatible with anything
Atomic::TNever => return true,
// class-string<X> is compatible with class-string<Y> if X extends/implements Y
Atomic::TClassString(Some(actual_cls)) => {
return declared.types.iter().any(|d| match d {
Atomic::TClassString(None) => true,
Atomic::TClassString(Some(declared_cls)) => {
actual_cls == declared_cls
|| codebase
.extends_or_implements(actual_cls.as_ref(), declared_cls.as_ref())
}
Atomic::TString => true,
_ => false,
});
}
Atomic::TClassString(None) => {
return declared
.types
.iter()
.any(|d| matches!(d, Atomic::TClassString(_) | Atomic::TString));
}
// Non-object types: not handled here (fall through to simple subtype check)
_ => return false,
};
declared.types.iter().any(|declared_atom| {
// Extract declared FQCN — also handle self/static/parent in declared type
let declared_fqcn: &Arc<str> = match declared_atom {
Atomic::TNamedObject { fqcn, .. } => fqcn,
Atomic::TSelf { fqcn } => fqcn,
Atomic::TStaticObject { fqcn } => fqcn,
Atomic::TParent { fqcn } => fqcn,
_ => return false,
};
let resolved_declared = codebase.resolve_class_name(file, declared_fqcn.as_ref());
let resolved_actual = codebase.resolve_class_name(file, actual_fqcn.as_ref());
// Self/static always compatible with the class itself
if matches!(
actual_atom,
Atomic::TSelf { .. } | Atomic::TStaticObject { .. }
) && (resolved_actual == resolved_declared
|| actual_fqcn.as_ref() == declared_fqcn.as_ref()
|| actual_fqcn.as_ref() == resolved_declared.as_str()
|| resolved_actual.as_str() == declared_fqcn.as_ref()
|| codebase.extends_or_implements(actual_fqcn.as_ref(), &resolved_declared)
|| codebase.extends_or_implements(actual_fqcn.as_ref(), declared_fqcn.as_ref())
|| codebase.extends_or_implements(&resolved_actual, &resolved_declared)
|| codebase.extends_or_implements(&resolved_actual, declared_fqcn.as_ref())
// static(X) is compatible with declared Y if Y extends X
// (because when called on Y, static = Y which satisfies declared Y)
|| codebase.extends_or_implements(&resolved_declared, actual_fqcn.as_ref())
|| codebase.extends_or_implements(&resolved_declared, &resolved_actual)
|| codebase.extends_or_implements(declared_fqcn.as_ref(), actual_fqcn.as_ref()))
{
return true;
}
// Same class after resolution — check generic type params with variance
let is_same_class = resolved_actual == resolved_declared
|| actual_fqcn.as_ref() == declared_fqcn.as_ref()
|| actual_fqcn.as_ref() == resolved_declared.as_str()
|| resolved_actual.as_str() == declared_fqcn.as_ref();
if is_same_class {
let actual_type_params = match actual_atom {
Atomic::TNamedObject { type_params, .. } => type_params.as_slice(),
_ => &[],
};
let declared_type_params = match declared_atom {
Atomic::TNamedObject { type_params, .. } => type_params.as_slice(),
_ => &[],
};
if !actual_type_params.is_empty() || !declared_type_params.is_empty() {
let class_tps = codebase.get_class_template_params(&resolved_declared);
return return_type_params_compatible(
actual_type_params,
declared_type_params,
&class_tps,
);
}
return true;
}
// Inheritance check
codebase.extends_or_implements(actual_fqcn.as_ref(), &resolved_declared)
|| codebase.extends_or_implements(actual_fqcn.as_ref(), declared_fqcn.as_ref())
|| codebase.extends_or_implements(&resolved_actual, &resolved_declared)
|| codebase.extends_or_implements(&resolved_actual, declared_fqcn.as_ref())
})
})
}
/// Check whether generic return type parameters are compatible according to each parameter's
/// declared variance. Simpler than the arg-checking version — uses only structural subtyping
/// since we don't have access to ExpressionAnalyzer here.
fn return_type_params_compatible(
actual_params: &[Union],
declared_params: &[Union],
template_params: &[mir_codebase::storage::TemplateParam],
) -> bool {
if actual_params.len() != declared_params.len() {
return true;
}
if actual_params.is_empty() {
return true;
}
for (i, (actual_p, declared_p)) in actual_params.iter().zip(declared_params.iter()).enumerate()
{
let variance = template_params
.get(i)
.map(|tp| tp.variance)
.unwrap_or(mir_types::Variance::Invariant);
let compatible = match variance {
mir_types::Variance::Covariant => {
actual_p.is_subtype_of_simple(declared_p)
|| declared_p.is_mixed()
|| actual_p.is_mixed()
}
mir_types::Variance::Contravariant => {
declared_p.is_subtype_of_simple(actual_p)
|| actual_p.is_mixed()
|| declared_p.is_mixed()
}
mir_types::Variance::Invariant => {
actual_p == declared_p
|| actual_p.is_mixed()
|| declared_p.is_mixed()
|| (actual_p.is_subtype_of_simple(declared_p)
&& declared_p.is_subtype_of_simple(actual_p))
}
};
if !compatible {
return false;
}
}
true
}
/// Returns true if the declared return type contains template-like types (unknown FQCNs
/// without namespace separator that don't exist in the codebase) — we can't validate
/// return types against generic type parameters without full template instantiation.
fn declared_return_has_template(declared: &Union, codebase: &Codebase) -> bool {
declared.types.iter().any(|atomic| match atomic {
Atomic::TTemplateParam { .. } => true,
// Generic class instantiation (e.g. Result<string, void>) — skip without full template inference.
// Also skip when the named class doesn't exist in the codebase (e.g. type aliases
// that were resolved to a fully-qualified name but aren't real classes).
// Also skip when the type is an interface — concrete implementations may satisfy the
// declared type in ways we don't track (not flagged at default error level).
Atomic::TNamedObject { fqcn, type_params } => {
!type_params.is_empty()
|| !codebase.type_exists(fqcn.as_ref())
|| codebase.interfaces.contains_key(fqcn.as_ref())
}
Atomic::TArray { value, .. }
| Atomic::TList { value }
| Atomic::TNonEmptyArray { value, .. }
| Atomic::TNonEmptyList { value } => value.types.iter().any(|v| match v {
Atomic::TTemplateParam { .. } => true,
Atomic::TNamedObject { fqcn, .. } => {
!fqcn.contains('\\') && !codebase.type_exists(fqcn.as_ref())
}
_ => false,
}),
_ => false,
})
}
/// Resolve all TNamedObject FQCNs in a Union using the codebase's file-level imports/namespace.
/// Used to fix up `@var` annotation types that were parsed without namespace context.
fn resolve_union_for_file(union: Union, codebase: &Codebase, file: &str) -> Union {
let mut result = Union::empty();
result.possibly_undefined = union.possibly_undefined;
result.from_docblock = union.from_docblock;
for atomic in union.types {
let resolved = resolve_atomic_for_file(atomic, codebase, file);
result.types.push(resolved);
}
result
}
fn is_resolvable_class_name(s: &str) -> bool {
!s.is_empty()
&& s.chars()
.all(|c| c.is_alphanumeric() || c == '_' || c == '\\')
}
fn resolve_atomic_for_file(atomic: Atomic, codebase: &Codebase, file: &str) -> Atomic {
match atomic {
Atomic::TNamedObject { fqcn, type_params } => {
if !is_resolvable_class_name(fqcn.as_ref()) {
return Atomic::TNamedObject { fqcn, type_params };
}
let resolved = codebase.resolve_class_name(file, fqcn.as_ref());
Atomic::TNamedObject {
fqcn: resolved.into(),
type_params,
}
}
Atomic::TClassString(Some(cls)) => {
let resolved = codebase.resolve_class_name(file, cls.as_ref());
Atomic::TClassString(Some(resolved.into()))
}
Atomic::TList { value } => Atomic::TList {
value: Box::new(resolve_union_for_file(*value, codebase, file)),
},
Atomic::TNonEmptyList { value } => Atomic::TNonEmptyList {
value: Box::new(resolve_union_for_file(*value, codebase, file)),
},
Atomic::TArray { key, value } => Atomic::TArray {
key: Box::new(resolve_union_for_file(*key, codebase, file)),
value: Box::new(resolve_union_for_file(*value, codebase, file)),
},
Atomic::TSelf { fqcn } if fqcn.is_empty() => {
// Sentinel from docblock parser — leave as-is; caller handles it
Atomic::TSelf { fqcn }
}
other => other,
}
}
/// Returns true if both actual and declared are array/list types whose value types are
/// compatible with FQCN resolution (to avoid short-name vs FQCN mismatches in return types).
fn return_arrays_compatible(
actual: &Union,
declared: &Union,
codebase: &Codebase,
file: &str,
) -> bool {
actual.types.iter().all(|a_atomic| {
let act_val: &Union = match a_atomic {
Atomic::TArray { value, .. }
| Atomic::TNonEmptyArray { value, .. }
| Atomic::TList { value }
| Atomic::TNonEmptyList { value } => value,
Atomic::TKeyedArray { .. } => return true,
_ => return false,
};
declared.types.iter().any(|d_atomic| {
let dec_val: &Union = match d_atomic {
Atomic::TArray { value, .. }
| Atomic::TNonEmptyArray { value, .. }
| Atomic::TList { value }
| Atomic::TNonEmptyList { value } => value,
_ => return false,
};
act_val.types.iter().all(|av| {
match av {
Atomic::TNever => return true,
Atomic::TClassString(Some(av_cls)) => {
return dec_val.types.iter().any(|dv| match dv {
Atomic::TClassString(None) | Atomic::TString => true,
Atomic::TClassString(Some(dv_cls)) => {
av_cls == dv_cls
|| codebase
.extends_or_implements(av_cls.as_ref(), dv_cls.as_ref())
}
_ => false,
});
}
_ => {}
}
let av_fqcn: &Arc<str> = match av {
Atomic::TNamedObject { fqcn, .. } => fqcn,
Atomic::TSelf { fqcn } | Atomic::TStaticObject { fqcn } => fqcn,
Atomic::TClosure { .. } => return true,
_ => return Union::single(av.clone()).is_subtype_of_simple(dec_val),
};
dec_val.types.iter().any(|dv| {
let dv_fqcn: &Arc<str> = match dv {
Atomic::TNamedObject { fqcn, .. } => fqcn,
Atomic::TClosure { .. } => return true,
_ => return false,
};
if !dv_fqcn.contains('\\') && !codebase.type_exists(dv_fqcn.as_ref()) {
return true; // template param wildcard
}
let res_dec = codebase.resolve_class_name(file, dv_fqcn.as_ref());
let res_act = codebase.resolve_class_name(file, av_fqcn.as_ref());
res_dec == res_act
|| codebase.extends_or_implements(av_fqcn.as_ref(), &res_dec)
|| codebase.extends_or_implements(&res_act, &res_dec)
})
})
})
})
}