gdb/copyright.py

   1 #! /usr/bin/env python
   2
   3 # Copyright (C) 2011-2012 Free Software Foundation, Inc.
   4 #
   5 # This file is part of GDB.
   6 #
   7 # This program 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 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 """copyright.py
  21
  22 This script updates the list of years in the copyright notices in
  23 most files maintained by the GDB project.
  24
  25 Usage: cd src/gdb && python copyright.py
  26
  27 Always review the output of this script before committing it!
  28 A useful command to review the output is:
  29     % filterdiff -x \*.c -x \*.cc -x \*.h -x \*.exp updates.diff
  30 This removes the bulk of the changes which are most likely to be correct.
  31 """
  32
  33 import datetime
  34 import os
  35 import os.path
  36 import subprocess
  37
  38 # A list of prefixes that start a multi-line comment.  These prefixes
  39 # should not be repeatead when wraping long lines.
  40 MULTILINE_COMMENT_PREFIXES = (
  41     '/*',    # C/C++
  42     '<!--',  # XML
  43     '{',     # Pascal
  44 )
  45
  46
  47 def get_update_list():
  48     """Return the list of files to update.
  49
  50     Assumes that the current working directory when called is the root
  51     of the GDB source tree (NOT the gdb/ subdirectory!).  The names of
  52     the files are relative to that root directory.
  53     """
  54     result = []
  55     for gdb_dir in ('gdb', 'sim', 'include/gdb'):
  56         for root, dirs, files in os.walk(gdb_dir, topdown=True):
  57             for dirname in dirs:
  58                 reldirname = "%s/%s" % (root, dirname)
  59                 if (dirname in EXCLUDE_ALL_LIST
  60                     or reldirname in EXCLUDE_LIST
  61                     or reldirname in NOT_FSF_LIST
  62                     or reldirname in BY_HAND):
  63                     # Prune this directory from our search list.
  64                     dirs.remove(dirname)
  65             for filename in files:
  66                 relpath = "%s/%s" % (root, filename)
  67                 if (filename in EXCLUDE_ALL_LIST
  68                     or relpath in EXCLUDE_LIST
  69                     or relpath in NOT_FSF_LIST
  70                     or relpath in BY_HAND):
  71                     # Ignore this file.
  72                     pass
  73                 else:
  74                     result.append(relpath)
  75     return result
  76
  77
  78 def update_files(update_list):
  79     """Update the copyright header of the files in the given list.
  80
  81     We use gnulib's update-copyright script for that.
  82     """
  83     # Tell the update-copyright script that we do not want it to
  84     # repeat the prefixes in MULTILINE_COMMENT_PREFIXES.
  85     os.environ['MULTILINE_COMMENT_PREFIXES'] = \
  86         '\n'.join(MULTILINE_COMMENT_PREFIXES)
  87     # We want to use year intervals in the copyright notices, and
  88     # all years should be collapsed to one single year interval,
  89     # even if there are "holes" in the list of years found in the
  90     # original copyright notice (OK'ed by the FSF, case [gnu.org #719834]).
  91     os.environ['UPDATE_COPYRIGHT_USE_INTERVALS'] = '2'
  92
  93     # Perform the update, and save the output in a string.
  94     update_cmd = ['bash', 'gdb/gnulib/extra/update-copyright'] + update_list
  95     p = subprocess.Popen(update_cmd, stdout=subprocess.PIPE,
  96                          stderr=subprocess.STDOUT)
  97     update_out = p.communicate()[0]
  98
  99     # Process the output.  Typically, a lot of files do not have
 100     # a copyright notice :-(.  The update-copyright script prints
 101     # a well defined warning when it did not find the copyright notice.
 102     # For each of those, do a sanity check and see if they may in fact
 103     # have one.  For the files that are found not to have one, we filter
 104     # the line out from the output, since there is nothing more to do,
 105     # short of looking at each file and seeing which notice is appropriate.
 106     # Too much work! (~4,000 files listed as of 2012-01-03).
 107     update_out = update_out.splitlines()
 108     warning_string = ': warning: copyright statement not found'
 109     warning_len = len(warning_string)
 110
 111     for line in update_out:
 112         if line.endswith('\n'):
 113             line = line[:-1]
 114         if line.endswith(warning_string):
 115             filename = line[:-warning_len]
 116             if may_have_copyright_notice(filename):
 117                 print line
 118         else:
 119             # Unrecognized file format. !?!
 120             print "*** " + line
 121
 122
 123 def may_have_copyright_notice(filename):
 124     """Check that the given file does not seem to have a copyright notice.
 125
 126     The filename is relative to the root directory.
 127     This function assumes that the current working directory is that root
 128     directory.
 129
 130     The algorigthm is fairly crude, meaning that it might return
 131     some false positives.  I do not think it will return any false
 132     negatives...  We might improve this function to handle more
 133     complex cases later...
 134     """
 135     # For now, it may have a copyright notice if we find the word
 136     # "Copyright" at the (reasonable) start of the given file, say
 137     # 50 lines...
 138     MAX_LINES = 50
 139
 140     fd = open(filename)
 141
 142     lineno = 1
 143     for line in fd:
 144         if 'Copyright' in line:
 145             return True
 146         lineno += 1
 147         if lineno > 50:
 148             return False
 149     return False
 150
 151
 152 def main ():
 153     """The main subprogram."""
 154     if not os.path.isfile("gnulib/extra/update-copyright"):
 155         print "Error: This script must be called from the gdb directory."
 156     root_dir = os.path.dirname(os.getcwd())
 157     os.chdir(root_dir)
 158
 159     update_list = get_update_list()
 160     update_files (update_list)
 161
 162     # Remind the user that some files need to be updated by HAND...
 163     if BY_HAND:
 164         print
 165         print "\033[31mREMINDER: The following files must be updated by hand." \
 166               "\033[0m"
 167         for filename in BY_HAND:
 168             print "  ", filename
 169
 170 ############################################################################
 171 #
 172 # Some constants, placed at the end because they take up a lot of room.
 173 # The actual value of these constants is not significant to the understanding
 174 # of the script.
 175 #
 176 ############################################################################
 177
 178 # Files which should not be modified, either because they are
 179 # generated, non-FSF, or otherwise special (e.g. license text,
 180 # or test cases which must be sensitive to line numbering).
 181 #
 182 # Filenames are relative to the root directory.
 183 EXCLUDE_LIST = (
 184     'gdb/gdbarch.c', 'gdb/gdbarch.h',
 185     'gdb/gnulib'
 186 )
 187
 188 # Files which should not be modified, either because they are
 189 # generated, non-FSF, or otherwise special (e.g. license text,
 190 # or test cases which must be sensitive to line numbering).
 191 #
 192 # Matches any file or directory name anywhere.  Use with caution.
 193 # This is mostly for files that can be found in multiple directories.
 194 # Eg: We want all files named COPYING to be left untouched.
 195
 196 EXCLUDE_ALL_LIST = (
 197     "COPYING", "COPYING.LIB", "CVS", "configure", "copying.c",
 198     "fdl.texi", "gpl.texi", "aclocal.m4",
 199 )
 200
 201 # The list of files to update by hand.
 202 BY_HAND = (
 203     # These files are sensitive to line numbering.
 204     "gdb/testsuite/gdb.base/step-line.inp",
 205     "gdb/testsuite/gdb.base/step-line.c",
 206 )
 207
 208 # The list of file which have a copyright, but not head by the FSF.
 209 # Filenames are relative to the root directory.
 210 NOT_FSF_LIST = (
 211     "gdb/exc_request.defs",
 212     "gdb/osf-share",
 213     "gdb/gdbtk",
 214     "gdb/testsuite/gdb.gdbtk/",
 215     "sim/arm/armemu.h", "sim/arm/armos.c", "sim/arm/gdbhost.c",
 216     "sim/arm/dbg_hif.h", "sim/arm/dbg_conf.h", "sim/arm/communicate.h",
 217     "sim/arm/armos.h", "sim/arm/armcopro.c", "sim/arm/armemu.c",
 218     "sim/arm/kid.c", "sim/arm/thumbemu.c", "sim/arm/armdefs.h",
 219     "sim/arm/armopts.h", "sim/arm/dbg_cp.h", "sim/arm/dbg_rdi.h",
 220     "sim/arm/parent.c", "sim/arm/armsupp.c", "sim/arm/armrdi.c",
 221     "sim/arm/bag.c", "sim/arm/armvirt.c", "sim/arm/main.c", "sim/arm/bag.h",
 222     "sim/arm/communicate.c", "sim/arm/gdbhost.h", "sim/arm/armfpe.h",
 223     "sim/arm/arminit.c",
 224     "sim/common/cgen-fpu.c", "sim/common/cgen-fpu.h", "sim/common/cgen-fpu.h",
 225     "sim/common/cgen-accfp.c", "sim/common/sim-fpu.c",
 226     "sim/erc32/sis.h", "sim/erc32/erc32.c", "sim/erc32/func.c",
 227     "sim/erc32/float.c", "sim/erc32/interf.c", "sim/erc32/sis.c",
 228     "sim/erc32/exec.c",
 229     "sim/mips/m16run.c", "sim/mips/sim-main.c",
 230     "sim/mn10300/sim-main.h",
 231     "sim/moxie/moxie-gdb.dts",
 232     # Not a single file in sim/ppc/ appears to be copyright FSF :-(.
 233     "sim/ppc/filter.h", "sim/ppc/gen-support.h", "sim/ppc/ld-insn.h",
 234     "sim/ppc/hw_sem.c", "sim/ppc/hw_disk.c", "sim/ppc/idecode_branch.h",
 235     "sim/ppc/sim-endian.h", "sim/ppc/table.c", "sim/ppc/hw_core.c",
 236     "sim/ppc/gen-support.c", "sim/ppc/gen-semantics.h", "sim/ppc/cpu.h",
 237     "sim/ppc/sim_callbacks.h", "sim/ppc/RUN", "sim/ppc/Makefile.in",
 238     "sim/ppc/emul_chirp.c", "sim/ppc/hw_nvram.c", "sim/ppc/dc-test.01",
 239     "sim/ppc/hw_phb.c", "sim/ppc/hw_eeprom.c", "sim/ppc/bits.h",
 240     "sim/ppc/hw_vm.c", "sim/ppc/cap.h", "sim/ppc/os_emul.h",
 241     "sim/ppc/options.h", "sim/ppc/gen-idecode.c", "sim/ppc/filter.c",
 242     "sim/ppc/corefile-n.h", "sim/ppc/std-config.h", "sim/ppc/ld-decode.h",
 243     "sim/ppc/filter_filename.h", "sim/ppc/hw_shm.c",
 244     "sim/ppc/pk_disklabel.c", "sim/ppc/dc-simple", "sim/ppc/misc.h",
 245     "sim/ppc/device_table.h", "sim/ppc/ld-insn.c", "sim/ppc/inline.c",
 246     "sim/ppc/emul_bugapi.h", "sim/ppc/hw_cpu.h", "sim/ppc/debug.h",
 247     "sim/ppc/hw_ide.c", "sim/ppc/debug.c", "sim/ppc/gen-itable.h",
 248     "sim/ppc/interrupts.c", "sim/ppc/hw_glue.c", "sim/ppc/emul_unix.c",
 249     "sim/ppc/sim_calls.c", "sim/ppc/dc-complex", "sim/ppc/ld-cache.c",
 250     "sim/ppc/registers.h", "sim/ppc/dc-test.02", "sim/ppc/options.c",
 251     "sim/ppc/igen.h", "sim/ppc/registers.c", "sim/ppc/device.h",
 252     "sim/ppc/emul_chirp.h", "sim/ppc/hw_register.c", "sim/ppc/hw_init.c",
 253     "sim/ppc/sim-endian-n.h", "sim/ppc/filter_filename.c",
 254     "sim/ppc/bits.c", "sim/ppc/idecode_fields.h", "sim/ppc/hw_memory.c",
 255     "sim/ppc/misc.c", "sim/ppc/double.c", "sim/ppc/psim.h",
 256     "sim/ppc/hw_trace.c", "sim/ppc/emul_netbsd.h", "sim/ppc/psim.c",
 257     "sim/ppc/ppc-instructions", "sim/ppc/tree.h", "sim/ppc/README",
 258     "sim/ppc/gen-icache.h", "sim/ppc/gen-model.h", "sim/ppc/ld-cache.h",
 259     "sim/ppc/mon.c", "sim/ppc/corefile.h", "sim/ppc/vm.c",
 260     "sim/ppc/INSTALL", "sim/ppc/gen-model.c", "sim/ppc/hw_cpu.c",
 261     "sim/ppc/corefile.c", "sim/ppc/hw_opic.c", "sim/ppc/gen-icache.c",
 262     "sim/ppc/events.h", "sim/ppc/os_emul.c", "sim/ppc/emul_generic.c",
 263     "sim/ppc/main.c", "sim/ppc/hw_com.c", "sim/ppc/gen-semantics.c",
 264     "sim/ppc/emul_bugapi.c", "sim/ppc/device.c", "sim/ppc/emul_generic.h",
 265     "sim/ppc/tree.c", "sim/ppc/mon.h", "sim/ppc/interrupts.h",
 266     "sim/ppc/cap.c", "sim/ppc/cpu.c", "sim/ppc/hw_phb.h",
 267     "sim/ppc/device_table.c", "sim/ppc/lf.c", "sim/ppc/lf.c",
 268     "sim/ppc/dc-stupid", "sim/ppc/hw_pal.c", "sim/ppc/ppc-spr-table",
 269     "sim/ppc/emul_unix.h", "sim/ppc/words.h", "sim/ppc/basics.h",
 270     "sim/ppc/hw_htab.c", "sim/ppc/lf.h", "sim/ppc/ld-decode.c",
 271     "sim/ppc/sim-endian.c", "sim/ppc/gen-itable.c",
 272     "sim/ppc/idecode_expression.h", "sim/ppc/table.h", "sim/ppc/dgen.c",
 273     "sim/ppc/events.c", "sim/ppc/gen-idecode.h", "sim/ppc/emul_netbsd.c",
 274     "sim/ppc/igen.c", "sim/ppc/vm_n.h", "sim/ppc/vm.h",
 275     "sim/ppc/hw_iobus.c", "sim/ppc/inline.h",
 276     "sim/testsuite/sim/bfin/s21.s", "sim/testsuite/sim/mips/mips32-dsp2.s",
 277 )
 278
 279 if __name__ == "__main__":
 280     main()
 281