File: comment_ratios

package info (click to toggle)
magnus 20060324-3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 19,404 kB
  • ctags: 20,466
  • sloc: cpp: 130,118; ansic: 37,076; tcl: 10,970; perl: 1,109; makefile: 963; sh: 403; yacc: 372; csh: 57; awk: 33; asm: 10
file content (160 lines) | stat: -rwxr-xr-x 3,847 bytes parent folder | download | duplicates (3)
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
#!/usr/local/bin/perl

## Copyright (C) 1994 The New York Group Theory Cooperative
## See magnus/doc/COPYRIGHT for the full notice.

## Contents: comment_ratios, which computes the ratio of comment characters
##           to all characters, ignoring /*...*/, in all source, header, and
##           Makefiles at and below the current directory.
##
## Principal Author: Roger Needham
##
## Status: Useable.
##
## Revision History:
##
## Next implementation steps:
##


$summary_p = 0;

while ( $#ARGV != -1 ) {
  $_ = shift;
  if ( /^-s$/ ) {
    $summary_p = !$summary_p;
  }
  elsif ( /^-h$/ || /--help/) {
    &help;
    exit;
  }
  else {
    print "Unknown option: $_\n\n";
    &help;
    exit 1;
  }
}

$author_index = 0;

open( FIND, "/bin/find . -type f -print |");

while ($name = <FIND>) {

  if ( !($name =~ /(\.([Chc]|mk|tcl)$)|Makefile/) &&
       !((-x $name) && (-T $name)) ) { next; }

  #@rn include .in files?

  $sharp_p = !($name =~ /\.[Chc]$/);
  chop $name;
  open(FILE, $name) || print "** Couldn't open $name\n";
  if ( !$summary_p ) { print "\n$name:\n"; }

  $total_char_count = 0;
  $C_comment_char_count = 0;
  $Cpp_comment_char_count = 0;
  $reading_C_comment = 0;
  $did_author = 0;
  @authors = ("anonymous");

  while( $line = <FILE> ) {

    if ( !$did_author && ($line =~ /Principal Author.*:\s*(.+)$/) ) {
      $did_author = 1;

      # Get authors(s) of this file:
      @authors = split(/,\s*/, $1);
      foreach $author (@authors) {
        if ( $author_indices{$author} == 0 ) {
          $author_indices{$author} = ++$author_index;
          $author_names{$author_index} = $author;
          $a_com_count{$author_index} = 1;
          $a_tot_count{$author_index} = 1;
        }
      }
    }

    # Now count:

    $len = length($line);
    $total_char_count += $len;

    if ( $reading_C_comment ) {
      $pos = index($line, "*/");
      if ( $pos >= 0 ) {
        $reading_C_comment = 0;
        $C_comment_char_count += $pos + 2;
      } else {
        $C_comment_char_count += $len;
      }
    } else {

      # Decide whether $line contains a comment:

      $pos = index($line, "/*");
      if ( $pos >= 0 ) {
        $reading_C_comment = 1;
        $C_comment_char_count += $len - $pos;
      } else {
        if ( $sharp_p ) {
          $pos = index($line, "#");
        } else {
          $pos = index($line, "//");
        }
        if ( $pos >= 0 ) {
          $Cpp_comment_char_count += $len - $pos;
        }
      }
    }
  }

  if ( !$did_author && $author_indices{"anonymous"} == 0 ) {
    $author_indices{"anonymous"} = ++$author_index;
    $author_names{$author_index} = "anonymous";
    $a_com_count{$author_index} = 1;
    $a_tot_count{$author_index} = 1;
  }

  $total = $total_char_count - $C_comment_char_count;
  if ( $total != 0 ) {
    $ratio = int( 100 * $Cpp_comment_char_count / $total );
  } else { $ratio = 0; }
  if ( !$summary_p ) { print "ratio: $ratio%\n"; }

  # Don't count largely codeless files in summary:

  if ( $ratio < 80 ) {
    foreach $author (@authors) {
      $i = $author_indices{$author};
      $a_com_count{$i} += $Cpp_comment_char_count;
      $a_tot_count{$i} += $total;
    }
  }

  close(FILE);
}
close(FIND);

print "\n\nSummary by author:\n\n";

$i = 1;
while ( $i <= $author_index ) {
  if ( $a_tot_count{$i} != 0 ) {
    $ratio = int(100 * $a_com_count{$i} / $a_tot_count{$i});
  } else { $ratio = 0; }
  print " $ratio%  $author_names{$i}\n";
  ++$i;
}
print "\n\n";
exit;

sub help {
  print "\nThis computes the ratio of comment characters to all characters,\n";
  print "ignoring /*...*/, in all source, header, and Makefiles at and\n";
  print "below the current directory.\n";
  print "Command line options:\n";
  print "-s      toggles summary mode. Default: $summary_p\n";
  print "-h\n";
  print "--help  prints this and quits\n\n";
}