blob: 676ddc07d6fa76b1a79603cf3be95a26eb7b7ec1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#!/usr/bin/perl
2#
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -07003# checkincludes: find/remove files included more than once
4#
Linus Torvalds1da177e2005-04-16 15:20:36 -07005# Copyright abandoned, 2000, Niels Kristian Bech Jensen <nkbj@image.dk>.
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -07006# Copyright 2009 Luis R. Rodriguez <mcgrof@gmail.com>
7#
8# This script checks for duplicate includes. It also has support
9# to remove them in place. Note that this will not take into
10# consideration macros so you should run this only if you know
11# you do have real dups and do not have them under #ifdef's. You
12# could also just review the results.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
Luis R. Rodriguezf9d490a2009-09-18 12:49:26 -070014sub usage {
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070015 print "Usage: checkincludes.pl [-r]\n";
16 print "By default we just warn of duplicates\n";
17 print "To remove duplicated includes in place use -r\n";
Luis R. Rodriguezf9d490a2009-09-18 12:49:26 -070018 exit 1;
19}
20
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070021my $remove = 0;
22
Luis R. Rodriguezf9d490a2009-09-18 12:49:26 -070023if ($#ARGV < 0) {
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070024 usage();
25}
26
27if ($#ARGV >= 1) {
28 if ($ARGV[0] =~ /^-/) {
29 if ($ARGV[0] eq "-r") {
30 $remove = 1;
31 shift;
32 } else {
33 usage();
34 }
35 }
Luis R. Rodriguezf9d490a2009-09-18 12:49:26 -070036}
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038foreach $file (@ARGV) {
39 open(FILE, $file) or die "Cannot open $file: $!.\n";
40
41 my %includedfiles = ();
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070042 my @file_lines = ();
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44 while (<FILE>) {
45 if (m/^\s*#\s*include\s*[<"](\S*)[>"]/o) {
46 ++$includedfiles{$1};
47 }
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070048 push(@file_lines, $_);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 }
Luis R. Rodriguezd9a7a2b2009-09-18 12:49:25 -070050
51 close(FILE);
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070052
53 if (!$remove) {
54 foreach $filename (keys %includedfiles) {
55 if ($includedfiles{$filename} > 1) {
56 print "$file: $filename is included more than once.\n";
57 }
58 }
59 next;
60 }
61
62 open(FILE,">$file") || die("Cannot write to $file: $!");
63
64 my $dups = 0;
65 foreach (@file_lines) {
66 if (m/^\s*#\s*include\s*[<"](\S*)[>"]/o) {
67 foreach $filename (keys %includedfiles) {
68 if ($1 eq $filename) {
69 if ($includedfiles{$filename} > 1) {
70 $includedfiles{$filename}--;
71 $dups++;
72 } else {
73 print FILE $_;
74 }
75 }
76 }
77 } else {
78 print FILE $_;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 }
80 }
Luis R. Rodriguez92f3f192009-09-18 12:49:27 -070081 if ($dups > 0) {
82 print "$file: removed $dups duplicate includes\n";
83 }
84 close(FILE);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085}