Improve comments a bit more.
[oota-llvm.git] / utils / userloc.pl
1 #!/usr/bin/perl -w
2 #
3 # Program:  userloc.pl
4 #
5 # Synopsis: This program uses "cvs annotate" to get a summary of how many lines
6 #           of code the various developres are responsible for. It takes one
7 #           argument, the directory to process. If the argument is not specified
8 #           then the cwd is used. The directory must be an LLVM tree checked out
9 #           from cvs. 
10 #
11 # Syntax:   userloc.pl [-tag=tag|-html... <directory>...
12 #
13 # Options:
14 #           -tag=tag
15 #               Use "tag" to select the revision (as per cvs -r option)
16 #           -filedetails
17 #               Report details about lines of code in each file for each user
18 #           -html
19 #               Generate HTML output instead of text output
20 #           -topdir
21 #               Specify where the top llvm source directory is. Otherwise the
22 #               llvm-config tool is used to find it.
23 # Directories:
24 #   The directories passed after the options should be relative paths to
25 #   directories of interest from the top of the llvm source tree, e.g. "lib"
26 #   or "include", etc.
27
28 die "Usage userloc.pl [-tag=tag|-html] <directories>..." 
29   if ($#ARGV < 0);
30
31 my $tag = "";
32 my $html = 0;
33 my $debug = 0;
34 my $filedetails = "";
35 my $srcroot = "";
36 while ( defined($ARGV[0]) && substr($ARGV[0],0,1) eq '-' )
37 {
38   if ($ARGV[0] =~ /-tag=.*/) {
39     $tag = $ARGV[0];
40     $tag =~ s#-tag=(.*)#$1#;
41   } elsif ($ARGV[0] =~ /-filedetails/) {
42     $filedetails = 1;
43   } elsif ($ARGV[0] eq "-html") {
44     $html = 1;
45   } elsif ($ARGV[0] eq "-debug") {
46     $debug = 1;
47   } elsif ($ARGV[0] eq "-topdir") {
48     shift; $srcroot = $ARGV[0]; shift;
49   } else {
50     die "Invalid option: $ARGV[0]";
51   }
52   shift;
53 }
54
55 if (length($srcroot) == 0) {
56   chomp($srcroot = `llvm-config --src-root`);
57 }
58 if (! -d "$srcroot") {
59   die "Invalid source root: $srcroot\n";
60 }
61 chdir($srcroot);
62 my $llvmdo = "$srcroot/utils/llvmdo -topdir '$srcroot'";
63 my %Stats;
64 my %FileStats;
65
66 my $annotate = "cvs -z6 annotate -lf ";
67 if (length($tag) > 0)
68 {
69   $annotate = $annotate . " -r" . $tag;
70 }
71
72 sub GetCVSFiles
73 {
74   my $d = $_[0];
75   my $files ="";
76   open FILELIST, 
77     "$llvmdo -dirs \"$d\" -code-only echo |" || die "Can't get list of files with llvmdo";
78   while ( defined($line = <FILELIST>) ) {
79     chomp($file = $line);
80     print "File: $file\n" if ($debug);
81     $files = "$files $file";
82   }
83   return $files;
84 }
85
86 sub ScanDir
87 {
88   my $Dir = $_[0];
89   my $files = GetCVSFiles($Dir);
90
91   open (DATA,"$annotate $files 2>&1 |")
92     || die "Can't read cvs annotation data";
93
94   my $curfile = "";
95   while ( defined($line = <DATA>) )
96   {
97     chomp($line);
98     if ($line =~ '^Annotations for.*') {
99       $curfile = $line;
100       $curfile =~ s#^Annotations for ([[:print:]]*)#$1#;
101       print "Scanning: $curfile\n" if ($debug);
102     } elsif ($line =~ /^[0-9.]*[ \t]*\([^)]*\):/) {
103       $uname = $line;
104       $uname =~ s#^[0-9.]*[ \t]*\(([a-zA-Z0-9_.-]*) [^)]*\):.*#$1#;
105       $Stats{$uname}++;
106       if ($filedetails) {
107         $FileStats{$uname} = {} unless exists $FileStats{$uname};
108         ${$FileStats{$uname}}{$curfile}++;
109       }
110     }
111   }
112   close DATA;
113 }
114
115 sub printStats
116 {
117   my $dir = $_[0];
118   my $hash = $_[1];
119   my $user;
120   my $total = 0;
121
122   foreach $user (keys %Stats) { $total += $Stats{$user}; }
123
124   if ($html) { 
125     print "<p>Total Source Lines: $total<br/></p>\n";
126     print "<table>";
127     print " <tr><th style=\"text-align:right\">LOC</th>\n";
128     print " <th style=\"text-align:right\">\%LOC</th>\n";
129     print " <th style=\"text-align:left\">User</th>\n";
130     print "</tr>\n";
131   }
132
133   foreach $user ( sort keys %Stats )
134   {
135     my $v = $Stats{$user};
136     if (defined($v))
137     {
138       if ($html) {
139         printf "<tr><td style=\"text-align:right\">%d</td><td style=\"text-align:right\">(%4.1f%%)</td><td style=\"text-align:left\">", $v, (100.0/$total)*$v;
140         if ($filedetails) {
141           print "<a href=\"#$user\">$user</a></td></tr>";
142         } else {
143           print $user,"</td></tr>";
144         }
145       } else {
146         printf "%8d  (%4.1f%%)  %s\n", $v, (100.0/$total)*$v, $user;
147       }
148     }
149   }
150   print "</table>\n" if ($html);
151
152   if ($filedetails) {
153     foreach $user (sort keys %FileStats) {
154       my $total = 0;
155       foreach $file (sort keys %{$FileStats{$user}}) { 
156         $total += ${$FileStats{$user}}{$file}
157       }
158       if ($html) {
159         print "<table><tr><th style=\"text-align:left\" colspan=\"3\"><a name=\"$user\">$user</a></th></tr>\n";
160       } else {
161         print $user,":\n";
162       }
163       foreach $file (sort keys %{$FileStats{$user}}) {
164         my $v = ${$FileStats{$user}}{$file};
165         if ($html) { 
166           printf "<tr><td style=\"text-align:right\">&nbsp;&nbsp;%d</td><td
167           style=\"text-align:right\">&nbsp;%4.1f%%</td><td
168           style=\"text-align:left\">%s</td></tr>",$v, (100.0/$total)*$v,$file;
169         } else {
170           printf "%8d  (%4.1f%%)  %s\n", $v, (100.0/$total)*$v, $file;
171         }
172       }
173       if ($html) { print "</table>\n"; }
174     }
175   }
176 }
177
178
179 if ($html)
180 {
181 print "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n";
182 print "<html>\n<head>\n";
183 print "  <title>LLVM LOC Based On CVS Annotation</title>\n";
184 print "  <link rel=\"stylesheet\" href=\"llvm.css\" type=\"text/css\"/>\n";
185 print "</head>\n";
186 print "<body><div class=\"doc_title\">LLVM LOC Based On CVS Annotation</div>\n";
187 print "<p>This document shows the total lines of code per user in each\n";
188 print "LLVM directory. Lines of code are attributed by the user that last\n";
189 print "committed the line. This does not necessarily reflect authorship.</p>\n";
190 }
191
192 my @DIRS;
193 if ($#ARGV > 0) {
194   @DIRS = @ARGV;
195 } else {
196   push @DIRS, 'include';
197   push @DIRS, 'lib';
198   push @DIRS, 'tools';
199   push @DIRS, 'runtime';
200   push @DIRS, 'docs';
201   push @DIRS, 'test';
202   push @DIRS, 'utils';
203   push @DIRS, 'examples';
204   push @DIRS, 'projects/Stacker';
205   push @DIRS, 'projects/sample';
206   push @DIRS, 'autoconf';
207 }
208   
209 for $Index ( 0 .. $#DIRS) { 
210   print "Scanning Dir: $DIRS[$Index]\n" if ($debug);
211   ScanDir($DIRS[$Index]); 
212 }
213
214 printStats;
215
216 print "</body></html>\n" if ($html) ;