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
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
|
Ported from clangd, this still can be improved over time, but it can be landed.
This was based on the work from https://bit.ly/3TkV2N1
The utility makes the assumption that all header are self contained!
It only checkes Decls from the main translation file, where SourceLocarion is the passed cpp file.
It builds a list with all of the includes from the translation unit.
It matches all of the Decls from the main translation units with definitions from the included header files and builds a list with used header files.
All of the includes that are not part of the matched used header files are considered to be unused. Of course this is correct if the first assumption if followed by the coding guide, where all of the header are self contained. Since the mozilla code base doesn't follow this approach false positives might appear where the is the following situation:
FOO.cpp
#include <A>
#Include <B>
If header A defines a symbol that is used by header B and B doesn't include A nor
it has symbols defined that are used by FOO.cpp then B it will be marked as potentially to be removed
by the tool.
This is the limitation determined by header that are not self contained.
The limitation presented above can be fixed in the future with extra work, but it's very time expensive
during the runtime of the checker.
diff --git a/clang-tools-extra/CMakeLists.txt b/clang-tools-extra/CMakeLists.txt
index 6a3f741721ee..ff17c8e8472a 100644
--- a/clang-tools-extra/CMakeLists.txt
+++ b/clang-tools-extra/CMakeLists.txt
@@ -16,6 +16,7 @@ endif()
add_subdirectory(clang-apply-replacements)
add_subdirectory(clang-reorder-fields)
add_subdirectory(modularize)
+add_subdirectory(include-cleaner)
add_subdirectory(clang-tidy)
add_subdirectory(clang-change-namespace)
@@ -23,7 +24,6 @@ add_subdirectory(clang-doc)
add_subdirectory(clang-include-fixer)
add_subdirectory(clang-move)
add_subdirectory(clang-query)
-add_subdirectory(include-cleaner)
add_subdirectory(pp-trace)
add_subdirectory(pseudo)
add_subdirectory(tool-template)
diff --git a/clang-tools-extra/clang-tidy/CMakeLists.txt b/clang-tools-extra/clang-tidy/CMakeLists.txt
index 8a953eeea275..f2edc509acaf 100644
--- a/clang-tools-extra/clang-tidy/CMakeLists.txt
+++ b/clang-tools-extra/clang-tidy/CMakeLists.txt
@@ -50,6 +50,7 @@ endif()
# Checks.
# If you add a check, also add it to ClangTidyForceLinker.h in this directory.
+add_subdirectory(alpha)
add_subdirectory(android)
add_subdirectory(abseil)
add_subdirectory(altera)
@@ -77,6 +78,7 @@ add_subdirectory(portability)
add_subdirectory(readability)
add_subdirectory(zircon)
set(ALL_CLANG_TIDY_CHECKS
+ clangTidyAlphaModule
clangTidyAndroidModule
clangTidyAbseilModule
clangTidyAlteraModule
diff --git a/clang-tools-extra/clang-tidy/ClangTidyForceLinker.h b/clang-tools-extra/clang-tidy/ClangTidyForceLinker.h
index 2691d90fa521..2fa064cff22a 100644
--- a/clang-tools-extra/clang-tidy/ClangTidyForceLinker.h
+++ b/clang-tools-extra/clang-tidy/ClangTidyForceLinker.h
@@ -20,6 +20,11 @@ extern volatile int AbseilModuleAnchorSource;
static int LLVM_ATTRIBUTE_UNUSED AbseilModuleAnchorDestination =
AbseilModuleAnchorSource;
+// This anchor is used to force the linker to link the AlphaModule.
+extern volatile int AlphaModuleAnchorSource;
+static int LLVM_ATTRIBUTE_UNUSED AlphaModuleAnchorDestination =
+ AlphaModuleAnchorSource;
+
// This anchor is used to force the linker to link the AlteraModule.
extern volatile int AlteraModuleAnchorSource;
static int LLVM_ATTRIBUTE_UNUSED AlteraModuleAnchorDestination =
diff --git a/clang-tools-extra/clang-tidy/alpha/AlphaTidyModule.cpp b/clang-tools-extra/clang-tidy/alpha/AlphaTidyModule.cpp
new file mode 100644
index 000000000000..b598a36cebf7
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/alpha/AlphaTidyModule.cpp
@@ -0,0 +1,38 @@
+//===--- AlphaTidyModule.cpp - clang-tidy ----------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "../ClangTidy.h"
+#include "../ClangTidyModule.h"
+#include "../ClangTidyModuleRegistry.h"
+#include "UnusedIncludesCheck.h"
+
+
+namespace clang {
+namespace tidy {
+namespace alpha {
+
+class AlphaModule : public ClangTidyModule {
+public:
+ void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
+
+ CheckFactories.registerCheck<UnusedIncludesCheck>("alpha-unused-includes");
+ }
+};
+
+} // namespace alpha
+
+// Register the AlphaTidyModule using this statically initialized variable.
+static ClangTidyModuleRegistry::Add<alpha::AlphaModule>
+ X("alpha-module", "Adds alpha lint checks.");
+
+// This anchor is used to force the linker to link in the generated object file
+// and thus register the AlphaModule.
+volatile int AlphaModuleAnchorSource = 0;
+
+} // namespace tidy
+} // namespace clang
diff --git a/clang-tools-extra/clang-tidy/alpha/CMakeLists.txt b/clang-tools-extra/clang-tidy/alpha/CMakeLists.txt
new file mode 100644
index 000000000000..b50576868645
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/alpha/CMakeLists.txt
@@ -0,0 +1,32 @@
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../../include-cleaner/include)
+
+set(LLVM_LINK_COMPONENTS
+ Support
+ )
+
+add_clang_library(clangTidyAlphaModule
+
+ AlphaTidyModule.cpp
+ UnusedIncludesCheck.cpp
+
+ LINK_LIBS
+ clangAnalysis
+ clangIncludeCleaner
+ clangTidy
+ clangTidyUtils
+
+ DEPENDS
+ omp_gen
+ )
+
+clang_target_link_libraries(clangTidyAlphaModule
+ PRIVATE
+ clangAnalysis
+ clangAST
+ clangASTMatchers
+ clangBasic
+ clangIncludeCleaner
+ clangLex
+ clangSerialization
+ clangTooling
+ )
diff --git a/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.cpp b/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.cpp
new file mode 100644
index 000000000000..0d6a6bf7a367
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.cpp
@@ -0,0 +1,76 @@
+//===--- UnusedIncludesCheck.cpp - clang-tidy------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "UnusedIncludesCheck.h"
+#include "clang-include-cleaner/Analysis.h"
+#include "clang-include-cleaner/Hooks.h"
+#include "clang/Basic/Diagnostic.h"
+#include "clang/Basic/LLVM.h"
+#include "clang/Basic/SourceLocation.h"
+#include "clang/Lex/Preprocessor.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace alpha {
+
+UnusedIncludesCheck::UnusedIncludesCheck(StringRef Name,
+ ClangTidyContext *Context)
+ : ClangTidyCheck(Name, Context) {}
+
+void UnusedIncludesCheck::registerPPCallbacks(const SourceManager &SM,
+ Preprocessor *PP,
+ Preprocessor *) {
+ Ctx = std::make_unique<include_cleaner::AnalysisContext>(
+ include_cleaner::Policy{}, *PP);
+ RecordedPP = std::make_unique<include_cleaner::RecordedPP>();
+ PP->addPPCallbacks(RecordedPP->record(*Ctx));
+}
+
+void UnusedIncludesCheck::registerMatchers(MatchFinder *Finder) {
+ Finder->addMatcher(
+ translationUnitDecl(forEach(decl(isExpansionInMainFile()).bind("top"))),
+ this);
+}
+
+void UnusedIncludesCheck::check(const MatchFinder::MatchResult &Result) {
+ Top.push_back(const_cast<Decl *>(Result.Nodes.getNodeAs<Decl>("top")));
+}
+
+void UnusedIncludesCheck::onEndOfTranslationUnit() {
+ llvm::DenseSet<const include_cleaner::RecordedPP::Include *> Used;
+ llvm::DenseSet<include_cleaner::Header> Seen;
+ include_cleaner::walkUsed(
+ *Ctx, Top, RecordedPP->MacroReferences,
+ [&](SourceLocation Loc, include_cleaner::Symbol Sym,
+ llvm::ArrayRef<include_cleaner::Header> Headers) {
+ for (const auto &Header : Headers) {
+ if (!Seen.insert(Header).second)
+ continue;
+ const auto& HeadersToInsert = RecordedPP->Includes.match(Header);
+ Used.insert(HeadersToInsert.begin(), HeadersToInsert.end());
+ }
+ });
+ for (const auto &I : RecordedPP->Includes.all()) {
+ if (!Used.contains(&I)) {
+ const auto &SM = Ctx->sourceManager();
+ FileID FID = SM.getFileID(I.Location);
+ diag(I.Location, "there is a high probability that include is unused")
+ << FixItHint::CreateRemoval(CharSourceRange::getCharRange(
+ SM.translateLineCol(FID, I.Line, 1),
+ SM.translateLineCol(FID, I.Line + 1, 1)));
+ }
+ }
+}
+
+UnusedIncludesCheck::~UnusedIncludesCheck() = default;
+
+} // namespace alpha
+} // namespace tidy
+} // namespace clang
diff --git a/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.h b/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.h
new file mode 100644
index 000000000000..f67c46e6cc3e
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/alpha/UnusedIncludesCheck.h
@@ -0,0 +1,42 @@
+//===--- UnusedIncludesCheck.h - clang-tidy----------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNUSED_INCLUDES_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNUSED_INCLUDES_H
+
+#include "../ClangTidyCheck.h"
+
+namespace clang {
+namespace include_cleaner {
+class AnalysisContext;
+struct RecordedPP;
+} // namespace include_cleaner
+namespace tidy {
+namespace alpha {
+
+class UnusedIncludesCheck : public ClangTidyCheck {
+public:
+ UnusedIncludesCheck(StringRef Name, ClangTidyContext *Context);
+ ~UnusedIncludesCheck();
+ void registerPPCallbacks(const SourceManager &SM, Preprocessor *,
+ Preprocessor *) override;
+ void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+ void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+ void onEndOfTranslationUnit() override;
+
+private:
+ std::unique_ptr<include_cleaner::AnalysisContext> Ctx;
+ std::unique_ptr<include_cleaner::RecordedPP> RecordedPP;
+ std::vector<Decl *> Top;
+};
+
+} // namespace misc
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNUSED_INCLUDES_H
diff --git a/clang-tools-extra/clangd/CMakeLists.txt b/clang-tools-extra/clangd/CMakeLists.txt
index de8f087a52a5..14f605b1efaf 100644
--- a/clang-tools-extra/clangd/CMakeLists.txt
+++ b/clang-tools-extra/clangd/CMakeLists.txt
@@ -2,6 +2,8 @@
include_directories(${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${CMAKE_CURRENT_BINARY_DIR})
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../include-cleaner/include)
+
add_subdirectory(support)
# Configure the Features.inc file.
@@ -153,6 +155,7 @@ clang_target_link_libraries(clangDaemon
clangDriver
clangFormat
clangFrontend
+ clangIncludeCleaner
clangIndex
clangLex
clangSema
diff --git a/clang-tools-extra/clangd/Hover.cpp b/clang-tools-extra/clangd/Hover.cpp
index 26eb2574195d..a3cbc8894f6d 100644
--- a/clang-tools-extra/clangd/Hover.cpp
+++ b/clang-tools-extra/clangd/Hover.cpp
@@ -12,9 +12,11 @@
#include "CodeCompletionStrings.h"
#include "Config.h"
#include "FindTarget.h"
+#include "IncludeCleaner.h"
#include "ParsedAST.h"
#include "Selection.h"
#include "SourceCode.h"
+#include "clang-include-cleaner/Analysis.h"
#include "index/SymbolCollector.h"
#include "support/Markup.h"
#include "clang/AST/ASTContext.h"
@@ -985,6 +987,23 @@ llvm::Optional<HoverInfo> getHover(ParsedAST &AST, Position Pos,
// FIXME: We don't have a fitting value for Kind.
HI.Definition =
URIForFile::canonicalize(Inc.Resolved, *MainFilePath).file().str();
+
+ // FIXME: share code, macros too...
+ include_cleaner::AnalysisContext Ctx(include_cleaner::Policy{},
+ AST.getPreprocessor());
+ std::vector<std::string> Provides;
+ include_cleaner::walkUsed(
+ Ctx, AST.getLocalTopLevelDecls(), /*Macros=*/{},
+ [&](SourceLocation Loc, include_cleaner::Symbol S,
+ llvm::ArrayRef<include_cleaner::Header> Headers) {
+ for (const auto &H : Headers)
+ if (match(H, Inc, AST.getIncludeStructure()))
+ Provides.push_back(S.name());
+ });
+ llvm::sort(Provides);
+ Provides.erase(std::unique(Provides.begin(), Provides.end()),
+ Provides.end());
+ HI.Documentation = "provides " + llvm::join(Provides, ", ");
HI.DefinitionLanguage = "";
return HI;
}
diff --git a/clang-tools-extra/clangd/IncludeCleaner.cpp b/clang-tools-extra/clangd/IncludeCleaner.cpp
index e5b5187e030c..3c0ba06316ac 100644
--- a/clang-tools-extra/clangd/IncludeCleaner.cpp
+++ b/clang-tools-extra/clangd/IncludeCleaner.cpp
@@ -12,6 +12,8 @@
#include "ParsedAST.h"
#include "Protocol.h"
#include "SourceCode.h"
+#include "clang-include-cleaner/Analysis.h"
+#include "clang-include-cleaner/Types.h"
#include "index/CanonicalIncludes.h"
#include "support/Logger.h"
#include "support/Trace.h"
@@ -40,181 +42,6 @@ void setIncludeCleanerAnalyzesStdlib(bool B) { AnalyzeStdlib = B; }
namespace {
-/// Crawler traverses the AST and feeds in the locations of (sometimes
-/// implicitly) used symbols into \p Result.
-class ReferencedLocationCrawler
- : public RecursiveASTVisitor<ReferencedLocationCrawler> {
-public:
- ReferencedLocationCrawler(ReferencedLocations &Result,
- const SourceManager &SM)
- : Result(Result), SM(SM) {}
-
- bool VisitDeclRefExpr(DeclRefExpr *DRE) {
- add(DRE->getDecl());
- add(DRE->getFoundDecl());
- return true;
- }
-
- bool VisitMemberExpr(MemberExpr *ME) {
- add(ME->getMemberDecl());
- add(ME->getFoundDecl().getDecl());
- return true;
- }
-
- bool VisitTagType(TagType *TT) {
- add(TT->getDecl());
- return true;
- }
-
- bool VisitFunctionDecl(FunctionDecl *FD) {
- // Function definition will require redeclarations to be included.
- if (FD->isThisDeclarationADefinition())
- add(FD);
- return true;
- }
-
- bool VisitCXXConstructExpr(CXXConstructExpr *CCE) {
- add(CCE->getConstructor());
- return true;
- }
-
- bool VisitTemplateSpecializationType(TemplateSpecializationType *TST) {
- // Using templateName case is handled by the override TraverseTemplateName.
- if (TST->getTemplateName().getKind() == TemplateName::UsingTemplate)
- return true;
- add(TST->getAsCXXRecordDecl()); // Specialization
- return true;
- }
-
- // There is no VisitTemplateName in RAV, thus we override the Traverse version
- // to handle the Using TemplateName case.
- bool TraverseTemplateName(TemplateName TN) {
- VisitTemplateName(TN);
- return Base::TraverseTemplateName(TN);
- }
- // A pseudo VisitTemplateName, dispatched by the above TraverseTemplateName!
- bool VisitTemplateName(TemplateName TN) {
- if (const auto *USD = TN.getAsUsingShadowDecl()) {
- add(USD);
- return true;
- }
- add(TN.getAsTemplateDecl()); // Primary template.
- return true;
- }
-
- bool VisitUsingType(UsingType *UT) {
- add(UT->getFoundDecl());
- return true;
- }
-
- bool VisitTypedefType(TypedefType *TT) {
- add(TT->getDecl());
- return true;
- }
-
- // Consider types of any subexpression used, even if the type is not named.
- // This is helpful in getFoo().bar(), where Foo must be complete.
- // FIXME(kirillbobyrev): Should we tweak this? It may not be desirable to
- // consider types "used" when they are not directly spelled in code.
- bool VisitExpr(Expr *E) {
- TraverseType(E->getType());
- return true;
- }
-
- bool TraverseType(QualType T) {
- if (isNew(T.getTypePtrOrNull())) // don't care about quals
- Base::TraverseType(T);
- return true;
- }
-
- bool VisitUsingDecl(UsingDecl *D) {
- for (const auto *Shadow : D->shadows())
- add(Shadow->getTargetDecl());
- return true;
- }
-
- // Enums may be usefully forward-declared as *complete* types by specifying
- // an underlying type. In this case, the definition should see the declaration
- // so they can be checked for compatibility.
- bool VisitEnumDecl(EnumDecl *D) {
- if (D->isThisDeclarationADefinition() && D->getIntegerTypeSourceInfo())
- add(D);
- return true;
- }
-
- // When the overload is not resolved yet, mark all candidates as used.
- bool VisitOverloadExpr(OverloadExpr *E) {
- for (const auto *ResolutionDecl : E->decls())
- add(ResolutionDecl);
- return true;
- }
-
-private:
- using Base = RecursiveASTVisitor<ReferencedLocationCrawler>;
-
- void add(const Decl *D) {
- if (!D || !isNew(D->getCanonicalDecl()))
- return;
- if (auto SS = StdRecognizer(D)) {
- Result.Stdlib.insert(*SS);
- return;
- }
- // Special case RecordDecls, as it is common for them to be forward
- // declared multiple times. The most common cases are:
- // - Definition available in TU, only mark that one as usage. The rest is
- // likely to be unnecessary. This might result in false positives when an
- // internal definition is visible.
- // - There's a forward declaration in the main file, no need for other
- // redecls.
- if (const auto *RD = llvm::dyn_cast<RecordDecl>(D)) {
- if (const auto *Definition = RD->getDefinition()) {
- Result.User.insert(Definition->getLocation());
- return;
- }
- if (SM.isInMainFile(RD->getMostRecentDecl()->getLocation()))
- return;
- }
- for (const Decl *Redecl : D->redecls())
- Result.User.insert(Redecl->getLocation());
- }
-
- bool isNew(const void *P) { return P && Visited.insert(P).second; }
-
- ReferencedLocations &Result;
- llvm::DenseSet<const void *> Visited;
- const SourceManager &SM;
- tooling::stdlib::Recognizer StdRecognizer;
-};
-
-// Given a set of referenced FileIDs, determines all the potentially-referenced
-// files and macros by traversing expansion/spelling locations of macro IDs.
-// This is used to map the referenced SourceLocations onto real files.
-struct ReferencedFilesBuilder {
- ReferencedFilesBuilder(const SourceManager &SM) : SM(SM) {}
- llvm::DenseSet<FileID> Files;
- llvm::DenseSet<FileID> Macros;
- const SourceManager &SM;
-
- void add(SourceLocation Loc) { add(SM.getFileID(Loc), Loc); }
-
- void add(FileID FID, SourceLocation Loc) {
- if (FID.isInvalid())
- return;
- assert(SM.isInFileID(Loc, FID));
- if (Loc.isFileID()) {
- Files.insert(FID);
- return;
- }
- // Don't process the same macro FID twice.
- if (!Macros.insert(FID).second)
- return;
- const auto &Exp = SM.getSLocEntry(FID).getExpansion();
- add(Exp.getSpellingLoc());
- add(Exp.getExpansionLocStart());
- add(Exp.getExpansionLocEnd());
- }
-};
-
// Returns the range starting at '#' and ending at EOL. Escaped newlines are not
// handled.
clangd::Range getDiagnosticRange(llvm::StringRef Code, unsigned HashOffset) {
@@ -231,10 +58,10 @@ clangd::Range getDiagnosticRange(llvm::StringRef Code, unsigned HashOffset) {
// Finds locations of macros referenced from within the main file. That includes
// references that were not yet expanded, e.g `BAR` in `#define FOO BAR`.
-void findReferencedMacros(const SourceManager &SM, Preprocessor &PP,
- const syntax::TokenBuffer *Tokens,
- ReferencedLocations &Result) {
+std::vector<include_cleaner::SymbolReference>
+findReferencedMacros(ParsedAST &AST, include_cleaner::AnalysisContext &Ctx) {
trace::Span Tracer("IncludeCleaner::findReferencedMacros");
+ std::vector<include_cleaner::SymbolReference> Result;
// FIXME(kirillbobyrev): The macros from the main file are collected in
// ParsedAST's MainFileMacros. However, we can't use it here because it
// doesn't handle macro references that were not expanded, e.g. in macro
@@ -244,15 +71,19 @@ void findReferencedMacros(const SourceManager &SM, Preprocessor &PP,
// this mechanism (as opposed to iterating through all tokens) will improve
// the performance of findReferencedMacros and also improve other features
// relying on MainFileMacros.
- for (const syntax::Token &Tok : Tokens->spelledTokens(SM.getMainFileID())) {
- auto Macro = locateMacroAt(Tok, PP);
+ for (const syntax::Token &Tok :
+ AST.getTokens().spelledTokens(AST.getSourceManager().getMainFileID())) {
+ auto Macro = locateMacroAt(Tok, AST.getPreprocessor());
if (!Macro)
continue;
auto Loc = Macro->Info->getDefinitionLoc();
if (Loc.isValid())
- Result.User.insert(Loc);
- // FIXME: support stdlib macros
+ Result.push_back(include_cleaner::SymbolReference{
+ Tok.location(),
+ Ctx.macro(AST.getPreprocessor().getIdentifierInfo(Macro->Name),
+ Loc)});
}
+ return Result;
}
static bool mayConsiderUnused(const Inclusion &Inc, ParsedAST &AST,
@@ -296,110 +127,8 @@ static bool mayConsiderUnused(const Inclusion &Inc, ParsedAST &AST,
}
return true;
}
-
-// In case symbols are coming from non self-contained header, we need to find
-// its first includer that is self-contained. This is the header users can
-// include, so it will be responsible for bringing the symbols from given
-// header into the scope.
-FileID headerResponsible(FileID ID, const SourceManager &SM,
- const IncludeStructure &Includes) {
- // Unroll the chain of non self-contained headers until we find the one that
- // can be included.
- for (const FileEntry *FE = SM.getFileEntryForID(ID); ID != SM.getMainFileID();
- FE = SM.getFileEntryForID(ID)) {
- // If FE is nullptr, we consider it to be the responsible header.
- if (!FE)
- break;
- auto HID = Includes.getID(FE);
- assert(HID && "We're iterating over headers already existing in "
- "IncludeStructure");
- if (Includes.isSelfContained(*HID))
- break;
- // The header is not self-contained: put the responsibility for its symbols
- // on its includer.
- ID = SM.getFileID(SM.getIncludeLoc(ID));
- }
- return ID;
-}
-
} // namespace
-ReferencedLocations findReferencedLocations(ASTContext &Ctx, Preprocessor &PP,
- const syntax::TokenBuffer *Tokens) {
- trace::Span Tracer("IncludeCleaner::findReferencedLocations");
- ReferencedLocations Result;
- const auto &SM = Ctx.getSourceManager();
- ReferencedLocationCrawler Crawler(Result, SM);
- Crawler.TraverseAST(Ctx);
- if (Tokens)
- findReferencedMacros(SM, PP, Tokens, Result);
- return Result;
-}
-
-ReferencedLocations findReferencedLocations(ParsedAST &AST) {
- return findReferencedLocations(AST.getASTContext(), AST.getPreprocessor(),
- &AST.getTokens());
-}
-
-ReferencedFiles findReferencedFiles(
- const ReferencedLocations &Locs, const SourceManager &SM,
- llvm::function_ref<FileID(FileID)> HeaderResponsible,
- llvm::function_ref<Optional<StringRef>(FileID)> UmbrellaHeader) {
- std::vector<SourceLocation> Sorted{Locs.User.begin(), Locs.User.end()};
- llvm::sort(Sorted); // Group by FileID.
- ReferencedFilesBuilder Builder(SM);
- for (auto It = Sorted.begin(); It < Sorted.end();) {
- FileID FID = SM.getFileID(*It);
- Builder.add(FID, *It);
- // Cheaply skip over all the other locations from the same FileID.
- // This avoids lots of redundant Loc->File lookups for the same file.
- do
- ++It;
- while (It != Sorted.end() && SM.isInFileID(*It, FID));
- }
-
- // If a header is not self-contained, we consider its symbols a logical part
- // of the including file. Therefore, mark the parents of all used
- // non-self-contained FileIDs as used. Perform this on FileIDs rather than
- // HeaderIDs, as each inclusion of a non-self-contained file is distinct.
- llvm::DenseSet<FileID> UserFiles;
- llvm::StringSet<> PublicHeaders;
- for (FileID ID : Builder.Files) {
- UserFiles.insert(HeaderResponsible(ID));
- if (auto PublicHeader = UmbrellaHeader(ID)) {
- PublicHeaders.insert(*PublicHeader);
- }
- }
-
- llvm::DenseSet<tooling::stdlib::Header> StdlibFiles;
- for (const auto &Symbol : Locs.Stdlib)
- for (const auto &Header : Symbol.headers())
- StdlibFiles.insert(Header);
-
- return {std::move(UserFiles), std::move(StdlibFiles),
- std::move(PublicHeaders)};
-}
-
-ReferencedFiles findReferencedFiles(const ReferencedLocations &Locs,
- const IncludeStructure &Includes,
- const CanonicalIncludes &CanonIncludes,
- const SourceManager &SM) {
- return findReferencedFiles(
- Locs, SM,
- [&SM, &Includes](FileID ID) {
- return headerResponsible(ID, SM, Includes);
- },
- [&SM, &CanonIncludes](FileID ID) -> Optional<StringRef> {
- auto Entry = SM.getFileEntryRefForID(ID);
- if (!Entry)
- return llvm::None;
- auto PublicHeader = CanonIncludes.mapHeader(*Entry);
- if (PublicHeader.empty())
- return llvm::None;
- return PublicHeader;
- });
-}
-
std::vector<const Inclusion *>
getUnused(ParsedAST &AST,
const llvm::DenseSet<IncludeStructure::HeaderID> &ReferencedFiles,
@@ -426,51 +155,50 @@ getUnused(ParsedAST &AST,
return Unused;
}
-#ifndef NDEBUG
-// Is FID a <built-in>, <scratch space> etc?
-static bool isSpecialBuffer(FileID FID, const SourceManager &SM) {
- const SrcMgr::FileInfo &FI = SM.getSLocEntry(FID).getFile();
- return FI.getName().startswith("<");
-}
-#endif
-
-llvm::DenseSet<IncludeStructure::HeaderID>
-translateToHeaderIDs(const ReferencedFiles &Files,
- const IncludeStructure &Includes,
- const SourceManager &SM) {
- trace::Span Tracer("IncludeCleaner::translateToHeaderIDs");
- llvm::DenseSet<IncludeStructure::HeaderID> TranslatedHeaderIDs;
- TranslatedHeaderIDs.reserve(Files.User.size());
- for (FileID FID : Files.User) {
- const FileEntry *FE = SM.getFileEntryForID(FID);
- if (!FE) {
- assert(isSpecialBuffer(FID, SM));
- continue;
- }
- const auto File = Includes.getID(FE);
- assert(File);
- TranslatedHeaderIDs.insert(*File);
- }
- for (tooling::stdlib::Header StdlibUsed : Files.Stdlib)
- for (auto HID : Includes.StdlibHeaders.lookup(StdlibUsed))
- TranslatedHeaderIDs.insert(HID);
- return TranslatedHeaderIDs;
+bool match(const include_cleaner::Header &H, const Inclusion &I,
+ const IncludeStructure &S) {
+ switch (H.kind()) {
+ case include_cleaner::Header::Physical:
+ if (auto HID = S.getID(H.getPhysical()))
+ if (static_cast<unsigned>(*HID) == I.HeaderID)
+ return true;
+ break;
+ case include_cleaner::Header::StandardLibrary:
+ return I.Written == H.getStandardLibrary().name();
+ case include_cleaner::Header::Verbatim:
+ return llvm::StringRef(I.Written).trim("\"<>") == H.getVerbatimSpelling();
+ case include_cleaner::Header::Builtin:
+ case include_cleaner::Header::MainFile:
+ break;
+ }
+ return false;
}
std::vector<const Inclusion *> computeUnusedIncludes(ParsedAST &AST) {
- const auto &SM = AST.getSourceManager();
-
- auto Refs = findReferencedLocations(AST);
- auto ReferencedFiles =
- findReferencedFiles(Refs, AST.getIncludeStructure(),
- AST.getCanonicalIncludes(), AST.getSourceManager());
- auto ReferencedHeaders =
- translateToHeaderIDs(ReferencedFiles, AST.getIncludeStructure(), SM);
- return getUnused(AST, ReferencedHeaders, ReferencedFiles.SpelledUmbrellas);
+ include_cleaner::AnalysisContext Ctx(include_cleaner::Policy{},
+ AST.getPreprocessor());
+ llvm::DenseSet<const Inclusion *> Used;
+ include_cleaner::walkUsed(
+ Ctx, AST.getLocalTopLevelDecls(),
+ /*MacroRefs=*/findReferencedMacros(AST, Ctx),
+ [&](SourceLocation Loc, include_cleaner::Symbol Sym,
+ llvm::ArrayRef<include_cleaner::Header> Headers) {
+ for (const auto &I : AST.getIncludeStructure().MainFileIncludes)
+ for (const auto &H : Headers)
+ if (match(H, I, AST.getIncludeStructure()))
+ Used.insert(&I);
+ });
+ std::vector<const Inclusion *> Unused;
+ const Config &Cfg = Config::current();
+ for (const auto &I : AST.getIncludeStructure().MainFileIncludes) {
+ if (!Used.contains(&I) && mayConsiderUnused(I, AST, Cfg))
+ Unused.push_back(&I);
+ }
+ return Unused;
}
-std::vector<Diag> issueUnusedIncludesDiagnostics(ParsedAST &AST,
- llvm::StringRef Code) {
+auto issueUnusedIncludesDiagnostics(ParsedAST &AST,
+ llvm::StringRef Code) -> std::vector<Diag> {
const Config &Cfg = Config::current();
if (Cfg.Diagnostics.UnusedIncludes != Config::UnusedIncludesPolicy::Strict ||
Cfg.Diagnostics.SuppressAll ||
diff --git a/clang-tools-extra/clangd/IncludeCleaner.h b/clang-tools-extra/clangd/IncludeCleaner.h
index 4ce31baaa067..c858a60c5db7 100644
--- a/clang-tools-extra/clangd/IncludeCleaner.h
+++ b/clang-tools-extra/clangd/IncludeCleaner.h
@@ -23,6 +23,7 @@
#include "index/CanonicalIncludes.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Tooling/Inclusions/StandardLibrary.h"
+#include "clang-include-cleaner/Types.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/ADT/StringSet.h"
@@ -100,6 +101,10 @@ std::vector<const Inclusion *> computeUnusedIncludes(ParsedAST &AST);
std::vector<Diag> issueUnusedIncludesDiagnostics(ParsedAST &AST,
llvm::StringRef Code);
+// Does an include-cleaner header spec match a clangd recorded inclusion?
+bool match(const include_cleaner::Header &H, const Inclusion &I,
+ const IncludeStructure &S);
+
/// Affects whether standard library includes should be considered for
/// removal. This is off by default for now due to implementation limitations:
/// - macros are not tracked
diff --git a/clang-tools-extra/include-cleaner/CMakeLists.txt b/clang-tools-extra/include-cleaner/CMakeLists.txt
index 0550b02f603b..325186879a47 100644
--- a/clang-tools-extra/include-cleaner/CMakeLists.txt
+++ b/clang-tools-extra/include-cleaner/CMakeLists.txt
@@ -1,4 +1,8 @@
+include_directories(include)
+include_directories(${CMAKE_CURRENT_BINARY_DIR}/include)
add_subdirectory(lib)
+add_subdirectory(tool)
+
if(CLANG_INCLUDE_TESTS)
add_subdirectory(test)
add_subdirectory(unittests)
diff --git a/clang-tools-extra/include-cleaner/README.md b/clang-tools-extra/include-cleaner/README.md
deleted file mode 100644
index e69de29bb2d1..000000000000
diff --git a/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Analysis.h b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Analysis.h
new file mode 100644
index 000000000000..4e5cc8d03814
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Analysis.h
@@ -0,0 +1,77 @@
+//===--- Analysis.h - Analyze used files --------------------------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef CLANG_INCLUDE_CLEANER_ANALYSIS_H
+#define CLANG_INCLUDE_CLEANER_ANALYSIS_H
+
+#include "clang-include-cleaner/Policy.h"
+#include "clang-include-cleaner/Types.h"
+
+namespace clang {
+namespace include_cleaner {
+class Cache;
+
+// Bundles the policy, compiler state, and caches for one include-cleaner run.
+// (This is needed everywhere, but shouldn't be used to propagate state around!)
+class AnalysisContext {
+public:
+ AnalysisContext(const Policy &, const Preprocessor &);
+ AnalysisContext(AnalysisContext &&) = delete;
+ AnalysisContext &operator=(AnalysisContext &&) = delete;
+ ~AnalysisContext();
+
+ const Policy &policy() const { return P; }
+
+ const SourceManager &sourceManager() const { return *SM; }
+ const Preprocessor &preprocessor() const { return *PP; }
+
+ // Only for internal use (the Cache class definition is not exposed).
+ // This allows us to reuse e.g. mappings from symbols to their locations.
+ Cache &cache() { return *C; }
+ // FIXME: does this need to be public?
+ Symbol macro(const IdentifierInfo *, SourceLocation);
+
+private:
+ Policy P;
+ const SourceManager *SM;
+ const Preprocessor *PP;
+ std::unique_ptr<Cache> C;
+};
+
+// A UsedSymbolVisitor is a callback invoked for each symbol reference seen.
+//
+// References occur at a particular location, refer to a single symbol, and
+// that symbol may be provided by any of several headers.
+//
+// The first element of ProvidedBy is the *preferred* header, e.g. to insert.
+using UsedSymbolVisitor =
+ llvm::function_ref<void(SourceLocation UsedAt, Symbol UsedSymbol,
+ llvm::ArrayRef<Header> ProvidedBy)>;
+
+// Find and report all references to symbols in a region of code.
+//
+// The AST traversal is rooted at ASTRoots - typically top-level declarations
+// of a single source file. MacroRefs are additional recorded references to
+// macros, which do not appear in the AST.
+//
+// This is the main entrypoint of the include-cleaner library, and can be used:
+// - to diagnose missing includes: a referenced symbol is provided by
+// headers which don't match any #include in the main file
+// - to diagnose unused includes: an #include in the main file does not match
+// the headers for any referenced symbol
+//
+// Mapping between Header and #include directives is not provided here, but see
+// RecordedPP::Includes::match() in Hooks.h.
+void walkUsed(AnalysisContext &, llvm::ArrayRef<Decl *> ASTRoots,
+ llvm::ArrayRef<SymbolReference> MacroRefs,
+ UsedSymbolVisitor Callback);
+
+} // namespace include_cleaner
+} // namespace clang
+
+#endif
diff --git a/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Hooks.h b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Hooks.h
new file mode 100644
index 000000000000..39e11653b210
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Hooks.h
@@ -0,0 +1,87 @@
+//===--- Hooks.h - Record compiler events -------------------------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Where Analysis.h analyzes AST nodes and recorded preprocessor events, this
+// file defines ways to capture AST and preprocessor information from a parse.
+//
+// These are the simplest way to connect include-cleaner logic to the parser,
+// but other ways are possible (for example clangd records includes separately).
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef CLANG_INCLUDE_CLEANER_HOOKS_H
+#define CLANG_INCLUDE_CLEANER_HOOKS_H
+
+#include "Analysis.h"
+#include "Types.h"
+#include "clang/Basic/FileEntry.h"
+#include "clang/Basic/SourceLocation.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/StringMap.h"
+#include "llvm/ADT/StringRef.h"
+#include <vector>
+
+namespace clang {
+class FileEntry;
+class PPCallbacks;
+namespace include_cleaner {
+class PPRecorder;
+
+// Contains recorded preprocessor events relevant to include-cleaner.
+struct RecordedPP {
+ // The callback (when installed into clang) tracks macros/includes in this.
+ std::unique_ptr<PPCallbacks> record(AnalysisContext &Ctx);
+ // FIXME: probably also want a comment handler to capture IWYU pragmas.
+
+ // Describes where macros were used from the main file.
+ std::vector<SymbolReference> MacroReferences;
+
+ // A single #include directive from the main file.
+ struct Include {
+ llvm::StringRef Spelled; // e.g. vector
+ const FileEntry *Resolved; // e.g. /path/to/c++/v1/vector
+ SourceLocation Location; // of hash in #include <vector>
+ unsigned Line; // 1-based line number for #include
+ };
+ // The set of includes recorded from the main file.
+ class RecordedIncludes {
+ public:
+ // All #includes seen, in the order they appear.
+ llvm::ArrayRef<Include> all() const { return All; }
+ // Determine #includes that match a header (that provides a used symbol).
+ //
+ // Matching is based on the type of Header specified:
+ // - for a physical file like /path/to/foo.h, we check Resolved
+ // - for a logical file like <vector>, we check Spelled
+ llvm::SmallVector<const Include *> match(Header H) const;
+
+ private:
+ std::vector<Include> All;
+ llvm::StringMap<llvm::SmallVector<unsigned>> BySpelling;
+ llvm::DenseMap<const FileEntry *, llvm::SmallVector<unsigned>> ByFile;
+ friend PPRecorder;
+ } Includes;
+};
+
+// Contains recorded parser events relevant to include-cleaner.
+struct RecordedAST {
+ // The consumer (when installed into clang) tracks declarations in this.
+ std::unique_ptr<ASTConsumer> record(AnalysisContext &Ctx);
+
+ // The set of declarations written at file scope inside the main file.
+ //
+ // These are the roots of the subtrees that should be traversed to find uses.
+ // (Traversing the TranslationUnitDecl would find uses inside headers!)
+ std::vector<Decl *> TopLevelDecls;
+};
+
+} // namespace include_cleaner
+} // namespace clang
+
+#endif
diff --git a/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Policy.h b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Policy.h
new file mode 100644
index 000000000000..142887b85529
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Policy.h
@@ -0,0 +1,35 @@
+//===--- Policy.h - Tuning what is considered used ----------------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef CLANG_INCLUDE_CLEANER_POLICY_H
+#define CLANG_INCLUDE_CLEANER_POLICY_H
+
+namespace clang {
+namespace include_cleaner {
+
+// Provides some fine-tuning of include-cleaner's choices about what is used.
+//
+// Changing the policy serves two purposes:
+// - marking more things used reduces the false-positives for "unused include",
+// while marking fewer things improves "missing include" in the same way.
+// - different coding styles may make different decisions about which includes
+// are required.
+struct Policy {
+ // Does construction count as use of the type, when the type is not named?
+ // e.g. printVector({x, y, z}); - is std::vector used?
+ bool Construction = false;
+ // Is member access tracked as a reference?
+ bool Members = false;
+ // Are operator calls tracked as references?
+ bool Operators = false;
+};
+
+} // namespace include_cleaner
+} // namespace clang
+
+#endif
diff --git a/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
new file mode 100644
index 000000000000..2a91473b926e
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
@@ -0,0 +1,219 @@
+//===--- Types.h - Data structures for used-symbol analysis -------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Find referenced files is mostly a matter of translating:
+// AST Node => declaration => source location => file
+//
+// clang has types for these (DynTypedNode, Decl, SourceLocation, FileID), but
+// there are special cases: macros are not declarations, the concrete file where
+// a standard library symbol was defined doesn't matter, etc.
+//
+// We define some slightly more abstract sum types to handle these cases while
+// keeping the API clean. For example, Symbol is Decl+DefinedMacro.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef CLANG_INCLUDE_CLEANER_TYPES_H
+#define CLANG_INCLUDE_CLEANER_TYPES_H
+
+#include "clang/AST/DeclBase.h"
+#include "clang/Tooling/Inclusions/StandardLibrary.h"
+#include "llvm/ADT/BitmaskEnum.h"
+#include "llvm/ADT/PointerSumType.h"
+
+namespace clang {
+class IdentifierInfo;
+class MacroDirective;
+namespace include_cleaner {
+
+// Identifies a macro, along with a particular definition of it.
+// We generally consider redefined macros to be different symbols.
+struct DefinedMacro {
+ const IdentifierInfo *Name;
+ const SourceLocation Definition;
+};
+
+// A Symbol is an entity that can be referenced.
+// It is either a declaration (NamedDecl) or a macro (DefinedMacro).
+class Symbol {
+public:
+ enum Kind {
+ Macro,
+ Declaration,
+ };
+ Symbol(NamedDecl *ND) : Target(ND) {}
+ Symbol(const DefinedMacro *M) : Target(M) {}
+
+ std::string name() const;
+ std::string nodeName() const;
+ Kind kind() const { return Target.is<NamedDecl *>() ? Declaration : Macro; }
+
+ NamedDecl *getDeclaration() const { return Target.get<NamedDecl *>(); }
+ const DefinedMacro *getMacro() const {
+ return Target.get<const DefinedMacro *>();
+ }
+
+private:
+ llvm::PointerUnion<const DefinedMacro *, NamedDecl *> Target;
+};
+
+// A usage of a Symbol seen in our source code.
+struct SymbolReference {
+ // The point in the code where the reference occurred.
+ // We could track the DynTypedNode we found it in if it's important.
+ SourceLocation Location;
+ Symbol Target;
+};
+
+// A Location is a place where a symbol can be provided.
+// It is either a physical part of the TU (SourceLocation) or a logical location
+// in the standard library (stdlib::Symbol).
+class Location {
+public:
+ enum Kind : uint8_t {
+ Physical,
+ StandardLibrary,
+ };
+
+ Location(SourceLocation S) : K(Physical), SrcLoc(S) {}
+ Location(tooling::stdlib::Symbol S) : K(StandardLibrary), StdlibSym(S) {}
+
+ std::string name(const SourceManager &SM) const;
+ Kind kind() const { return K; }
+
+ SourceLocation getPhysical() const {
+ assert(kind() == Physical);
+ return SrcLoc;
+ };
+ tooling::stdlib::Symbol getStandardLibrary() const {
+ assert(kind() == StandardLibrary);
+ return StdlibSym;
+ };
+
+private:
+ Kind K;
+ union {
+ SourceLocation SrcLoc;
+ tooling::stdlib::Symbol StdlibSym;
+ };
+};
+
+// A Header is an includable file that can provide access to Locations.
+// It is either a physical file (FileEntry), a logical location in the standard
+// library (stdlib::Header), or a verbatim header spelling (StringRef).
+class Header {
+public:
+ enum Kind : uint8_t {
+ Physical,
+ StandardLibrary,
+ Verbatim,
+ Builtin,
+ MainFile,
+ };
+
+ Header(const FileEntry *FE) : K(Physical), PhysicalFile(FE) {}
+ Header(tooling::stdlib::Header H) : K(StandardLibrary), StdlibHeader(H) {}
+ Header(const char *V) : K(Verbatim), VerbatimSpelling(V) {}
+ static Header builtin() { return Header{Builtin}; };
+ static Header mainFile() { return Header{MainFile}; };
+
+ std::string name() const;
+ Kind kind() const { return K; }
+
+ const FileEntry *getPhysical() const {
+ assert(kind() == Physical);
+ return PhysicalFile;
+ };
+ tooling::stdlib::Header getStandardLibrary() const {
+ assert(kind() == StandardLibrary);
+ return StdlibHeader;
+ };
+ llvm::StringRef getVerbatimSpelling() const {
+ assert(kind() == Verbatim);
+ return VerbatimSpelling;
+ };
+
+private:
+ Header(Kind K) : K(K) {}
+
+ Kind K;
+ union {
+ const FileEntry *PhysicalFile;
+ tooling::stdlib::Header StdlibHeader;
+ const char *VerbatimSpelling;
+ };
+
+ friend bool operator==(const Header &L, const Header &R) {
+ if (L.kind() != R.kind())
+ return false;
+ switch (L.kind()) {
+ case Physical:
+ return L.getPhysical() == R.getPhysical();
+ case StandardLibrary:
+ return L.getStandardLibrary() == R.getStandardLibrary();
+ case Verbatim:
+ return L.getVerbatimSpelling() == R.getVerbatimSpelling();
+ case Builtin:
+ case MainFile:
+ return true; // no payload
+ }
+ llvm_unreachable("unhandled Header kind");
+ }
+
+ friend bool operator<(const Header &L, const Header &R) {
+ if (L.kind() != R.kind())
+ return L.kind() < R.kind();
+ switch (L.kind()) {
+ case Physical:
+ return L.getPhysical() == R.getPhysical();
+ case StandardLibrary:
+ return L.getStandardLibrary() < R.getStandardLibrary();
+ case Verbatim:
+ return L.getVerbatimSpelling() < R.getVerbatimSpelling();
+ case Builtin:
+ case MainFile:
+ return false; // no payload
+ }
+ llvm_unreachable("unhandled Header kind");
+ }
+
+ friend llvm::hash_code hash_value(const Header &H) {
+ switch (H.K) {
+ case Header::Physical:
+ return llvm::hash_combine(H.K, H.getPhysical());
+ case Header::StandardLibrary:
+ // FIXME: make StdlibHeader hashable instead.
+ return llvm::hash_combine(H.K, H.getStandardLibrary().name());
+ case Header::Verbatim:
+ return llvm::hash_combine(H.K, llvm::StringRef(H.VerbatimSpelling));
+ case Header::Builtin:
+ case Header::MainFile:
+ return llvm::hash_value(H.K);
+ }
+ }
+};
+
+template <typename T> struct DefaultDenseMapInfo {
+ static T isEqual(const T &L, const T &R) { return L == R; }
+ static unsigned getHashValue(const T &V) { return hash_value(V); }
+};
+
+} // namespace include_cleaner
+} // namespace clang
+
+namespace llvm {
+template <> struct DenseMapInfo<clang::include_cleaner::Header> {
+ using Header = clang::include_cleaner::Header;
+ static Header getTombstoneKey() { return Header("__tombstone__"); }
+ static Header getEmptyKey() { return Header("__empty__"); }
+ static bool isEqual(const Header &L, const Header &R) { return L == R; }
+ static unsigned getHashValue(const Header &V) { return hash_value(V); }
+};
+} // namespace llvm
+
+#endif
diff --git a/clang-tools-extra/include-cleaner/lib/Analysis.cpp b/clang-tools-extra/include-cleaner/lib/Analysis.cpp
new file mode 100644
index 000000000000..5ac0008b07e8
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/lib/Analysis.cpp
@@ -0,0 +1,101 @@
+//===--- Analysis.cpp - Analyze used files --------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "clang-include-cleaner/Analysis.h"
+#include "AnalysisInternal.h"
+#include "clang/Lex/Preprocessor.h"
+
+namespace clang {
+namespace include_cleaner {
+
+AnalysisContext::AnalysisContext(const Policy &P, const Preprocessor &PP)
+ : P(P), SM(&PP.getSourceManager()), PP(&PP), C(std::make_unique<Cache>()) {}
+AnalysisContext::~AnalysisContext() = default;
+
+static bool prefer(AnalysisContext &Ctx, Hint L, Hint R) {
+ return std::make_tuple(bool(L & Hint::NameMatch), bool(L & Hint::Complete)) >
+ std::make_tuple(bool(R & Hint::NameMatch), bool(R & Hint::Complete));
+}
+
+// Is this hint actually useful?
+static void addNameMatchHint(const IdentifierInfo *II,
+ llvm::SmallVector<Hinted<Header>> &H) {
+ if (!II)
+ return;
+ for (auto &HH : H)
+ if (HH->kind() == Header::Physical &&
+ II->getName().equals_insensitive(HH->getPhysical()->getName()))
+ HH.Hint |= Hint::NameMatch;
+}
+
+static llvm::SmallVector<Header>
+rank(AnalysisContext &Ctx, llvm::SmallVector<Hinted<Header>> &Candidates) {
+ // Sort by Header, so we can deduplicate (and combine flags).
+ llvm::stable_sort(Candidates,
+ [&](const Hinted<Header> &L, const Hinted<Header> &R) {
+ return *L < *R;
+ });
+ // Like unique(), but merge hints.
+ auto *Write = Candidates.begin();
+ for (auto *Read = Candidates.begin(); Read != Candidates.end(); ++Write) {
+ *Write = *Read;
+ for (++Read; Read != Candidates.end() && Read->Value == Write->Value;
+ ++Read)
+ Write->Hint |= Read->Hint;
+ }
+ Candidates.erase(Write, Candidates.end());
+ // Now sort by hints.
+ llvm::stable_sort(Candidates,
+ [&](const Hinted<Header> &L, const Hinted<Header> &R) {
+ return prefer(Ctx, L.Hint, R.Hint);
+ });
+ // Drop hints to return clean result list.
+ llvm::SmallVector<Header> Result;
+ for (const auto &H : Candidates)
+ Result.push_back(*H);
+ return Result;
+}
+
+template <typename T> void addHint(Hint H, T &Items) {
+ for (auto &Item : Items)
+ Item.Hint |= H;
+}
+
+void walkUsed(AnalysisContext &Ctx, llvm::ArrayRef<Decl *> ASTRoots,
+ llvm::ArrayRef<SymbolReference> MacroRefs,
+ UsedSymbolVisitor Callback) {
+ for (Decl *Root : ASTRoots) {
+ walkAST(Ctx, *Root, [&](SourceLocation RefLoc, Hinted<NamedDecl &> ND) {
+ auto Locations = locateDecl(Ctx, *ND);
+ llvm::SmallVector<Hinted<Header>> Headers;
+ for (const auto &Loc : Locations) {
+ auto LocHeaders = includableHeader(Ctx, *Loc);
+ addHint(Loc.Hint, LocHeaders);
+ Headers.append(std::move(LocHeaders));
+ }
+ addHint(ND.Hint, Headers);
+ addNameMatchHint(ND.Value.getDeclName().getAsIdentifierInfo(), Headers);
+ Callback(RefLoc, &ND.Value, rank(Ctx, Headers));
+ });
+ }
+ for (const SymbolReference &MacroRef : MacroRefs) {
+ assert(MacroRef.Target.kind() == Symbol::Macro);
+ auto Loc = locateMacro(Ctx, *MacroRef.Target.getMacro());
+ auto Headers = includableHeader(Ctx, *Loc);
+ addHint(Loc.Hint, Headers);
+ addNameMatchHint(MacroRef.Target.getMacro()->Name, Headers);
+ Callback(MacroRef.Location, MacroRef.Target, rank(Ctx, Headers));
+ }
+}
+
+Symbol AnalysisContext::macro(const IdentifierInfo *II, SourceLocation Loc) {
+ return cache().macro(II, Loc);
+}
+
+} // namespace include_cleaner
+} // namespace clang
diff --git a/clang-tools-extra/include-cleaner/lib/AnalysisInternal.h b/clang-tools-extra/include-cleaner/lib/AnalysisInternal.h
index 8b0c73fe7997..31b1ad8039d8 100644
--- a/clang-tools-extra/include-cleaner/lib/AnalysisInternal.h
+++ b/clang-tools-extra/include-cleaner/lib/AnalysisInternal.h
@@ -21,6 +21,95 @@
#ifndef CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
#define CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
+#include "clang-include-cleaner/Analysis.h"
+#include "clang-include-cleaner/Types.h"
+#include "clang/Tooling/Inclusions/StandardLibrary.h"
+
+namespace clang {
+namespace include_cleaner {
+
+// FIXME: Right now we cache nothing, this is just used as an arena for macros.
+// Verify we're burning time in repeated analysis and cache partial operations.
+class Cache {
+public:
+ Symbol macro(const IdentifierInfo *Name, const SourceLocation Def) {
+ auto &DMS = DefinedMacros[Name->getName()];
+ // Linear search. We probably only saw ~1 definition of each macro name.
+ for (const DefinedMacro &DM : DMS)
+ if (DM.Definition == Def)
+ return &DM;
+ DMS.push_back(DefinedMacro{Name, Def});
+ return &DMS.back();
+ }
+
+ tooling::stdlib::Recognizer StdlibRecognizer;
+
+private:
+ llvm::StringMap<llvm::SmallVector<DefinedMacro>> DefinedMacros;
+};
+
+enum class Hint : uint16_t {
+ None = 0,
+ Complete = 1, // Provides a complete definition that is often needed.
+ // e.g. classes, templates.
+ NameMatch = 1, // Header name matches the symbol name.
+ LLVM_MARK_AS_BITMASK_ENUM(Hint::Complete)
+};
+LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
+
+template <typename T> struct Hinted {
+ Hinted(T Value, Hint H = Hint::None) : Value(Value), Hint(H) {}
+ T Value;
+ include_cleaner::Hint Hint;
+
+ T &operator*() { return Value; }
+ const T &operator*() const { return Value; }
+ std::remove_reference_t<T> *operator->() { return &Value; }
+ const std::remove_reference_t<T> *operator->() const { return &Value; }
+};
+
+// Traverses a subtree of the AST, reporting declarations referenced.
+void walkAST(AnalysisContext &, Decl &Root,
+ llvm::function_ref<void(SourceLocation, Hinted<NamedDecl &>)>);
+
+// Finds the locations where a declaration is provided.
+llvm::SmallVector<Hinted<Location>> locateDecl(AnalysisContext &,
+ const NamedDecl &);
+
+// Finds the locations where a macro is provided.
+Hinted<Location> locateMacro(AnalysisContext &, const DefinedMacro &);
+
+// Finds the headers that provide a location.
+llvm::SmallVector<Hinted<Header>> includableHeader(AnalysisContext &,
+ const Location &);
+
+} // namespace include_cleaner
+} // namespace clang
+
+#endif
+//===--- AnalysisInternal.h - Analysis building blocks ------------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file provides smaller, testable pieces of the used-header analysis.
+// We find the headers by chaining together several mappings.
+//
+// AST => AST node => Symbol => Location => Header
+// /
+// Macro expansion =>
+//
+// The individual steps are declared here.
+// (AST => AST Node => Symbol is one API to avoid materializing DynTypedNodes).
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
+#define CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
+
#include "clang/Basic/SourceLocation.h"
#include "llvm/ADT/STLFunctionalExtras.h"
diff --git a/clang-tools-extra/include-cleaner/lib/CMakeLists.txt b/clang-tools-extra/include-cleaner/lib/CMakeLists.txt
index 5e2807332f94..25d66b4f30df 100644
--- a/clang-tools-extra/include-cleaner/lib/CMakeLists.txt
+++ b/clang-tools-extra/include-cleaner/lib/CMakeLists.txt
@@ -1,10 +1,15 @@
set(LLVM_LINK_COMPONENTS Support)
add_clang_library(clangIncludeCleaner
+ Analysis.cpp
+ Headers.cpp
+ Hooks.cpp
+ Locations.cpp
+ Types.cpp
WalkAST.cpp
LINK_LIBS
clangBasic
+ clangLex
clangAST
)
-
diff --git a/clang-tools-extra/include-cleaner/lib/Headers.cpp b/clang-tools-extra/include-cleaner/lib/Headers.cpp
new file mode 100644
index 000000000000..f41bbe4c59c8
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/lib/Headers.cpp
@@ -0,0 +1,46 @@
+//===--- Headers.cpp - Find headers that provide locations ----------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "AnalysisInternal.h"
+#include "clang/Basic/SourceManager.h"
+#include "clang/Lex/Preprocessor.h"
+
+namespace clang {
+namespace include_cleaner {
+
+llvm::SmallVector<Hinted<Header>> includableHeader(AnalysisContext &Ctx,
+ const Location &Loc) {
+ switch (Loc.kind()) {
+ case Location::Physical: {
+ FileID FID = Ctx.sourceManager().getFileID(
+ Ctx.sourceManager().getExpansionLoc(Loc.getPhysical()));
+ if (FID == Ctx.sourceManager().getMainFileID())
+ return {Header::mainFile()};
+ if (FID == Ctx.preprocessor().getPredefinesFileID())
+ return {Header::builtin()};
+ // FIXME: if the file is not self-contained, find its umbrella header:
+ // - files that lack header guards (e.g. *.def)
+ // - IWYU private pragmas (and maybe export?)
+ // - #pragma clang include_instead
+ // - headers containing "#error ... include" clangd isDontIncludeMeHeader
+ // - apple framework header layout
+ if (auto *FE = Ctx.sourceManager().getFileEntryForID(FID))
+ return {{FE}};
+ return {};
+ }
+ case Location::StandardLibrary:
+ // FIXME: some symbols are provided by multiple stdlib headers:
+ // - for historical reasons, like size_t
+ // - some headers are guaranteed to include others (<initializer_list>)
+ // - ::printf is de facto provided by cstdio and stdio.h, etc
+ return {{Loc.getStandardLibrary().header()}};
+ }
+}
+
+} // namespace include_cleaner
+} // namespace clang
diff --git a/clang-tools-extra/include-cleaner/lib/Hooks.cpp b/clang-tools-extra/include-cleaner/lib/Hooks.cpp
new file mode 100644
index 000000000000..decb83110c65
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/lib/Hooks.cpp
@@ -0,0 +1,166 @@
+//===--- Hooks.cpp - Record events from the compiler --------------- C++-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "clang-include-cleaner/Hooks.h"
+#include "AnalysisInternal.h"
+#include "clang-include-cleaner/Analysis.h"
+#include "clang/AST/ASTConsumer.h"
+#include "clang/AST/DeclCXX.h"
+#include "clang/AST/DeclGroup.h"
+#include "clang/AST/DeclObjC.h"
+#include "clang/Lex/MacroInfo.h"
+#include "clang/Lex/PPCallbacks.h"
+#include "clang/Lex/Preprocessor.h"
+#include "clang/Lex/Token.h"
+
+namespace clang {
+namespace include_cleaner {
+
+class PPRecorder : public PPCallbacks {
+public:
+ PPRecorder(AnalysisContext &Ctx, RecordedPP &Recorded)
+ : Ctx(Ctx), Recorded(Recorded) {}
+
+ virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason,
+ SrcMgr::CharacteristicKind FileType,
+ FileID PrevFID) override {
+ Active = Ctx.sourceManager().isWrittenInMainFile(Loc);
+ }
+
+ void InclusionDirective(SourceLocation Hash, const Token &IncludeTok,
+ StringRef SpelledFilename, bool IsAngled,
+ CharSourceRange FilenameRange, Optional<FileEntryRef> File,
+ StringRef SearchPath, StringRef RelativePath,
+ const Module *, SrcMgr::CharacteristicKind) override {
+ if (!Active)
+ return;
+
+ unsigned Index = Recorded.Includes.All.size();
+ Recorded.Includes.All.emplace_back();
+ RecordedPP::Include &I = Recorded.Includes.All.back();
+ const auto *const RawFile = &(*File).getFileEntry();
+ I.Location = Hash;
+ I.Resolved = RawFile;
+ I.Line = Ctx.sourceManager().getSpellingLineNumber(Hash);
+ auto BySpellingIt =
+ Recorded.Includes.BySpelling.try_emplace(SpelledFilename).first;
+ I.Spelled = BySpellingIt->first();
+
+ BySpellingIt->second.push_back(Index);
+ Recorded.Includes.ByFile[RawFile].push_back(Index);
+ }
+
+ void MacroExpands(const Token &MacroName, const MacroDefinition &MD,
+ SourceRange Range, const MacroArgs *Args) override {
+ if (!Active)
+ return;
+ recordMacroRef(MacroName, *MD.getMacroInfo());
+ }
+
+ void MacroDefined(const Token &MacroName, const MacroDirective *MD) override {
+ if (!Active)
+ return;
+
+ const auto *MI = MD->getMacroInfo();
+ // The tokens of a macro definition could refer to a macro.
+ // Formally this reference isn't resolved until this macro is expanded,
+ // but we want to treat it as a reference anyway.
+ for (const auto &Tok : MI->tokens()) {
+ auto *II = Tok.getIdentifierInfo();
+ // Could this token be a reference to a macro? (Not param to this macro).
+ if (!II || !II->hadMacroDefinition() ||
+ llvm::is_contained(MI->params(), II))
+ continue;
+ if (const MacroInfo *MI = Ctx.preprocessor().getMacroInfo(II))
+ recordMacroRef(Tok, *MI);
+ }
+ }
+
+private:
+ void recordMacroRef(const Token &Tok, const MacroInfo &MI) {
+ if (MI.isBuiltinMacro())
+ return; // __FILE__ is not a reference.
+ Recorded.MacroReferences.push_back(SymbolReference{
+ Tok.getLocation(),
+ Ctx.cache().macro(Tok.getIdentifierInfo(), MI.getDefinitionLoc())});
+ }
+
+ bool Active = false;
+ AnalysisContext &Ctx;
+ RecordedPP &Recorded;
+};
+
+llvm::SmallVector<const RecordedPP::Include *>
+RecordedPP::RecordedIncludes::match(Header H) const {
+ llvm::SmallVector<const Include *> Result;
+ switch (H.kind()) {
+ case Header::Physical:
+ for (unsigned I : ByFile.lookup(H.getPhysical()))
+ Result.push_back(&All[I]);
+ break;
+ case Header::StandardLibrary:
+ for (unsigned I :
+ BySpelling.lookup(H.getStandardLibrary().name().trim("<>")))
+ Result.push_back(&All[I]);
+ break;
+ case Header::Verbatim:
+ for (unsigned I : BySpelling.lookup(H.getVerbatimSpelling()))
+ Result.push_back(&All[I]);
+ break;
+ case Header::Builtin:
+ case Header::MainFile:
+ break;
+ }
+ llvm::sort(Result);
+ Result.erase(std::unique(Result.begin(), Result.end()), Result.end());
+ return Result;
+}
+
+class ASTRecorder : public ASTConsumer {
+public:
+ ASTRecorder(AnalysisContext &Ctx, RecordedAST &Recorded)
+ : Ctx(Ctx), Recorded(Recorded) {}
+
+ bool HandleTopLevelDecl(DeclGroupRef DG) override {
+ for (Decl *D : DG) {
+ if (!Ctx.sourceManager().isWrittenInMainFile(
+ Ctx.sourceManager().getExpansionLoc(D->getLocation())))
+ continue;
+ if (const auto *T = llvm::dyn_cast<FunctionDecl>(D))
+ if (T->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
+ continue;
+ if (const auto *T = llvm::dyn_cast<CXXRecordDecl>(D))
+ if (T->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
+ continue;
+ if (const auto *T = llvm::dyn_cast<VarDecl>(D))
+ if (T->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
+ continue;
+ // ObjCMethodDecl are not actually top-level!
+ if (isa<ObjCMethodDecl>(D))
+ continue;
+
+ Recorded.TopLevelDecls.push_back(D);
+ }
+ return true;
+ }
+
+private:
+ AnalysisContext &Ctx;
+ RecordedAST &Recorded;
+};
+
+std::unique_ptr<PPCallbacks> RecordedPP::record(AnalysisContext &Ctx) {
+ return std::make_unique<PPRecorder>(Ctx, *this);
+}
+
+std::unique_ptr<ASTConsumer> RecordedAST::record(AnalysisContext &Ctx) {
+ return std::make_unique<ASTRecorder>(Ctx, *this);
+}
+
+} // namespace include_cleaner
+} // namespace clang
\ No newline at end of file
diff --git a/clang-tools-extra/include-cleaner/lib/Locations.cpp b/clang-tools-extra/include-cleaner/lib/Locations.cpp
new file mode 100644
index 000000000000..7e23c56c1dfc
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/lib/Locations.cpp
@@ -0,0 +1,60 @@
+//===--- Locations.cpp - Find the locations that provide symbols ----------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "AnalysisInternal.h"
+#include "clang-include-cleaner/Analysis.h"
+#include "clang-include-cleaner/Types.h"
+#include "clang/AST/Decl.h"
+#include "clang/AST/DeclBase.h"
+#include "clang/AST/DeclTemplate.h"
+#include "clang/Basic/SourceLocation.h"
+#include "llvm/ADT/SmallVector.h"
+
+namespace clang {
+namespace include_cleaner {
+
+Hint declHint(const NamedDecl &D) {
+ Hint H = Hint::None;
+ if (auto *TD = llvm::dyn_cast<TagDecl>(&D))
+ if (TD->isThisDeclarationADefinition())
+ H |= Hint::Complete;
+ if (auto *CTD = llvm::dyn_cast<ClassTemplateDecl>(&D))
+ if (CTD->isThisDeclarationADefinition())
+ H |= Hint::Complete;
+ // A function template being defined is similar to a class being defined.
+ if (auto *FTD = llvm::dyn_cast<FunctionTemplateDecl>(&D))
+ if (FTD->isThisDeclarationADefinition())
+ H |= Hint::Complete;
+ return H;
+}
+
+llvm::SmallVector<Hinted<Location>> locateDecl(AnalysisContext &Ctx,
+ const NamedDecl &ND) {
+ if (auto StdlibSym = Ctx.cache().StdlibRecognizer(&ND))
+ return {{*StdlibSym}};
+
+ llvm::SmallVector<Hinted<Location>> Result;
+ // Is accepting all the redecls too naive?
+ for (const Decl *RD : ND.redecls()) {
+ // `friend X` is not an interesting location for X unless it's acting as a
+ // forward-declaration.
+ if (RD->getFriendObjectKind() == Decl::FOK_Declared)
+ continue;
+ SourceLocation Loc = RD->getLocation();
+ if (Loc.isValid())
+ Result.push_back({Loc, declHint(*cast<NamedDecl>(RD))});
+ }
+ return Result;
+}
+
+Hinted<Location> locateMacro(AnalysisContext &Ctx, const DefinedMacro &M) {
+ return {M.Definition};
+}
+
+} // namespace include_cleaner
+} // namespace clang
diff --git a/clang-tools-extra/include-cleaner/lib/Types.cpp b/clang-tools-extra/include-cleaner/lib/Types.cpp
new file mode 100644
index 000000000000..6b79c603a70d
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/lib/Types.cpp
@@ -0,0 +1,61 @@
+//===--- Types.cpp - Data structures for used-symbol analysis -------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "clang-include-cleaner/Types.h"
+#include "clang/AST/Decl.h"
+#include "clang/Basic/FileEntry.h"
+#include "clang/Basic/IdentifierTable.h"
+#include "clang/Tooling/Inclusions/StandardLibrary.h"
+
+namespace clang {
+namespace include_cleaner {
+
+std::string Symbol::name() const {
+ switch (kind()) {
+ case Macro:
+ return getMacro()->Name->getName().str();
+ case Declaration:
+ return getDeclaration()->getNameAsString();
+ }
+ llvm_unreachable("Unhandled Symbol kind");
+}
+
+std::string Symbol::nodeName() const {
+ if (kind() == Macro)
+ return "macro";
+ return getDeclaration()->getDeclKindName();
+}
+
+std::string Location::name(const SourceManager &SM) const {
+ switch (K) {
+ case Physical:
+ return SrcLoc.printToString(SM);
+ case StandardLibrary:
+ return StdlibSym.name().str();
+ }
+ llvm_unreachable("Unhandled Location kind");
+}
+
+std::string Header::name() const {
+ switch (K) {
+ case Physical:
+ return PhysicalFile->getName().str();
+ case StandardLibrary:
+ return StdlibHeader.name().str();
+ case Verbatim:
+ return VerbatimSpelling;
+ case Builtin:
+ return "<built-in>";
+ case MainFile:
+ return "<main-file>";
+ }
+ llvm_unreachable("Unhandled Header kind");
+}
+
+} // namespace include_cleaner
+} // namespace clang
diff --git a/clang-tools-extra/include-cleaner/lib/WalkAST.cpp b/clang-tools-extra/include-cleaner/lib/WalkAST.cpp
index b7354fe300e0..02a27977005f 100644
--- a/clang-tools-extra/include-cleaner/lib/WalkAST.cpp
+++ b/clang-tools-extra/include-cleaner/lib/WalkAST.cpp
@@ -7,40 +7,132 @@
//===----------------------------------------------------------------------===//
#include "AnalysisInternal.h"
+#include "clang-include-cleaner/Analysis.h"
#include "clang/AST/RecursiveASTVisitor.h"
+#include "clang/Basic/SourceManager.h"
+#include "llvm/Support/SaveAndRestore.h"
namespace clang {
namespace include_cleaner {
namespace {
-using DeclCallback = llvm::function_ref<void(SourceLocation, NamedDecl &)>;
+using DeclCallback =
+ llvm::function_ref<void(SourceLocation, Hinted<NamedDecl &>)>;
+
+// Traverses part of the AST, looking for references and reporting them.
class ASTWalker : public RecursiveASTVisitor<ASTWalker> {
- DeclCallback Callback;
+public:
+ ASTWalker(AnalysisContext &Ctx, DeclCallback Callback)
+ : Ctx(Ctx), Callback(Callback) {}
- void report(SourceLocation Loc, NamedDecl *ND) {
- if (!ND || Loc.isInvalid())
- return;
- Callback(Loc, *cast<NamedDecl>(ND->getCanonicalDecl()));
+ bool VisitDeclRefExpr(DeclRefExpr *E) {
+ if (!Ctx.policy().Operators)
+ if (auto *FD = E->getDecl()->getAsFunction())
+ if (FD->isOverloadedOperator())
+ return true;
+ report(E->getLocation(), E->getFoundDecl());
+ return true;
}
-public:
- ASTWalker(DeclCallback Callback) : Callback(Callback) {}
+ bool VisitMemberExpr(MemberExpr *ME) {
+ if (Ctx.policy().Members)
+ report(ME->getMemberLoc(), ME->getFoundDecl().getDecl());
+ return true;
+ }
+
+ bool VisitTagType(TagType *TT) {
+ report(LocationOfType, TT->getDecl());
+ return true;
+ }
+
+ bool VisitFunctionDecl(FunctionDecl *FD) {
+ // Count function definitions as a reference to their declarations.
+ if (FD->isThisDeclarationADefinition() && FD->getCanonicalDecl() != FD)
+ report(FD->getLocation(), FD->getCanonicalDecl());
+ return true;
+ }
+
+ bool VisitCXXConstructExpr(CXXConstructExpr *E) {
+ if (!Ctx.policy().Construction)
+ return true;
+ SaveAndRestore<SourceLocation> Loc(LocationOfType, E->getLocation());
+ LocationOfType = E->getLocation();
+ return TraverseType(E->getType());
+ }
+
+ // We handle TypeLocs by saving their loc and consuming it in Visit*Type().
+ //
+ // Handling Visit*TypeLoc() directly would be simpler, but sometimes unwritten
+ // types count as references (e.g. implicit conversions, with no TypeLoc).
+ // Stashing the location and visiting the contained type lets us handle both
+ // cases in VisitTagType() etc.
+ bool TraverseTypeLoc(TypeLoc TL) {
+ SaveAndRestore<SourceLocation> Loc(LocationOfType, TL.getBeginLoc());
+ // The base implementation calls:
+ // - Visit*TypeLoc() - does nothing
+ // - Visit*Type() - where we handle type references
+ // - TraverseTypeLoc for each lexically nested type.
+ return Base::TraverseTypeLoc(TL);
+ }
- bool VisitTagTypeLoc(TagTypeLoc TTL) {
- report(TTL.getNameLoc(), TTL.getDecl());
+ bool VisitTemplateSpecializationType(TemplateSpecializationType *TST) {
+ report(LocationOfType,
+ TST->getTemplateName().getAsTemplateDecl()); // Primary template.
+ report(LocationOfType, TST->getAsCXXRecordDecl()); // Specialization
return true;
}
- bool VisitDeclRefExpr(DeclRefExpr *DRE) {
- report(DRE->getLocation(), DRE->getFoundDecl());
+ bool VisitUsingType(UsingType *UT) {
+ report(LocationOfType, UT->getFoundDecl());
return true;
}
+
+ bool VisitTypedefType(TypedefType *TT) {
+ report(LocationOfType, TT->getDecl());
+ return true;
+ }
+
+ bool VisitUsingDecl(UsingDecl *UD) {
+ for (const auto *USD : UD->shadows())
+ report(UD->getLocation(), USD->getTargetDecl());
+ return true;
+ }
+
+ bool VisitOverloadExpr(OverloadExpr *E) {
+ if (llvm::isa<UnresolvedMemberExpr>(E) && !Ctx.policy().Members)
+ return true;
+ for (auto *Candidate : E->decls())
+ report(E->getExprLoc(), Candidate);
+ return true;
+ }
+
+private:
+ void report(SourceLocation Loc, NamedDecl *ND) {
+ while (Loc.isMacroID()) {
+ auto DecLoc = Ctx.sourceManager().getDecomposedLoc(Loc);
+ const SrcMgr::ExpansionInfo &Expansion =
+ Ctx.sourceManager().getSLocEntry(DecLoc.first).getExpansion();
+ if (!Expansion.isMacroArgExpansion())
+ return; // Names within macro bodies are not considered references.
+ Loc = Expansion.getSpellingLoc().getLocWithOffset(DecLoc.second);
+ }
+ // FIXME: relevant ranking hints?
+ if (ND)
+ Callback(Loc, *cast<NamedDecl>(ND->getCanonicalDecl()));
+ }
+
+ using Base = RecursiveASTVisitor;
+
+ AnalysisContext &Ctx;
+ DeclCallback Callback;
+
+ SourceLocation LocationOfType;
};
} // namespace
-void walkAST(Decl &Root, DeclCallback Callback) {
- ASTWalker(Callback).TraverseDecl(&Root);
+void walkAST(AnalysisContext &Ctx, Decl &Root, DeclCallback Callback) {
+ ASTWalker(Ctx, Callback).TraverseDecl(&Root);
}
} // namespace include_cleaner
diff --git a/clang-tools-extra/include-cleaner/tool/CMakeLists.txt b/clang-tools-extra/include-cleaner/tool/CMakeLists.txt
new file mode 100644
index 000000000000..f8f7c81c761b
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/tool/CMakeLists.txt
@@ -0,0 +1,17 @@
+set(LLVM_LINK_COMPONENTS support)
+
+add_clang_tool(clang-include-cleaner
+ ClangIncludeCleaner.cpp
+ )
+
+clang_target_link_libraries(clang-include-cleaner
+ PRIVATE
+ clangBasic
+ clangFrontend
+ clangTooling
+ )
+
+target_link_libraries(clang-include-cleaner
+ PRIVATE
+ clangIncludeCleaner
+ )
\ No newline at end of file
diff --git a/clang-tools-extra/include-cleaner/tool/ClangIncludeCleaner.cpp b/clang-tools-extra/include-cleaner/tool/ClangIncludeCleaner.cpp
new file mode 100644
index 000000000000..aad70eabdae9
--- /dev/null
+++ b/clang-tools-extra/include-cleaner/tool/ClangIncludeCleaner.cpp
@@ -0,0 +1,187 @@
+//===--- ClangIncludeCleaner.cpp - Standalone used-header analysis --------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// clang-include-cleaner finds violations of include-what-you-use policy.
+//
+// It scans a file, finding referenced symbols and headers providing them.
+// - if a reference is satisfied only by indirect #include dependencies,
+// this violates the policy and direct #includes are suggested.
+// - if some #include directive doesn't satisfy any references, this violates
+// the policy (don't include what you don't use!) and removal is suggested.
+//
+// With the -satisfied flag, it will also explain things that were OK:
+// satisfied references and used #includes.
+//
+// This tool doesn't fix broken code where missing #includes prevent parsing,
+// try clang-include-fixer for this instead.
+//
+//===----------------------------------------------------------------------===//
+
+#include "clang-include-cleaner/Analysis.h"
+#include "clang-include-cleaner/Hooks.h"
+#include "clang/Basic/Diagnostic.h"
+#include "clang/Frontend/CompilerInstance.h"
+#include "clang/Frontend/FrontendAction.h"
+#include "clang/Tooling/CommonOptionsParser.h"
+#include "clang/Tooling/Tooling.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/InitLLVM.h"
+
+llvm::cl::OptionCategory OptionsCat{"clang-include-cleaner"};
+llvm::cl::opt<bool> ShowSatisfied{
+ "satisfied",
+ llvm::cl::cat(OptionsCat),
+ llvm::cl::desc(
+ "Show references whose header is included, and used includes"),
+ llvm::cl::init(false),
+};
+llvm::cl::opt<bool> Recover{
+ "recover",
+ llvm::cl::cat(OptionsCat),
+ llvm::cl::desc("Suppress further errors for the same header"),
+ llvm::cl::init(true),
+};
+
+namespace clang {
+namespace include_cleaner {
+namespace {
+
+class Action : public clang::ASTFrontendAction {
+public:
+ bool BeginSourceFileAction(CompilerInstance &CI) override {
+ Diag = &CI.getDiagnostics();
+ ID.emplace(Diag);
+ Ctx.emplace(Policy{}, CI.getPreprocessor());
+ CI.getPreprocessor().addPPCallbacks(PP.record(*Ctx));
+ return true;
+ }
+
+ void EndSourceFile() override {
+ llvm::DenseSet<Header> Recovered;
+ llvm::DenseMap<const RecordedPP::Include *, Symbol> Used;
+ walkUsed(*Ctx, AST.TopLevelDecls, PP.MacroReferences,
+ [&](SourceLocation Loc, Symbol Sym, ArrayRef<Header> Headers) {
+ diagnoseReference(Loc, Sym, Headers, Recovered, Used);
+ });
+ diagnoseIncludes(PP.Includes.all(), Used);
+ Ctx.reset();
+
+ ASTFrontendAction::EndSourceFile();
+ }
+
+ virtual std::unique_ptr<ASTConsumer>
+ CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override {
+ return AST.record(*Ctx);
+ }
+
+private:
+ // The diagnostics that we issue.
+ struct CustomDiagnosticIDs {
+ // References
+ unsigned Satisfied;
+ unsigned Unsatisfied;
+ unsigned NoHeader;
+ unsigned NoteHeader;
+ // #includes
+ unsigned Used;
+ unsigned Unused;
+
+ CustomDiagnosticIDs(DiagnosticsEngine *D) {
+ auto SatisfiedLevel = ShowSatisfied ? DiagnosticsEngine::Remark
+ : DiagnosticsEngine::Ignored;
+ auto Error = DiagnosticsEngine::Error;
+ auto Note = DiagnosticsEngine::Note;
+ auto Warn = DiagnosticsEngine::Warning;
+
+ Satisfied = D->getCustomDiagID(SatisfiedLevel, "%0 '%1' provided by %2");
+ Unsatisfied = D->getCustomDiagID(Error, "no header included for %0 '%1'");
+ NoHeader = D->getCustomDiagID(Warn, "unknown header provides %0 '%1'");
+ NoteHeader = D->getCustomDiagID(Note, "provided by %0");
+ Used = D->getCustomDiagID(SatisfiedLevel, "include provides %0 '%1'");
+ Unused = D->getCustomDiagID(Error, "include is unused");
+ }
+ };
+
+ void
+ diagnoseReference(SourceLocation Loc, Symbol Sym, ArrayRef<Header> Headers,
+ llvm::DenseSet<Header> &Recovered,
+ llvm::DenseMap<const RecordedPP::Include *, Symbol> &Used) {
+ bool Diagnosed = false;
+ for (const auto &H : Headers) {
+ if (H.kind() == Header::Builtin || H.kind() == Header::MainFile) {
+ if (!Diagnosed) {
+ Diag->Report(Loc, ID->Satisfied)
+ << Sym.nodeName() << Sym.name() << H.name();
+ Diagnosed = true;
+ }
+ }
+ for (const auto *I : PP.Includes.match(H)) {
+ Used.try_emplace(I, Sym);
+ if (!Diagnosed) {
+ Diag->Report(Loc, ID->Satisfied)
+ << Sym.nodeName() << Sym.name() << I->Spelled;
+ Diagnosed = true;
+ }
+ }
+ }
+ if (Diagnosed)
+ return;
+ for (const auto &H : Headers) {
+ if (Recovered.contains(H)) {
+ Diag->Report(Loc, ID->Satisfied)
+ << Sym.nodeName() << Sym.name() << H.name();
+ return;
+ }
+ }
+ Diag->Report(Loc, Headers.empty() ? ID->NoHeader : ID->Unsatisfied)
+ << Sym.nodeName() << Sym.name();
+ for (const auto &H : Headers) {
+ Recovered.insert(H);
+ Diag->Report(ID->NoteHeader) << H.name();
+ }
+ }
+
+ void diagnoseIncludes(
+ ArrayRef<RecordedPP::Include> Includes,
+ const llvm::DenseMap<const RecordedPP::Include *, Symbol> &Used) {
+ for (const auto &I : Includes) {
+ auto It = Used.find(&I);
+ if (It == Used.end())
+ Diag->Report(I.Location, ID->Unused);
+ else
+ Diag->Report(I.Location, ID->Used)
+ << It->second.nodeName() << It->second.name();
+ }
+ }
+
+ llvm::Optional<AnalysisContext> Ctx;
+ RecordedPP PP;
+ RecordedAST AST;
+ DiagnosticsEngine *Diag;
+ llvm::Optional<CustomDiagnosticIDs> ID;
+};
+
+} // namespace
+} // namespace include_cleaner
+} // namespace clang
+
+int main(int Argc, const char **Argv) {
+ llvm::InitLLVM X(Argc, Argv);
+ auto OptionsParser =
+ clang::tooling::CommonOptionsParser::create(Argc, Argv, OptionsCat);
+ if (!OptionsParser) {
+ llvm::errs() << toString(OptionsParser.takeError());
+ return 1;
+ }
+
+ return clang::tooling::ClangTool(OptionsParser->getCompilations(),
+ OptionsParser->getSourcePathList())
+ .run(clang::tooling::newFrontendActionFactory<
+ clang::include_cleaner::Action>()
+ .get());
+}
diff --git a/clang/include/clang/Tooling/Inclusions/StandardLibrary.h b/clang/include/clang/Tooling/Inclusions/StandardLibrary.h
index c6ce2780dae6..e94a7fb9304a 100644
--- a/clang/include/clang/Tooling/Inclusions/StandardLibrary.h
+++ b/clang/include/clang/Tooling/Inclusions/StandardLibrary.h
@@ -49,6 +49,9 @@ private:
friend bool operator==(const Header &L, const Header &R) {
return L.ID == R.ID;
}
+ friend bool operator<(const Header &L, const Header &R) {
+ return L.ID < R.ID;
+ }
};
// A top-level standard library symbol, such as std::vector
|