summaryrefslogtreecommitdiff
path: root/contrib/update-copyright.pl
blob: dce4533464a1b90b63d60d5d4546e07d3f40325a (plain)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
#!/usr/bin/perl -w
#
# update-copyright.pl
# Morgan Deters <mdeters@cs.nyu.edu> for CVC4
# Copyright (c) 2009, 2010  The CVC4 Project
#
# usage: update-copyright [ files/directories... ]
#
# This script goes through a source directory rewriting the top bits of
# source files to match a template (inline, below).  For files with no
# top comment, it adds a fresh one.
#
# usage: contrib/update-copyright.pl [dirs...]
# if dirs... are unspecified, the script scans its own parent directory's
# "src" directory.  Since it lives in contrib/ in the CVC4 source tree,
# that means src/ in the CVC4 source tree.
#
# It ignores any file/directory not starting with [a-zA-Z]
# (so, this includes . and .., vi swaps, .svn meta-info,
# .deps, etc.)
#
# It ignores any file not ending with one of:
#   .c .cc .cpp .C .h .hh .hpp .H .y .yy .ypp .Y .l .ll .lpp .L .g
# (so, this includes emacs ~-backups, CVS detritus, etc.)
#
# It ignores any directory matching $excluded_directories
# (so, you should add here any sources imported but not covered under
# the license.)

my $excluded_directories = '^(minisat|CVS|generated)$';
my $excluded_paths = '^(src/parser/bounded_token_buffer\.(h|cpp))|(src/parser/antlr_input_imports.cpp)$';

# Years of copyright for the template.  E.g., the string
# "1985, 1987, 1992, 1997, 2008" or "2006-2009" or whatever.
my $years = '2009, 2010';

my $standard_template = <<EOF;
 ** This file is part of the CVC4 prototype.
 ** Copyright (c) $years  The Analysis of Computer Systems Group (ACSys)
 ** Courant Institute of Mathematical Sciences
 ** New York University
 ** See the file COPYING in the top-level source directory for licensing
 ** information.
EOF

my $public_template = <<EOF;
 ** This file is part of the CVC4 prototype.
 ** Copyright (c) $years  The Analysis of Computer Systems Group (ACSys)
 ** Courant Institute of Mathematical Sciences
 ** New York University
 ** See the file COPYING in the top-level source directory for licensing
 ** information.
EOF

## end config ##

use strict;
use Fcntl ':mode';

my $dir = $0;
$dir =~ s,/[^/]+/*$,,;

my @searchdirs = ();
if($#ARGV == -1) {
  (chdir($dir."/..") && -f "src/include/cvc4_public.h") || die "can't find top-level source directory for CVC4";
  my $pwd = `pwd`; chomp $pwd;

  print <<EOF;
Warning: this script is dangerous.  It will overwrite the header comments in your
source files to match the template in the script, attempting to retain file-specific
comments, but this isn't guaranteed.  You should run this in an svn working directory
and run "svn diff" after to ensure everything was correctly rewritten.

The directories in which to search for and change sources is:
  $pwd/src
  $pwd/test

Continue? y or n:
EOF

  $_ = <STDIN>; chomp;
  die 'aborting operation' if !( $_ eq 'y' || $_ eq 'yes' || $_ eq 'Y' || $_ eq 'YES' );

  $searchdirs[0] = 'src';
  $searchdirs[1] = 'test';
} else {
  @searchdirs = @ARGV;
}

print "Updating sources...\n";

recurse(shift @searchdirs) while $#searchdirs >= 0;

sub recurse {
  my ($srcdir) = @_;
  print "in dir $srcdir\n";
  opendir(my $DIR, $srcdir);
  while(my $file = readdir $DIR) {
    next if !($file =~ /^[a-zA-Z]/);

    my $mode = (stat($srcdir.'/'.$file))[2];
    my $is_directory = S_ISDIR($mode);
    if($is_directory) {
      next if $file =~ /$excluded_directories/;
      recurse($srcdir.'/'.$file);
    } else {
      next if !($file =~ /\.(c|cc|cpp|C|h|hh|hpp|H|y|yy|ypp|Y|l|ll|lpp|L|g)$/);
      next if ($srcdir.'/'.$file) =~ /$excluded_paths/;
      print "$srcdir/$file...";
      my $infile = $srcdir.'/'.$file;
      my $outfile = $srcdir.'/#'.$file.'.tmp';
      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;
      close $AUTHOR;
      $_ = <$IN>;
      if(m,^(%{)?/\*(\*| )\*\*\*,) {
        print "updating\n";
        if($file =~ /\.(y|yy|ypp|Y)$/) {
          print $OUT "%{/*******************                                                        */\n";
          print $OUT "/** $file\n";
        } elsif($file =~ /\.g$/) {
          # avoid javadoc-style comment here; antlr complains
          print $OUT "/* *******************                                                        */\n";
          print $OUT "/*  $file\n";
        } else {
          print $OUT "/*********************                                                        */\n";
          print $OUT "/** $file\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";
        while(my $line = <$IN>) {
          last if $line =~ /^ \*\*\s*$/;
        }
      } else {
        my $line = $_;
        print "adding\n";
        if($file =~ /\.(y|yy|ypp|Y)$/) {
          print $OUT "%{/*******************                                                        */\n";
          print $OUT "/** $file\n";
        } elsif($file =~ /\.g$/) {
          # avoid javadoc-style comment here; antlr complains
          print $OUT "/* *******************                                                        */\n";
          print $OUT "/*  $file\n";
        } else {
          print $OUT "/*********************                                                        */\n";
          print $OUT "/** $file\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 " ** [[ Add file-specific comments here ]]\n";
        print $OUT " **/\n\n";
        print $OUT $line;
        if($file =~ /\.(y|yy|ypp|Y)$/) {
          while(my $line = <$IN>) {
            chomp $line;
            if($line =~ '\s*%{(.*)') {
              print $OUT "$1\n";
              last;
            }
            # just in case something's weird with the file ?
            if(!($line =~ '\s*')) {
              print $OUT "$line\n";
              last;
            }
          }
        }
      }
      while(my $line = <$IN>) {
        print $OUT $line;
      }
      close $IN;
      close $OUT;
      rename($outfile, $infile) || die "can't rename working file \`$outfile' to \`$infile'";
    }
  }
  closedir $DIR;
}

### Local Variables:
### perl-indent-level: 2
### End:
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback