2016-10-17 Andrew Pinski <apinski@cavium.com>
[official-gcc.git] / contrib / update-copyright.py
blobebefa4627c3d84bf4253a9d26fc8e8424f5bc1fb
1 #!/usr/bin/python
3 # Copyright (C) 2013-2016 Free Software Foundation, Inc.
5 # This script is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3, or (at your option)
8 # any later version.
10 # This script adjusts the copyright notices at the top of source files
11 # so that they have the form:
13 # Copyright XXXX-YYYY Free Software Foundation, Inc.
15 # It doesn't change code that is known to be maintained elsewhere or
16 # that carries a non-FSF copyright.
18 # The script also doesn't change testsuite files, except those in
19 # libstdc++-v3. This is because libstdc++-v3 has a conformance testsuite,
20 # while most tests in other directories are just things that failed at some
21 # point in the past.
23 # Pass --this-year to the script if you want it to add the current year
24 # to all applicable notices. Pass --quilt if you are using quilt and
25 # want files to be added to the quilt before being changed.
27 # By default the script will update all directories for which the
28 # output has been vetted. You can instead pass the names of individual
29 # directories, including those that haven't been approved. So:
31 # update-copyright.pl --this-year
33 # is the command that would be used at the beginning of a year to update
34 # all copyright notices (and possibly at other times to check whether
35 # new files have been added with old years). On the other hand:
37 # update-copyright.pl --this-year libjava
39 # would run the script on just libjava/.
41 # Note that things like --version output strings must be updated before
42 # this script is run. There's already a separate procedure for that.
44 import os
45 import re
46 import sys
47 import time
48 import subprocess
50 class Errors:
51 def __init__ (self):
52 self.num_errors = 0
54 def report (self, filename, string):
55 if filename:
56 string = filename + ': ' + string
57 sys.stderr.write (string + '\n')
58 self.num_errors += 1
60 def ok (self):
61 return self.num_errors == 0
63 class GenericFilter:
64 def __init__ (self):
65 self.skip_files = set()
66 self.skip_dirs = set()
67 self.skip_extensions = set()
68 self.fossilised_files = set()
69 self.own_files = set()
71 self.skip_files |= set ([
72 # Skip licence files.
73 'COPYING',
74 'COPYING.LIB',
75 'COPYING3',
76 'COPYING3.LIB',
77 'LICENSE',
78 'fdl.texi',
79 'gpl_v3.texi',
80 'fdl-1.3.xml',
81 'gpl-3.0.xml',
83 # Skip auto- and libtool-related files
84 'aclocal.m4',
85 'compile',
86 'config.guess',
87 'config.sub',
88 'depcomp',
89 'install-sh',
90 'libtool.m4',
91 'ltmain.sh',
92 'ltoptions.m4',
93 'ltsugar.m4',
94 'ltversion.m4',
95 'lt~obsolete.m4',
96 'missing',
97 'mkdep',
98 'mkinstalldirs',
99 'move-if-change',
100 'shlibpath.m4',
101 'symlink-tree',
102 'ylwrap',
104 # Skip FSF mission statement, etc.
105 'gnu.texi',
106 'funding.texi',
107 'appendix_free.xml',
109 # Skip imported texinfo files.
110 'texinfo.tex',
114 def get_line_filter (self, dir, filename):
115 if filename.startswith ('ChangeLog'):
116 # Ignore references to copyright in changelog entries.
117 return re.compile ('\t')
119 return None
121 def skip_file (self, dir, filename):
122 if filename in self.skip_files:
123 return True
125 (base, extension) = os.path.splitext (os.path.join (dir, filename))
126 if extension in self.skip_extensions:
127 return True
129 if extension == '.in':
130 # Skip .in files produced by automake.
131 if os.path.exists (base + '.am'):
132 return True
134 # Skip files produced by autogen
135 if (os.path.exists (base + '.def')
136 and os.path.exists (base + '.tpl')):
137 return True
139 # Skip configure files produced by autoconf
140 if filename == 'configure':
141 if os.path.exists (base + '.ac'):
142 return True
143 if os.path.exists (base + '.in'):
144 return True
146 return False
148 def skip_dir (self, dir, subdir):
149 return subdir in self.skip_dirs
151 def is_fossilised_file (self, dir, filename):
152 if filename in self.fossilised_files:
153 return True
154 # Only touch current current ChangeLogs.
155 if filename != 'ChangeLog' and filename.find ('ChangeLog') >= 0:
156 return True
157 return False
159 def by_package_author (self, dir, filename):
160 return filename in self.own_files
162 class Copyright:
163 def __init__ (self, errors):
164 self.errors = errors
166 # Characters in a range of years. Include '.' for typos.
167 ranges = '[0-9](?:[-0-9.,\s]|\s+and\s+)*[0-9]'
169 # Non-whitespace characters in a copyright holder's name.
170 name = '[\w.,-]'
172 # Matches one year.
173 self.year_re = re.compile ('[0-9]+')
175 # Matches part of a year or copyright holder.
176 self.continuation_re = re.compile (ranges + '|' + name)
178 # Matches a full copyright notice:
179 self.copyright_re = re.compile (
180 # 1: 'Copyright (C)', etc.
181 '([Cc]opyright'
182 '|[Cc]opyright\s+\([Cc]\)'
183 '|[Cc]opyright\s+%s'
184 '|[Cc]opyright\s+&copy;'
185 '|[Cc]opyright\s+@copyright{}'
186 '|copyright = u\''
187 '|@set\s+copyright[\w-]+)'
189 # 2: the years. Include the whitespace in the year, so that
190 # we can remove any excess.
191 '(\s*(?:' + ranges + ',?'
192 '|@value\{[^{}]*\})\s*)'
194 # 3: 'by ', if used
195 '(by\s+)?'
197 # 4: the copyright holder. Don't allow multiple consecutive
198 # spaces, so that right-margin gloss doesn't get caught
199 # (e.g. gnat_ugn.texi).
200 '(' + name + '(?:\s?' + name + ')*)?')
202 # A regexp for notices that might have slipped by. Just matching
203 # 'copyright' is too noisy, and 'copyright.*[0-9]' falls foul of
204 # HTML header markers, so check for 'copyright' and two digits.
205 self.other_copyright_re = re.compile ('copyright.*[0-9][0-9]',
206 re.IGNORECASE)
207 self.comment_re = re.compile('#+|[*]+|;+|%+|//+|@c |dnl ')
208 self.holders = { '@copying': '@copying' }
209 self.holder_prefixes = set()
211 # True to 'quilt add' files before changing them.
212 self.use_quilt = False
214 # If set, force all notices to include this year.
215 self.max_year = None
217 # Goes after the year(s). Could be ', '.
218 self.separator = ' '
220 def add_package_author (self, holder, canon_form = None):
221 if not canon_form:
222 canon_form = holder
223 self.holders[holder] = canon_form
224 index = holder.find (' ')
225 while index >= 0:
226 self.holder_prefixes.add (holder[:index])
227 index = holder.find (' ', index + 1)
229 def add_external_author (self, holder):
230 self.holders[holder] = None
232 class BadYear():
233 def __init__ (self, year):
234 self.year = year
236 def __str__ (self):
237 return 'unrecognised year: ' + self.year
239 def parse_year (self, string):
240 year = int (string)
241 if len (string) == 2:
242 if year > 70:
243 return year + 1900
244 elif len (string) == 4:
245 return year
246 raise self.BadYear (string)
248 def year_range (self, years):
249 year_list = [self.parse_year (year)
250 for year in self.year_re.findall (years)]
251 assert len (year_list) > 0
252 return (min (year_list), max (year_list))
254 def set_use_quilt (self, use_quilt):
255 self.use_quilt = use_quilt
257 def include_year (self, year):
258 assert not self.max_year
259 self.max_year = year
261 def canonicalise_years (self, dir, filename, filter, years):
262 # Leave texinfo variables alone.
263 if years.startswith ('@value'):
264 return years
266 (min_year, max_year) = self.year_range (years)
268 # Update the upper bound, if enabled.
269 if self.max_year and not filter.is_fossilised_file (dir, filename):
270 max_year = max (max_year, self.max_year)
272 # Use a range.
273 if min_year == max_year:
274 return '%d' % min_year
275 else:
276 return '%d-%d' % (min_year, max_year)
278 def strip_continuation (self, line):
279 line = line.lstrip()
280 match = self.comment_re.match (line)
281 if match:
282 line = line[match.end():].lstrip()
283 return line
285 def is_complete (self, match):
286 holder = match.group (4)
287 return (holder
288 and (holder not in self.holder_prefixes
289 or holder in self.holders))
291 def update_copyright (self, dir, filename, filter, file, line, match):
292 orig_line = line
293 next_line = None
294 pathname = os.path.join (dir, filename)
296 intro = match.group (1)
297 if intro.startswith ('@set'):
298 # Texinfo year variables should always be on one line
299 after_years = line[match.end (2):].strip()
300 if after_years != '':
301 self.errors.report (pathname,
302 'trailing characters in @set: '
303 + after_years)
304 return (False, orig_line, next_line)
305 else:
306 # If it looks like the copyright is incomplete, add the next line.
307 while not self.is_complete (match):
308 try:
309 next_line = file.next()
310 except StopIteration:
311 break
313 # If the next line doesn't look like a proper continuation,
314 # assume that what we've got is complete.
315 continuation = self.strip_continuation (next_line)
316 if not self.continuation_re.match (continuation):
317 break
319 # Merge the lines for matching purposes.
320 orig_line += next_line
321 line = line.rstrip() + ' ' + continuation
322 next_line = None
324 # Rematch with the longer line, at the original position.
325 match = self.copyright_re.match (line, match.start())
326 assert match
328 holder = match.group (4)
330 # Use the filter to test cases where markup is getting in the way.
331 if filter.by_package_author (dir, filename):
332 assert holder not in self.holders
334 elif not holder:
335 self.errors.report (pathname, 'missing copyright holder')
336 return (False, orig_line, next_line)
338 elif holder not in self.holders:
339 self.errors.report (pathname,
340 'unrecognised copyright holder: ' + holder)
341 return (False, orig_line, next_line)
343 else:
344 # See whether the copyright is associated with the package
345 # author.
346 canon_form = self.holders[holder]
347 if not canon_form:
348 return (False, orig_line, next_line)
350 # Make sure the author is given in a consistent way.
351 line = (line[:match.start (4)]
352 + canon_form
353 + line[match.end (4):])
355 # Remove any 'by'
356 line = line[:match.start (3)] + line[match.end (3):]
358 # Update the copyright years.
359 years = match.group (2).strip()
360 try:
361 canon_form = self.canonicalise_years (dir, filename, filter, years)
362 except self.BadYear as e:
363 self.errors.report (pathname, str (e))
364 return (False, orig_line, next_line)
366 line = (line[:match.start (2)]
367 + ('' if intro.startswith ('copyright = ') else ' ')
368 + canon_form + self.separator
369 + line[match.end (2):])
371 # Use the standard (C) form.
372 if intro.endswith ('right'):
373 intro += ' (C)'
374 elif intro.endswith ('(c)'):
375 intro = intro[:-3] + '(C)'
376 line = line[:match.start (1)] + intro + line[match.end (1):]
378 # Strip trailing whitespace
379 line = line.rstrip() + '\n'
381 return (line != orig_line, line, next_line)
383 def process_file (self, dir, filename, filter):
384 pathname = os.path.join (dir, filename)
385 if filename.endswith ('.tmp'):
386 # Looks like something we tried to create before.
387 try:
388 os.remove (pathname)
389 except OSError:
390 pass
391 return
393 lines = []
394 changed = False
395 line_filter = filter.get_line_filter (dir, filename)
396 with open (pathname, 'r') as file:
397 prev = None
398 for line in file:
399 while line:
400 next_line = None
401 # Leave filtered-out lines alone.
402 if not (line_filter and line_filter.match (line)):
403 match = self.copyright_re.search (line)
404 if match:
405 res = self.update_copyright (dir, filename, filter,
406 file, line, match)
407 (this_changed, line, next_line) = res
408 changed = changed or this_changed
410 # Check for copyright lines that might have slipped by.
411 elif self.other_copyright_re.search (line):
412 self.errors.report (pathname,
413 'unrecognised copyright: %s'
414 % line.strip())
415 lines.append (line)
416 line = next_line
418 # If something changed, write the new file out.
419 if changed and self.errors.ok():
420 tmp_pathname = pathname + '.tmp'
421 with open (tmp_pathname, 'w') as file:
422 for line in lines:
423 file.write (line)
424 if self.use_quilt:
425 subprocess.call (['quilt', 'add', pathname])
426 os.rename (tmp_pathname, pathname)
428 def process_tree (self, tree, filter):
429 for (dir, subdirs, filenames) in os.walk (tree):
430 # Don't recurse through directories that should be skipped.
431 for i in xrange (len (subdirs) - 1, -1, -1):
432 if filter.skip_dir (dir, subdirs[i]):
433 del subdirs[i]
435 # Handle the files in this directory.
436 for filename in filenames:
437 if filter.skip_file (dir, filename):
438 sys.stdout.write ('Skipping %s\n'
439 % os.path.join (dir, filename))
440 else:
441 self.process_file (dir, filename, filter)
443 class CmdLine:
444 def __init__ (self, copyright = Copyright):
445 self.errors = Errors()
446 self.copyright = copyright (self.errors)
447 self.dirs = []
448 self.default_dirs = []
449 self.chosen_dirs = []
450 self.option_handlers = dict()
451 self.option_help = []
453 self.add_option ('--help', 'Print this help', self.o_help)
454 self.add_option ('--quilt', '"quilt add" files before changing them',
455 self.o_quilt)
456 self.add_option ('--this-year', 'Add the current year to every notice',
457 self.o_this_year)
459 def add_option (self, name, help, handler):
460 self.option_help.append ((name, help))
461 self.option_handlers[name] = handler
463 def add_dir (self, dir, filter = GenericFilter()):
464 self.dirs.append ((dir, filter))
466 def o_help (self, option = None):
467 sys.stdout.write ('Usage: %s [options] dir1 dir2...\n\n'
468 'Options:\n' % sys.argv[0])
469 format = '%-15s %s\n'
470 for (what, help) in self.option_help:
471 sys.stdout.write (format % (what, help))
472 sys.stdout.write ('\nDirectories:\n')
474 format = '%-25s'
475 i = 0
476 for (dir, filter) in self.dirs:
477 i += 1
478 if i % 3 == 0 or i == len (self.dirs):
479 sys.stdout.write (dir + '\n')
480 else:
481 sys.stdout.write (format % dir)
482 sys.exit (0)
484 def o_quilt (self, option):
485 self.copyright.set_use_quilt (True)
487 def o_this_year (self, option):
488 self.copyright.include_year (time.localtime().tm_year)
490 def main (self):
491 for arg in sys.argv[1:]:
492 if arg[:1] != '-':
493 self.chosen_dirs.append (arg)
494 elif arg in self.option_handlers:
495 self.option_handlers[arg] (arg)
496 else:
497 self.errors.report (None, 'unrecognised option: ' + arg)
498 if self.errors.ok():
499 if len (self.chosen_dirs) == 0:
500 self.chosen_dirs = self.default_dirs
501 if len (self.chosen_dirs) == 0:
502 self.o_help()
503 else:
504 for chosen_dir in self.chosen_dirs:
505 canon_dir = os.path.join (chosen_dir, '')
506 count = 0
507 for (dir, filter) in self.dirs:
508 if (dir + os.sep).startswith (canon_dir):
509 count += 1
510 self.copyright.process_tree (dir, filter)
511 if count == 0:
512 self.errors.report (None, 'unrecognised directory: '
513 + chosen_dir)
514 sys.exit (0 if self.errors.ok() else 1)
516 #----------------------------------------------------------------------------
518 class TopLevelFilter (GenericFilter):
519 def skip_dir (self, dir, subdir):
520 return True
522 class ConfigFilter (GenericFilter):
523 def __init__ (self):
524 GenericFilter.__init__ (self)
526 def skip_file (self, dir, filename):
527 if filename.endswith ('.m4'):
528 pathname = os.path.join (dir, filename)
529 with open (pathname) as file:
530 # Skip files imported from gettext.
531 if file.readline().find ('gettext-') >= 0:
532 return True
533 return GenericFilter.skip_file (self, dir, filename)
535 class GCCFilter (GenericFilter):
536 def __init__ (self):
537 GenericFilter.__init__ (self)
539 self.skip_files |= set ([
540 # Not part of GCC
541 'math-68881.h',
544 self.skip_dirs |= set ([
545 # Better not create a merge nightmare for the GNAT folks.
546 'ada',
548 # Handled separately.
549 'testsuite',
552 self.skip_extensions |= set ([
553 # Maintained by the translation project.
554 '.po',
556 # Automatically-generated.
557 '.pot',
560 self.fossilised_files |= set ([
561 # Old news won't be updated.
562 'ONEWS',
565 class TestsuiteFilter (GenericFilter):
566 def __init__ (self):
567 GenericFilter.__init__ (self)
569 self.skip_extensions |= set ([
570 # Don't change the tests, which could be woend by anyone.
571 '.c',
572 '.C',
573 '.cc',
574 '.h',
575 '.hs',
576 '.f',
577 '.f90',
578 '.go',
579 '.inc',
580 '.java',
583 def skip_file (self, dir, filename):
584 # g++.niklas/README contains historical copyright information
585 # and isn't updated.
586 if filename == 'README' and os.path.basename (dir) == 'g++.niklas':
587 return True
588 return GenericFilter.skip_file (self, dir, filename)
590 class LibCppFilter (GenericFilter):
591 def __init__ (self):
592 GenericFilter.__init__ (self)
594 self.skip_extensions |= set ([
595 # Maintained by the translation project.
596 '.po',
598 # Automatically-generated.
599 '.pot',
602 class LibGCCFilter (GenericFilter):
603 def __init__ (self):
604 GenericFilter.__init__ (self)
606 self.skip_dirs |= set ([
607 # Imported from GLIBC.
608 'soft-fp',
611 class LibJavaFilter (GenericFilter):
612 def __init__ (self):
613 GenericFilter.__init__ (self)
615 self.skip_dirs |= set ([
616 # Handled separately.
617 'testsuite',
619 # Not really part of the library
620 'contrib',
622 # Imported from upstream
623 'classpath',
624 'libltdl',
627 def get_line_filter (self, dir, filename):
628 if filename == 'NameDecoder.h':
629 return re.compile ('.*NAME_COPYRIGHT')
630 if filename == 'ICC_Profile.h':
631 return re.compile ('.*icSigCopyrightTag')
632 return GenericFilter.get_line_filter (self, dir, filename)
634 class LibStdCxxFilter (GenericFilter):
635 def __init__ (self):
636 GenericFilter.__init__ (self)
638 self.skip_files |= set ([
639 # Contains no copyright of its own, but quotes the GPL.
640 'intro.xml',
643 self.skip_dirs |= set ([
644 # Contains automatically-generated sources.
645 'html',
647 # The testsuite data files shouldn't be changed.
648 'data',
650 # Contains imported images
651 'images',
654 self.own_files |= set ([
655 # Contains markup around the copyright owner.
656 'spine.xml',
659 def get_line_filter (self, dir, filename):
660 if filename == 'boost_concept_check.h':
661 return re.compile ('// \(C\) Copyright Jeremy Siek')
662 return GenericFilter.get_line_filter (self, dir, filename)
664 class GCCCopyright (Copyright):
665 def __init__ (self, errors):
666 Copyright.__init__ (self, errors)
668 canon_fsf = 'Free Software Foundation, Inc.'
669 self.add_package_author ('Free Software Foundation', canon_fsf)
670 self.add_package_author ('Free Software Foundation.', canon_fsf)
671 self.add_package_author ('Free Software Foundation Inc.', canon_fsf)
672 self.add_package_author ('Free Software Foundation, Inc', canon_fsf)
673 self.add_package_author ('Free Software Foundation, Inc.', canon_fsf)
674 self.add_package_author ('The Free Software Foundation', canon_fsf)
675 self.add_package_author ('The Free Software Foundation, Inc.', canon_fsf)
676 self.add_package_author ('Software Foundation, Inc.', canon_fsf)
678 self.add_external_author ('ARM')
679 self.add_external_author ('AdaCore')
680 self.add_external_author ('Ami Tavory and Vladimir Dreizin, IBM-HRL.')
681 self.add_external_author ('Cavium Networks.')
682 self.add_external_author ('Faraday Technology Corp.')
683 self.add_external_author ('Florida State University')
684 self.add_external_author ('Greg Colvin and Beman Dawes.')
685 self.add_external_author ('Hewlett-Packard Company')
686 self.add_external_author ('Information Technology Industry Council.')
687 self.add_external_author ('James Theiler, Brian Gough')
688 self.add_external_author ('Makoto Matsumoto and Takuji Nishimura,')
689 self.add_external_author ('National Research Council of Canada.')
690 self.add_external_author ('NVIDIA Corporation')
691 self.add_external_author ('Peter Dimov and Multi Media Ltd.')
692 self.add_external_author ('Peter Dimov')
693 self.add_external_author ('Pipeline Associates, Inc.')
694 self.add_external_author ('Regents of the University of California.')
695 self.add_external_author ('Silicon Graphics Computer Systems, Inc.')
696 self.add_external_author ('Silicon Graphics')
697 self.add_external_author ('Stephen L. Moshier')
698 self.add_external_author ('Sun Microsystems, Inc. All rights reserved.')
699 self.add_external_author ('The Go Authors. All rights reserved.')
700 self.add_external_author ('The Go Authors. All rights reserved.')
701 self.add_external_author ('The Go Authors.')
702 self.add_external_author ('The Regents of the University of California.')
703 self.add_external_author ('Unicode, Inc.')
704 self.add_external_author ('University of Toronto.')
706 class GCCCmdLine (CmdLine):
707 def __init__ (self):
708 CmdLine.__init__ (self, GCCCopyright)
710 self.add_dir ('.', TopLevelFilter())
711 # boehm-gc is imported from upstream.
712 self.add_dir ('config', ConfigFilter())
713 # contrib isn't really part of GCC.
714 self.add_dir ('fixincludes')
715 self.add_dir ('gcc', GCCFilter())
716 self.add_dir (os.path.join ('gcc', 'testsuite'), TestsuiteFilter())
717 self.add_dir ('gnattools')
718 self.add_dir ('gotools')
719 self.add_dir ('include')
720 # intl is imported from upstream.
721 self.add_dir ('libada')
722 self.add_dir ('libatomic')
723 self.add_dir ('libbacktrace')
724 self.add_dir ('libcc1')
725 # libcilkrts is imported from upstream.
726 self.add_dir ('libcpp', LibCppFilter())
727 self.add_dir ('libdecnumber')
728 # libffi is imported from upstream.
729 self.add_dir ('libgcc', LibGCCFilter())
730 self.add_dir ('libgfortran')
731 # libgo is imported from upstream.
732 self.add_dir ('libgomp')
733 self.add_dir ('libiberty')
734 self.add_dir ('libitm')
735 self.add_dir ('libjava', LibJavaFilter())
736 self.add_dir (os.path.join ('libjava', 'testsuite'), TestsuiteFilter())
737 self.add_dir ('libobjc')
738 # liboffloadmic is imported from upstream.
739 self.add_dir ('libquadmath')
740 # libsanitizer is imported from upstream.
741 self.add_dir ('libssp')
742 self.add_dir ('libstdc++-v3', LibStdCxxFilter())
743 self.add_dir ('libvtv')
744 self.add_dir ('lto-plugin')
745 # maintainer-scripts maintainer-scripts
746 # zlib is imported from upstream.
748 self.default_dirs = [
749 'gcc',
750 'libada',
751 'libatomic',
752 'libbacktrace',
753 'libcpp',
754 'libdecnumber',
755 'libgcc',
756 'libgfortran',
757 'libgomp',
758 'libitm',
759 'libobjc',
760 'libstdc++-v3',
763 GCCCmdLine().main()