contrib/mklog

   1 #!/usr/bin/perl
   2 # Copyright (C) 2012 Free Software Foundation, Inc.
   3 #
   4 # This file is part of GCC.
   5 #
   6 # GCC is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3, or (at your option)
   9 # any later version.
  10 #
  11 # GCC is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with GCC; see the file COPYING.  If not, write to
  18 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  19 # Boston, MA 02110-1301, USA.
  20
  21 # This script parses a .diff file generated with 'diff -up' or 'diff -cp'
  22 # and writes a skeleton ChangeLog file to stdout. It does not try to be
  23 # very smart when parsing function names, but it produces a reasonable
  24 # approximation.
  25 #
  26 # Author: Diego Novillo <dnovillo@google.com> and
  27 #         Cary Coutant <ccoutant@google.com>
  28
  29 # Change these settings to reflect your profile.
  30 $username = $ENV{'USER'};
  31 $name = `finger $username | grep -o 'Name: .*'`;
  32 @n = split(/: /, $name);
  33 $name = @n[1]; chop($name);
  34 $addr = $username . "\@my.domain.org";
  35 $date = `date +%Y-%m-%d`; chop ($date);
  36
  37 $gcc_root = $0;
  38 $gcc_root =~ s/[^\\\/]+$/../;
  39 chdir $gcc_root;
  40
  41
  42 #-----------------------------------------------------------------------------
  43 # Program starts here. You should not need to edit anything below this
  44 # line.
  45 #-----------------------------------------------------------------------------
  46 if ($#ARGV != 0) {
  47     $prog = `basename $0`; chop ($prog);
  48     print "usage: $prog file.diff\n\n";
  49     print "Adds a ChangeLog template to the start of file.diff\n";
  50     print "It assumes that file.diff has been created with -up or -cp.\n";
  51     exit 1;
  52 }
  53
  54 $diff = $ARGV[0];
  55 $dir = `dirname $diff`; chop ($dir);
  56 $basename = `basename $diff`; chop ($basename);
  57 $hdrline = "$date  $name  <$addr>";
  58
  59 sub get_clname ($) {
  60         return ('ChangeLog', $_[0]) if ($_[0] !~ /[\/\\]/);
  61
  62         my $dirname = $_[0];
  63         while ($dirname) {
  64                 my $clname = "$dirname/ChangeLog";
  65                 if (-f $clname) {
  66                         my $relname = substr ($_[0], length ($dirname) + 1);
  67                         return ($clname, $relname);
  68                 } else {
  69                         $dirname =~ s/[\/\\]?[^\/\\]*$//;
  70                 }
  71         }
  72
  73         return ('Unknown ChangeLog', $_[0]);
  74 }
  75
  76 sub remove_suffixes ($) {
  77         my $filename = $_[0];
  78         $filename =~ s/^[ab]\///;
  79         $filename =~ s/\.jj$//;
  80         return $filename;
  81 }
  82
  83 # For every file in the .diff print all the function names in ChangeLog
  84 # format.
  85 %cl_entries = ();
  86 $change_msg = undef;
  87 $look_for_funs = 0;
  88 $clname = get_clname('');
  89 open (DFILE, $diff) or die "Could not open file $diff for reading";
  90 while (<DFILE>) {
  91     # Stop processing functions if we found a new file
  92         # Remember both left and right names because one may be /dev/null.
  93     if (/^[+*][+*][+*] +(\S+)/) {
  94                 $left = remove_suffixes ($1);
  95                 $look_for_funs = 0;
  96         }
  97     if (/^--- +(\S+)?/) {
  98                 $right = remove_suffixes ($1);
  99                 $look_for_funs = 0;
 100         }
 101
 102         # Check if the body of diff started.
 103         # We should now have both left and right name,
 104         # so we can decide filename.
 105
 106     if ($left && (/^\*{15}$/ || /^@@ /)) {
 107         # If we have not seen any function names in the previous file (ie,
 108         # $change_msg is empty), we just write out a ':' before starting the next
 109         # file.
 110         if ($clname) {
 111                 $cl_entries{$clname} .= $change_msg ? "$change_msg" : ":\n";
 112         }
 113
 114         if ($left eq $right) {
 115                 $filename = $left;
 116         } elsif($left eq '/dev/null') {
 117                 $filename = $right;
 118         } elsif($right eq '/dev/null') {
 119                 $filename = $left;
 120         } else {
 121                 print STDERR "Error: failed to parse diff for $left and $right\n";
 122                 exit 1;
 123         }
 124         $left = $right = undef;
 125         ($clname, $relname) = get_clname ($filename);
 126         $cl_entries{$clname} .= "\t* $relname";
 127         $change_msg = '';
 128         $look_for_funs = $filename =~ '\.(c|cpp|C|cc|h|inc|def)$';
 129     }
 130
 131     # Remember the last line in a unified diff block that might start
 132     # a new function.
 133     if (/^[-+ ]([a-zA-Z0-9_].*)/) {
 134         $save_fn = $1;
 135     }
 136
 137     # Check if file is newly added.
 138     # Two patterns: for context and unified diff.
 139     if (/^\*\*\* 0 \*\*\*\*/
 140         || /^@@ -0,0 \+1.* @@/) {
 141         $change_msg = $filename =~ /testsuite.*(?<!\.exp)$/ ? ": New test.\n" : ": New file.\n";
 142         $look_for_funs = 0;
 143     }
 144
 145     # Check if file was removed.
 146     # Two patterns: for context and unified diff.
 147     if (/^--- 0 ----/
 148         || /^@@ -1.* \+0,0 @@/) {
 149         $change_msg = ": Remove.\n";
 150         $look_for_funs = 0;
 151     }
 152
 153     # If we find a new function, print it in brackets.  Special case if
 154     # this is the first function in a file.
 155     #
 156     # Note that we don't try too hard to find good matches.  This should
 157     # return a superset of the actual set of functions in the .diff file.
 158     #
 159     # The first two patterns work with context diff files (diff -c). The
 160     # third pattern works with unified diff files (diff -u).
 161     #
 162     # The fourth pattern looks for the starts of functions or classes
 163     # within a unified diff block.
 164
 165     if ($look_for_funs
 166         && (/^\*\*\*\*\*\** ([a-zA-Z0-9_].*)/
 167         || /^[\-\+\!] ([a-zA-Z0-9_]+)[ \t]*\(.*/
 168         || /^@@ .* @@ ([a-zA-Z0-9_].*)/
 169         || /^[-+ ](\{)/))
 170       {
 171         $_ = $1;
 172         my $fn;
 173         if (/^\{/) {
 174             # Beginning of a new function.
 175             $_ = $save_fn;
 176         } else {
 177             $save_fn = "";
 178         }
 179         if (/;$/) {
 180             # No usable function name found.
 181         } elsif (/^((class|struct|union|enum) [a-zA-Z0-9_]+)/) {
 182             # Discard stuff after the class/struct/etc. tag.
 183             $fn = $1;
 184         } elsif (/([a-zA-Z0-9_][^(]*)\(/) {
 185             # Discard template and function parameters.
 186             $fn = $1;
 187             1 while ($fn =~ s/<[^<>]*>//);
 188             $fn =~ s/[ \t]*$//;
 189         }
 190         if ($fn && $seen_names{$fn} == 0) {
 191             # If this is the first function in the file, we display it next
 192             # to the filename, so we need an extra space before the opening
 193             # brace.
 194             if (!$change_msg) {
 195                 $change_msg .= " ";
 196             } else {
 197                 $change_msg .= "\t";
 198             }
 199
 200                 $change_msg .= "($fn):\n";
 201             $seen_names{$fn} = 1;
 202         }
 203     }
 204 }
 205
 206 close (DFILE);
 207
 208 # If we have not seen any function names (ie, $change_msg is empty), we just
 209 # write out a ':'. This happens when there is only one file with no
 210 # functions.
 211 $cl_entries{$clname} .= $change_msg ? ": $change_msg\n" : ":\n";
 212
 213 $temp = `mktemp /tmp/$basename.XXXXXX` || exit 1; chop ($temp);
 214 open (CLFILE, ">$temp") or die "Could not open file $temp for writing";
 215
 216 foreach my $clname (keys %cl_entries) {
 217         print CLFILE "$clname:\n\n$hdrline\n\n$cl_entries{$clname}\n";
 218 }
 219
 220 # Concatenate the ChangeLog template and the original .diff file.
 221 system ("cat $diff >>$temp && mv $temp $diff") == 0
 222     or die "Could not add the ChangeLog entry to $diff";
 223
 224 exit 0;