1 #!/usr/bin/perl -0777 -pi
2 # Update an FSF copyright year list to include the current year.
4 my $VERSION = '2009-08-14.05:03'; # UTC
6 # Copyright (C) 2009 Free Software Foundation, Inc.
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3, or (at your option)
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 # Written by Jim Meyering and Joel E. Denny
23 # The arguments to this script should be names of files that contain FSF
24 # copyright statements to be updated. For example, you might wish to
25 # use the update-copyright target rule in maint.mk from gnulib's
26 # maintainer-makefile module.
28 # Iff an FSF copyright statement is discovered in a file and the final
29 # year is not the current year, then the statement is updated for the
30 # new year, 2-digit years are converted to 4-digit years by prepending
31 # "19", and the statement is reformatted to fit within 72 columns. A
32 # warning is printed for every file for which no FSF copyright statement
35 # Each file's FSF copyright statement must be formated correctly in
36 # order to be recognized. For example, each of these is fine:
38 # Copyright @copyright{} 1990-2005, 2007-2009 Free Software
41 # # Copyright (C) 1990-2005, 2007-2009 Free Software
45 # * Copyright © 90,2005,2007-2009
46 # * Free Software Foundation, Inc.
49 # However, the following format is not recognized because the line
50 # prefix changes after the first line:
52 # ## Copyright (C) 1990-2005, 2007-2009 Free Software
55 # The following copyright statement is not recognized because the
56 # copyright holder is not the FSF:
58 # Copyright (C) 1990-2005, 2007-2009 Acme, Inc.
60 # However, any correctly formatted FSF copyright statement following
61 # either of the previous two copyright statements would be recognized.
63 # The exact conditions that a file's FSF copyright statement must meet
64 # to be recognized are:
66 # 1. It is the first FSF copyright statement that meets all of the
67 # following conditions. Subsequent FSF copyright statements are
69 # 2. Its format is "Copyright (C)", then a list of copyright years,
70 # and then the name of the copyright holder, which is "Free
71 # Software Foundation, Inc.".
72 # 3. The "(C)" takes one of the following forms or is omitted
80 # 4. The "Copyright" appears at the beginning of a line except that it
81 # may be prefixed by any sequence (e.g., a comment) of no more than
83 # 5. Iff such a prefix is present, the same prefix appears at the
84 # beginning of each remaining line within the FSF copyright
85 # statement. There is one exception in order to support C-style
86 # comments: if the first line's prefix contains nothing but
87 # whitespace surrounding a "/*", then the prefix for all subsequent
88 # lines is the same as the first line's prefix except with each of
89 # "/" and possibly "*" replaced by a " ". The replacement of "*"
90 # by " " is consistent throughout all subsequent lines.
91 # 6. Blank lines, even if preceded by the prefix, do not appear
92 # within the FSF copyright statement.
93 # 7. Each copyright year is 2 or 4 digits, and years are separated by
94 # commas or dashes. Whitespace may occur after commas.
96 # Environment variables:
98 # 1. If UPDATE_COPYRIGHT_USE_INTERVALS=1, every series of consecutive
99 # copyright years (such as 90, 1991, 1992-2007, 2008) in an updated
100 # FSF copyright statement is collapsed to a single interval (such
101 # as 1990-2008). If unset or set to 0, all existing copyright year
102 # intervals are expanded.
103 # 2. For testing purposes, you can set the assumed current year in
104 # UPDATE_COPYRIGHT_YEAR.
109 my $copyright_re = 'Copyright';
110 my $circle_c_re = '(?:\([cC]\)|@copyright{}|©)';
111 my $holder = 'Free Software Foundation, Inc.';
116 my $this_year = $ENV{UPDATE_COPYRIGHT_YEAR};
117 if (!$this_year || $this_year !~ m/^\d{4}$/)
119 my ($sec, $min, $hour, $mday, $month, $year) = localtime (time ());
120 $this_year = $year + 1900;
123 # Unless the file consistently uses "\r\n" as the EOL, use "\n" instead.
124 my $eol = /(?:^|[^\r])\n/ ? "\n" : "\r\n";
130 while (/(^|\n)(.{0,$prefix_max})$copyright_re/g)
134 if ($prefix =~ /^(\s*\/)\*(\s*)$/)
137 my $prefix_ws = $prefix;
138 $prefix_ws =~ s/\*/ /; # Only whitespace.
139 if (/\G(?:[^*\n]|\*[^\/\n])*\*?\n$prefix_ws/)
141 $prefix = $prefix_ws;
144 $ws_re = '[ \t\r\f]'; # \s without \n
146 "(?:$ws_re*(?:$ws_re|\\n" . quotemeta($prefix) . ")$ws_re*)";
147 my $holder_re = $holder;
148 $holder_re =~ s/\s/$ws_re/g;
149 my $stmt_remainder_re =
150 "(?:$ws_re$circle_c_re)?"
151 . "$ws_re(?:(?:\\d\\d)?\\d\\d(?:,$ws_re?|-))*"
152 . "((?:\\d\\d)?\\d\\d)$ws_re$holder_re";
153 if (/\G$stmt_remainder_re/)
156 quotemeta($leading) . "($copyright_re$stmt_remainder_re)";
160 if (defined $stmt_re)
162 /$stmt_re/ or die; # Should never die.
164 my $final_year_orig = $2;
166 # Handle two-digit year numbers like "98" and "99".
167 my $final_year = $final_year_orig;
169 and $final_year += 1900;
171 if ($final_year != $this_year)
174 $stmt =~ s/$final_year_orig/$final_year, $this_year/;
176 # Normalize all whitespace including newline-prefix sequences.
177 $stmt =~ s/$ws_re/ /g;
179 # Put spaces after commas.
182 # Convert 2-digit to 4-digit years.
183 $stmt =~ s/(\b\d\d\b)/19$1/g;
185 # Make the use of intervals consistent.
186 if (!$ENV{UPDATE_COPYRIGHT_USE_INTERVALS})
188 $stmt =~ s/(\d{4})-(\d{4})/join(', ', $1..$2)/eg;
198 if ($2 eq '-') { '\d{4}'; }
199 elsif (!$3) { $1 + 1; }
206 # Format within margin.
208 my $text_margin = $margin - length($prefix);
209 if ($prefix =~ /^(\t+)/)
211 $text_margin -= length($1) * ($tab_width - 1);
215 if (($stmt =~ s/^(.{1,$text_margin})(?: |$)//)
216 || ($stmt =~ s/^([\S]+)(?: |$)//))
219 $stmt_wrapped .= $stmt_wrapped ? "$eol$prefix" : $leading;
220 $stmt_wrapped .= $line;
224 # Should be unreachable, but we don't want an infinite
225 # loop if it can be reached.
230 # Replace the old copyright statement.
231 s/$stmt_re/$stmt_wrapped/;
236 print STDERR "$ARGV: warning: FSF copyright statement not found\n";
240 # indent-tabs-mode: nil
241 # eval: (add-hook 'write-file-hooks 'time-stamp)
242 # time-stamp-start: "my $VERSION = '"
243 # time-stamp-format: "%:y-%02m-%02d.%02H:%02M"
244 # time-stamp-time-zone: "UTC"
245 # time-stamp-end: "'; # UTC"