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 [-recurse|-tag=tag|-html... <directory>...
  12 #
  13 # Options:
  14 #           -recurse
  15 #               Recurse through sub directories. Without this, only the
  16 #               specified directory is examined
  17 #           -tag=tag
  18 #               Use "tag" to select the revision (as per cvs -r option)
  19 #           -html
  20 #               Generate HTML output instead of text output
  21
  22 die "Usage userloc.pl [-recurse|-tag=tag|-html] <directories>..."
  23   if ($#ARGV < 0);
  24
  25 my $tag = "";
  26 my $recurse = 0;
  27 my $html = 0;
  28 my $debug = 0;
  29 while ( substr($ARGV[0],0,1) eq '-' )
  30 {
  31   if ($ARGV[0] eq "-recurse") {
  32     $recurse = 1;
  33   } elsif ($ARGV[0] =~ /-tag=.*/) {
  34     $tag = $ARGV[0];
  35     $tag =~ s#-tag=(.*)#$1#;
  36   } elsif ($ARGV[0] eq "-html") {
  37     $html = 1;
  38   } elsif ($ARGV[0] eq "-debug") {
  39     $debug = 1;
  40   } else {
  41     die "Invalid option: $ARGV[0]";
  42   }
  43   shift;
  44 }
  45
  46 die "Usage userloc.pl [-recurse|-tag=tag|-html] <directories>..."
  47   if ($#ARGV < 0);
  48
  49 my %Stats;
  50 my %StatsDetails;
  51
  52 sub ValidateFile
  53 {
  54   my $f = $_[0];
  55   my $d = $_[1];
  56
  57   if ( $d =~ ".*autoconf.*")
  58   {
  59     return 1 if ($f eq "configure.ac");
  60     return 1 if ($f eq "AutoRegen.sh");
  61     return 0;
  62   }
  63   return 0 if ( "$f" eq "configure");
  64   return 0 if ( "$f" eq 'PPCPerfectShuffle.h' );
  65   return 0 if ( $f =~ /.*\.cvs/);
  66   return 1;
  67 }
  68
  69 sub GetCVSFiles
  70 {
  71   my $d = $_[0];
  72   my $files ="";
  73   open STATUS, "cvs -nfz6 status $d -l 2>/dev/null |"
  74     || die "Can't 'cvs status'";
  75   while ( defined($line = <STATUS>) )
  76   {
  77     if ( $line =~ /^File:.*/ )
  78     {
  79       chomp($line);
  80       $line =~ s#^File: ([A-Za-z0-9._-]*)[ \t]*Status:.*#$1#;
  81       $files = "$files $d/$line" if (ValidateFile($line,$d));
  82     }
  83
  84   }
  85   return $files;
  86 }
  87
  88 my $annotate = "cvs -z6 annotate -lf ";
  89 if (length($tag) > 0)
  90 {
  91   $annotate = $annotate . " -r" . $tag;
  92 }
  93
  94 sub ScanDir
  95 {
  96   my $Dir = $_[0];
  97   my $files = GetCVSFiles($Dir);
  98
  99   open (DATA,"$annotate $files 2>/dev/null |")
 100     || die "Can't read cvs annotation data";
 101
 102   while ( defined($line = <DATA>) )
 103   {
 104     if ($line =~ /^[0-9.]*[ \t]*\([^)]*\):/)
 105     {
 106       chomp($line);
 107       $line =~ s#^[0-9.]*[ \t]*\(([a-zA-Z0-9_.-]*) [^)]*\):.*#$1#;
 108       $Stats{$line}++;
 109     }
 110   }
 111
 112   close DATA;
 113 }
 114
 115 sub ValidateDirectory
 116 {
 117   my $d = $_[0];
 118   return 0 if (! -d "$d" || ! -d "$d/CVS");
 119   return 0 if ($d =~ /.*CVS.*/);
 120   return 0 if ($d =~ /.*Debug.*/);
 121   return 0 if ($d =~ /.*Release.*/);
 122   return 0 if ($d =~ /.*Profile.*/);
 123   return 0 if ($d =~ /.*docs\/CommandGuide\/html.*/);
 124   return 0 if ($d =~ /.*docs\/CommandGuide\/man.*/);
 125   return 0 if ($d =~ /.*docs\/CommandGuide\/ps.*/);
 126   return 0 if ($d =~ /.*docs\/CommandGuide\/man.*/);
 127   return 0 if ($d =~ /.*docs\/HistoricalNotes.*/);
 128   return 0 if ($d =~ /.*docs\/img.*/);
 129   return 0 if ($d =~ /.*bzip2.*/);
 130   return 1 if ($d =~ /.*projects\/Stacker.*/);
 131   return 1 if ($d =~ /.*projects\/sample.*/);
 132   return 0 if ($d =~ /.*projects\/llvm-.*/);
 133   return 0 if ($d =~ /.*win32.*/);
 134   return 0 if ($d =~ /.*\/.libs\/.*/);
 135   return 1;
 136 }
 137
 138 my $RowCount = 0;
 139 sub printStats
 140 {
 141   my $dir = $_[0];
 142   my $hash = $_[1];
 143   my $user;
 144   my $total = 0;
 145
 146   if ($RowCount % 10 == 0)
 147   {
 148     if ($html) {
 149       print " <tr><th style=\"text-align:left\">Directory</th>\n";
 150       foreach $user (sort keys %Stats)
 151       {
 152         print "<th style=\"text-align:right\">",$user,"</th>\n";
 153       }
 154       print "</tr>\n";
 155     }
 156   }
 157
 158   $RowCount++;
 159
 160   if ($html)
 161     { print "<tr><td style=\"text-align:left\">",$dir,"</td>"; }
 162   else
 163     { print $dir,"\n"; }
 164
 165   foreach $user (keys %{$hash}) { $total += $hash->{$user}; }
 166
 167   foreach $user ( sort keys %Stats )
 168   {
 169     my $v = $hash->{$user};
 170     if (defined($v))
 171     {
 172       if ($html)
 173       {
 174         printf "<td style=\"text-align:right\">%d<br/>(%2.1f%%)</td>", $v,
 175           (100.0/$total)*$v;
 176       }
 177       else
 178       {
 179         printf "%8d (%4.1f%%): %s\n", $v, (100.0/$total)*$v, $user;
 180       }
 181     }
 182     elsif ($html)
 183     {
 184       print "<td style=\"text-align:right\">-&nbsp;</td>";
 185     }
 186   }
 187   print "</tr>\n" if ($html);
 188 }
 189
 190 my @ALLDIRS = @ARGV;
 191
 192 if ($recurse)
 193 {
 194   $Dirs = join(" ", @ARGV);
 195   $Dirs = `find $Dirs -type d \! -name CVS -print`;
 196   @ALLDIRS = split(' ',$Dirs);
 197 }
 198
 199 if ($html)
 200 {
 201 print "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n";
 202 print "<html>\n<head>\n";
 203 print "  <title>LLVM LOC Based On CVS Annotation</title>\n";
 204 print "  <link rel=\"stylesheet\" href=\"llvm.css\" type=\"text/css\"/>\n";
 205 print "</head>\n";
 206 print "<body><div class=\"doc_title\">LLVM LOC Based On CVS Annotation</div>\n";
 207 print "<p>This document shows the total lines of code per user in each\n";
 208 print "LLVM directory. Lines of code are attributed by the user that last\n";
 209 print "committed the line. This does not necessarily reflect authorship.</p>\n";
 210 }
 211
 212 my @ignored_dirs;
 213
 214 for $Dir (@ALLDIRS)
 215 {
 216   if ( ValidateDirectory($Dir) )
 217   {
 218     ScanDir($Dir);
 219   }
 220   elsif ($html)
 221   {
 222     push @ignored_dirs, $Dir;
 223   }
 224 }
 225
 226 if ($html)
 227 {
 228   print "<table>\n";
 229 }
 230
 231 printStats("Total",\%Stats);
 232
 233 if ($html)
 234 {
 235   print "</table>";
 236   if (scalar @ignored_dirs > 0) {
 237     print "<p>The following directories were skipped:</p>\n";
 238     print "<ol>\n";
 239     foreach $index (0 .. $#ignored_dirs) {
 240       print " <li>", $ignored_dirs[$index], "</li>\n";
 241     }
 242     print "</ol>\n";
 243   }
 244   print "</body></html>\n";
 245 }