get-authors: Exclude common source code patterns. (#2900)

[cvc5.git] / contrib / update-copyright.pl

diff --git a/contrib/update-copyright.pl b/contrib/update-copyright.pl
index f7ce15f6c7bd6c63c34a9bec150dd17c9e5b86c7..3412905af99c785e93cf3dc7d606361318b2d8a0 100755 (executable)
--- a/contrib/update-copyright.pl
+++ b/contrib/update-copyright.pl
@@ -1,8 +1,7 @@
 #!/usr/bin/perl -w
 #
 # update-copyright.pl
-# Morgan Deters <mdeters@cs.nyu.edu> for CVC4
-# Copyright (c) 2009-2013  The CVC4 Project
+# Copyright (c) 2009-2018  The CVC4 Project
 #
 # usage: update-copyright [-m] [files/directories...]
 #        update-copyright [-h | --help]
@@ -34,25 +33,28 @@
 # the license.)
 #
 
-my $excluded_directories = '^(minisat|bvminisat|CVS|generated)$';
-my $excluded_paths = '^(src/parser/antlr_input_imports.cpp|src/bindings/compat/.*)$';
+my $excluded_directories = '^(CVS|generated)$';
+my $excluded_paths = '^(';
+# note: first excluded path regexp must not start with a '|'
+# different license
+$excluded_paths .= 'src/util/channel.h';
+# minisat license
+$excluded_paths .= '|src/prop/(bv)?minisat/core/.*';
+$excluded_paths .= '|src/prop/(bv)?minisat/mtl/.*';
+$excluded_paths .= '|src/prop/(bv)?minisat/simp/.*';
+$excluded_paths .= '|src/prop/(bv)?minisat/utils/.*';
+$excluded_paths .= ')$';
 
 # Years of copyright for the template.  E.g., the string
 # "1985, 1987, 1992, 1997, 2008" or "2006-2009" or whatever.
-my $years = '2009-2013';
+my $years = '2009-2018';
 
 my $standard_template = <<EOF;
  ** This file is part of the CVC4 project.
- ** Copyright (c) $years  New York University and The University of Iowa
- ** See the file COPYING in the top-level source directory for licensing
- ** information.\\endverbatim
-EOF
-
-my $public_template = <<EOF;
- ** This file is part of the CVC4 project.
- ** Copyright (c) $years  New York University and The University of Iowa
- ** See the file COPYING in the top-level source directory for licensing
- ** information.\\endverbatim
+ ** Copyright (c) $years by the authors listed in the file AUTHORS
+ ** in the top-level source directory) and their institutional affiliations.
+ ** All rights reserved.  See the file COPYING in the top-level source
+ ** directory for licensing information.\\endverbatim
 EOF
 
 ## end config ##
@@ -63,7 +65,7 @@ use Fcntl ':mode';
 my $dir = $0;
 $dir =~ s,/[^/]+/*$,,;
 
-if($#ARGV >= 0 && $ARGV[0] eq '-h' || $ARGV[0] eq '--help') {
+if($#ARGV >= 0 && ($ARGV[0] eq '-h' || $ARGV[0] eq '--help')) {
   open(my $SELF, $0) || die "error opening $0 for reading";
   while($_ = <$SELF>) {
     last if !/^#/;
@@ -114,6 +116,7 @@ print "Updating sources...\n";
 
 while($#searchdirs >= 0) {
   my $dir = shift @searchdirs;
+  $dir =~ s,\/$,,;              # remove trailing slash from directory
   my $mode = (stat($dir))[2] || warn "file or directory \`$dir' does not exist!";
   my $is_directory = S_ISDIR($mode);
   if($is_directory) {
@@ -142,12 +145,10 @@ sub handleFile {
   open(my $IN, $infile) || die "error opening $infile for reading";
   open(my $OUT, '>', $outfile) || die "error opening $outfile for writing";
   open(my $AUTHOR, "$dir/get-authors " . $infile . '|');
-  my $author = <$AUTHOR>; chomp $author;
-  my $major_contributors = <$AUTHOR>; chomp $major_contributors;
-  my $minor_contributors = <$AUTHOR>; chomp $minor_contributors;
+  my $authors = <$AUTHOR>; chomp $authors;
   close $AUTHOR;
   $_ = <$IN>;
-  if(m,^(%{)?/\*(\*| )\*\*\*,) {
+  if(m,^(%\{)?/\*(\*| )\*\*\*,) {
     print "updating\n";
     if($file =~ /\.(y|yy|ypp|Y)$/) {
       print $OUT "%{/*******************                                                        */\n";
@@ -161,20 +162,27 @@ sub handleFile {
       print $OUT "/*! \\file $file\n";
     }
     print $OUT " ** \\verbatim\n";
-    print $OUT " ** Original author: $author\n";
-    print $OUT " ** Major contributors: $major_contributors\n";
-    print $OUT " ** Minor contributors (to current version): $minor_contributors\n";
-    print $OUT $standard_template;
-    print $OUT " **\n";
+    print $OUT " ** Top contributors (to current version):\n";
+    print $OUT " **   $authors\n";
+    my $comment_stub = "";
     while(my $line = <$IN>) {
+      if($line =~ /\b[Cc]opyright\b/ && $line !~ /\bby the authors listed in the file AUTHORS\b/) {
+        # someone else holds this copyright
+        print $OUT $line;
+      }
       last if $line =~ /^ \*\*\s*$/;
       if($line =~ /\*\//) {
-        print $OUT " ** [[ Add lengthier description here ]]\n";
-        print $OUT " ** \\todo document this file\n";
-        print $OUT $line;
+        $comment_stub = " ** [[ Add lengthier description here ]]\n\
+ ** \\todo document this file\n\
+$line";
         last;
       }
     }
+    print $OUT $standard_template;
+    print $OUT " **\n";
+    if($comment_stub) {
+      print $OUT $comment_stub;
+    }
   } else {
     my $line = $_;
     print "adding\n";
@@ -190,9 +198,8 @@ sub handleFile {
       print $OUT "/*! \\file $file\n";
     }
     print $OUT " ** \\verbatim\n";
-    print $OUT " ** Original author: $author\n";
-    print $OUT " ** Major contributors: $major_contributors\n";
-    print $OUT " ** Minor contributors (to current version): $minor_contributors\n";
+    print $OUT " ** Top contributors (to current version):\n";
+    print $OUT " **   $authors\n";
     print $OUT $standard_template;
     print $OUT " **\n";
     print $OUT " ** \\brief [[ Add one-line brief description here ]]\n";
@@ -204,7 +211,7 @@ sub handleFile {
     if($file =~ /\.(y|yy|ypp|Y)$/) {
       while(my $line = <$IN>) {
         chomp $line;
-        if($line =~ '\s*%{(.*)') {
+        if($line =~ '\s*%\{(.*)') {
           print $OUT "$1\n";
           last;
         }