lib-src/grep-changelog

   1 #! /usr/bin/perl
   2
   3 # Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
   4 #
   5 # This file is part of GNU Emacs.
   6 #
   7 # GNU Emacs is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2, or (at your option)
  10 # any later version.
  11 #
  12 # GNU Emacs is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with GNU Emacs; see the file COPYING.  If not, write to the
  19 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 # Boston, MA 02111-1307, USA.
  21
  22
  23 # Extract entries from ChangeLogs matching specified criteria.
  24 # Optionally format the resulting output to a form suitable for RCS
  25 # logs, like they are used in Emacs, for example.  In this format,
  26 # author lines, leading spaces, and file names are removed.
  27
  28 require 5;
  29 use strict;
  30
  31 # Parse command line options.
  32
  33 use vars qw($author $regexp $exclude $from_date $to_date
  34             $rcs_log $with_date $version $help $reverse
  35             @entries);
  36
  37 use Getopt::Long;
  38 my $result = GetOptions ("author=s" => \$author,
  39                          "text=s"  => \$regexp,
  40                          "exclude=s"  => \$exclude,
  41                          "from-date=s" => \$from_date,
  42                          "to-date=s" => \$to_date,
  43                          "rcs-log" => \$rcs_log,
  44                          "with-date" => \$with_date,
  45                          "reverse!" => \$reverse,
  46                          "version" => \$version,
  47                          "help"    => \$help);
  48
  49 # If date options are specified, check that they have the format
  50 # YYYY-MM-DD.
  51
  52 $result = 0 if $from_date && $from_date !~ /^\d\d\d\d-\d\d-\d\d$/;
  53 $result = 0 if $to_date && $to_date !~ /^\d\d\d\d-\d\d-\d\d$/;
  54
  55 # Print usage information and exit when necessary.
  56
  57 if ($result == 0 || $help) {
  58     print <<USAGE;
  59 Usage: $0 [options] [CHANGELOG...]
  60 Print entries in ChangeLogs matching various criteria.  Valid options
  61 are
  62
  63   --author=AUTHOR         match entries whose author line matches
  64                           regular expression AUTHOR
  65   --text=TEXT             match entries whose text matches regular
  66                           expression TEXT.
  67   --exclude=TEXT          exclude entries matching TEXT.
  68   --from-date=YYYY-MM-DD  match entries not older than given date
  69   --to-date=YYYY-MM-DD    match entries not younger than given date
  70   --rcs-log               format output suitable for RCS log entries.
  71   --with-date             print short date line in RCS log
  72   --reverse               show entries in reverse (chronological) order
  73   --version               print version info
  74   --help                  print this help
  75
  76 If no CHANGELOG is specified scan the files "ChangeLog" and
  77 "ChangeLog.[9-1]" in the current directory.  Old-style dates in ChangeLogs
  78 are not recognized.
  79 USAGE
  80     exit $help ? 0 : 1;
  81 }
  82
  83 # Print version info and exit if `--version' was specified.
  84
  85 if ($version) {
  86     print "0.1\n";
  87     exit 0;
  88 }
  89
  90
  91 # Value is non-zero if HEADER matches according to command line
  92 # options specified, i.e. it matches $author, and its date is in
  93 # the range $from_date <= date <= $to_date.
  94
  95 sub header_match_p ($) {
  96     my $header = shift;
  97
  98     return 0 unless $header;
  99
 100     # No match if AUTHOR-regexp specified and doesn't match.
 101     return 0 if $author && $header !~ /$author/;
 102
 103     # Check that the date of the entry matches if date options
 104     # `--from-date' and/or `--to-date' were specified .  Old-style
 105     # dates in ChangeLogs are not recognized, and never match.
 106     if ($from_date || $to_date) {
 107         if ($header =~ /^(\d\d\d\d-\d\d-\d\d)/) {
 108             my $date = $1;
 109             return 0 if $from_date && $date lt $from_date;
 110             return 0 if $to_date && $date gt $to_date;
 111         } else {
 112             # Don't bother recognizing old-style dates.
 113             return 0;
 114         }
 115     }
 116
 117     return 1;
 118 }
 119
 120
 121 # Value is non-zero if ENTRY matches the criteria specified on the
 122 # command line, i.e. it matches $regexp, and it doesn't match
 123 # $exclude.
 124
 125 sub entry_match_p ($) {
 126     my $entry = shift;
 127
 128     return 0 unless $entry;
 129
 130     if ($regexp) {
 131         return 1 if ($entry =~ /$regexp/
 132                      && (!$exclude || $entry !~ $exclude));
 133     } else {
 134         return 1 if !$exclude || $entry !~ $exclude;
 135     }
 136
 137     return 0;
 138 }
 139
 140
 141 # Print HEADER and/or ENTRY in a format suitable for what was
 142 # specified on the command line.  If $rcs_log is specified, author
 143 # lines are not printed, and leading spaces and file names are removed
 144 # from ChangeLog entries.
 145
 146 sub print_log ($$) {
 147     my ($header, $entry) = @_;
 148     my $output = '';
 149
 150     if ($rcs_log) {
 151         # Remove leading whitespace from entry.
 152         $entry =~ s/^\s+//mg;
 153         # Remove file name parts.
 154         $entry =~ s/^\*.*\(/(/mg;
 155         # Remove file name parts, 2.
 156         $entry =~ s/^\*.*://mg;
 157         if ($with_date) {
 158             $header =~ /(\d\d\d\d-\d\d-\d\d)/;
 159             $output = "!changelog-date $1\n";
 160         }
 161         $output .= $entry;
 162     } else {
 163         $output .= $header . $entry;
 164     }
 165
 166     if ($reverse) {
 167         push @entries, $output;
 168     } else {
 169         print $output;
 170     }
 171 }
 172
 173 # Scan LOG for matching entries, and print them to standard output.
 174
 175 sub parse_changelog ($) {
 176     my $log = shift;
 177     my $entry = undef;
 178     my $header = undef;
 179
 180     @entries = () if $reverse;
 181
 182     # Open the ChangeLog.
 183     open (IN, "< $log") || die "Cannot open $log: $!";
 184
 185     while (defined(my $line = <IN>)) {
 186         if ($line =~ /^\S/) {
 187             # Line is an author-line.  Print previous entry if
 188             # it matches.
 189             print_log ($header, $entry)
 190                 if header_match_p ($header) && entry_match_p ($entry);
 191
 192             $entry = "";
 193             $header = $line;
 194
 195             # Add empty lines below the header.
 196             while (defined($line = <IN>) && $line =~ /^\s*$/) {
 197                 $header = "$header$line";
 198             }
 199         }
 200
 201         last unless defined $line;
 202
 203         if ($line =~ /^\s*\*/) {
 204             # LINE is the first line of a ChangeLog entry.  Print
 205             # previous entry if it matches.
 206             print_log ($header, $entry)
 207                 if header_match_p ($header) && entry_match_p ($entry);
 208             $entry = $line;
 209         } else {
 210             # Add LINE to the current entry.
 211             $entry = "$entry$line";
 212         }
 213     }
 214
 215     # Print last entry if it matches.
 216     print_log ($header, $entry)
 217         if header_match_p ($header) && entry_match_p ($entry);
 218
 219     close IN;
 220
 221     if ($reverse) {
 222         while (defined (my $entry = pop @entries)) {
 223             print $entry;
 224         }
 225     }
 226 }
 227
 228
 229 # Main program.  Process ChangeLogs.
 230
 231 # If files were specified on the command line, parse those files in the
 232 # order supplied by the user; otherwise parse default files ChangeLog and
 233 # ChangeLog.9...ChangeLog.1 according to $reverse.
 234 unless (@ARGV > 0) {
 235     @ARGV = ("ChangeLog", map {"ChangeLog.$_"} reverse 1..9);
 236     @ARGV = reverse @ARGV if $reverse;
 237 }
 238
 239 while (defined (my $log = shift @ARGV)) {
 240     parse_changelog ($log) if -f $log;
 241 }
 242
 243
 244 # grep-changelog ends here.