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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
|
#!/usr/bin/env python
#
# This file is part of the GROMACS molecular simulation package.
#
# Copyright (c) 2013,2014,2015,2016,2018, by the GROMACS development team, led by
# Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
# and including many others, as listed in the AUTHORS file in the
# top-level source directory and at http://www.gromacs.org.
#
# GROMACS is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation; either version 2.1
# of the License, or (at your option) any later version.
#
# GROMACS is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with GROMACS; if not, see
# http://www.gnu.org/licenses, or write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# If you want to redistribute modifications to GROMACS, please
# consider that scientific software is very special. Version
# control is crucial - bugs must be traceable. We will be happy to
# consider code for inclusion in the official distribution, but
# derived work must not be called official GROMACS. Details are found
# in the README & COPYING files - if they are missing, get the
# official version at http://www.gromacs.org.
#
# To help us fund GROMACS development, we humbly ask that you cite
# the research papers on the package. Check out http://www.gromacs.org.
"""Checks and/or updates copyright headers in GROMACS source files.
It is used internally by several bash scripts to do copyright-relates tasks,
but can also be invoked directly for some rare use cases.
See docs/dev-manual/uncrustify.rst for more details.
"""
import datetime
import os.path
import re
import sys
from optparse import OptionParser
class CopyrightState(object):
"""Information about an existing (or non-existing) copyright header."""
def __init__(self, has_copyright, is_correct, is_newstyle, years, other_copyrights):
self.has_copyright = has_copyright
self.is_correct = is_correct
self.is_newstyle = is_newstyle
self.years = years
self.other_copyrights = other_copyrights
class CopyrightChecker(object):
"""Logic for analyzing existing copyright headers and generating new ones."""
_header = ["", "This file is part of the GROMACS molecular simulation package.", ""]
_copyright = "Copyright (c) {0}, by the GROMACS development team, led by"
_footer = """
Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
and including many others, as listed in the AUTHORS file in the
top-level source directory and at http://www.gromacs.org.
GROMACS is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version.
GROMACS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with GROMACS; if not, see
http://www.gnu.org/licenses, or write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
If you want to redistribute modifications to GROMACS, please
consider that scientific software is very special. Version
control is crucial - bugs must be traceable. We will be happy to
consider code for inclusion in the official distribution, but
derived work must not be called official GROMACS. Details are found
in the README & COPYING files - if they are missing, get the
official version at http://www.gromacs.org.
To help us fund GROMACS development, we humbly ask that you cite
the research papers on the package. Check out http://www.gromacs.org.
""".strip().splitlines()
def check_copyright(self, comment_block):
"""Analyze existing copyright header for correctness and extract information."""
copyright_re = r'Copyright \(c\) (([0-9]{4}[,-])*[0-9]{4}),? by the GROMACS development team,'
has_copyright = False
is_newstyle = True
is_correct = True
next_header_line = 0
next_footer_line = 0
append_next_line_to_other_copyrights = False
existing_years = ''
other_copyrights = []
for line in comment_block:
if append_next_line_to_other_copyrights:
other_copyrights[-1] += ' ' + line
append_next_line_to_other_copyrights = False
continue
if 'Copyright' in line:
has_copyright = True
match = re.match(copyright_re, line)
if match:
existing_years = match.group(1)
new_line = self._copyright.format(existing_years)
if line != new_line:
is_correct = False
else:
other_copyrights.append(line[line.find('Copyright'):])
if not line.startswith('Copyright'):
append_next_line_to_other_copyrights = True
if next_header_line != -1 or next_footer_line != 0:
is_correct = False
continue
if line.startswith('Written by the Gromacs development team'):
has_copyright = True
if next_header_line >= 0:
if line == self._header[next_header_line]:
next_header_line += 1
if next_header_line >= len(self._header):
next_header_line = -1
else:
is_correct = False
is_newstyle = False
elif next_footer_line >= 0:
if line == self._footer[next_footer_line]:
next_footer_line += 1
if next_footer_line >= len(self._footer):
next_footer_line = -1
else:
is_correct = False
else:
is_correct = False
if next_header_line != -1 or next_footer_line != -1:
is_correct = False
return CopyrightState(has_copyright, is_correct, is_newstyle, existing_years, other_copyrights)
def process_copyright(self, state, options, current_years, reporter):
"""Determine whether a copyrigth header needs to be updated and report issues."""
need_update = False
if state.years:
if options.replace_years:
if state.years != current_years:
need_update = True
reporter.report('copyright years replaced')
new_years = current_years
else:
new_years = state.years
if not new_years.endswith(current_years):
if options.update_year:
need_update = True
new_years += ',' + current_years
if options.check or not need_update:
reporter.report('copyright year outdated')
else:
reporter.report('copyright year added')
else:
new_years = current_years
if not state.has_copyright:
if options.add_missing:
need_update = True
if options.check or not need_update:
reporter.report('copyright header missing')
elif options.add_missing:
reporter.report('copyright header added')
else:
if not state.is_newstyle:
if options.replace_header:
need_update = True
if options.check or not need_update:
reporter.report('copyright header incorrect')
else:
reporter.report('copyright header replaced')
elif not state.is_correct:
if options.update_header:
need_update = True
if options.check or not need_update:
reporter.report('copyright header outdated')
else:
reporter.report('copyright header updated')
return need_update, new_years
def get_copyright_text(self, years, other_copyrights):
"""Construct a new copyright header."""
output = []
output.extend(self._header)
if other_copyrights:
for line in other_copyrights:
outline = line.rstrip()
if outline.endswith(','):
outline = outline[:-1]
if not outline.endswith('.'):
outline += '.'
output.append(outline)
output.append(self._copyright.format(years))
output.extend(self._footer)
return output
class Reporter(object):
"""Wrapper for reporting issues in a file."""
def __init__(self, reportfile, filename):
self._reportfile = reportfile
self._filename = filename
def report(self, text):
self._reportfile.write(self._filename + ': ' + text + '\n');
class CommentHandlerC(object):
"""Handler for extracting and creating C-style comments."""
def extract_first_comment_block(self, content_lines):
if not content_lines or not content_lines[0].startswith('/*'):
return ([], 0)
comment_block = [content_lines[0][2:].strip()]
line_index = 1
while line_index < len(content_lines):
line = content_lines[line_index]
if '*/' in content_lines[line_index]:
break
comment_block.append(line.lstrip('* ').rstrip())
line_index += 1
return (comment_block, line_index + 1)
def create_comment_block(self, lines):
output = []
output.append(('/* ' + lines[0]).rstrip())
output.extend([(' * ' + x).rstrip() for x in lines[1:]])
output.append(' */')
return output
class CommentHandlerSimple(object):
"""Handler for extracting and creating sh-style comments.
Also other comments of the same type, but with a different comment
character are supported."""
def __init__(self, comment_char):
self._comment_char = comment_char
def extract_first_comment_block(self, content_lines):
if not content_lines or not content_lines[0].startswith(self._comment_char):
return ([], 0)
comment_block = []
line_index = 0
while line_index < len(content_lines):
line = content_lines[line_index]
if not line.startswith(self._comment_char):
break
comment_block.append(line.lstrip(self._comment_char + ' ').rstrip())
line_index += 1
if line == self._comment_char + ' the research papers on the package. Check out http://www.gromacs.org.':
break
while line_index < len(content_lines):
line = content_lines[line_index].rstrip()
if len(line) > 0 and line != self._comment_char:
break
line_index += 1
return (comment_block, line_index)
def create_comment_block(self, lines):
output = []
output.extend([(self._comment_char + ' ' + x).rstrip() for x in lines])
output.append('')
return output
comment_handlers = {
'c': CommentHandlerC(),
'tex': CommentHandlerSimple('%'),
'sh': CommentHandlerSimple('#')
}
def select_comment_handler(override, filename):
"""Select comment handler for a file based on file name and input options."""
filetype = override
if not filetype and filename != '-':
basename = os.path.basename(filename)
root, ext = os.path.splitext(basename)
if ext == '.cmakein':
dummy, ext2 = os.path.splitext(root)
if ext2:
ext = ext2
if ext in ('.c', '.cu', '.cpp', '.cl', '.h', '.cuh', '.clh', '.y', '.l', '.pre', '.bm'):
filetype = 'c'
elif ext in ('.tex',):
filetype = 'tex'
elif basename in ('CMakeLists.txt', 'GMXRC', 'git-pre-commit') or \
ext in ('.cmake', '.cmakein', '.py', '.sh', '.bash', '.csh', '.zsh'):
filetype = 'sh'
if filetype in comment_handlers:
return comment_handlers[filetype]
if filetype:
sys.stderr.write("Unsupported input format: {0}\n".format(filetype))
elif filename != '-':
sys.stderr.write("Unsupported input format: {0}\n".format(filename))
else:
sys.stderr.write("No file name or file type provided.\n")
sys.exit(1)
def create_copyright_header(years, other_copyrights=None, language='c'):
if language not in comment_handlers:
sys.strerr.write("Unsupported language: {0}\n".format(language))
sys.exit(1)
copyright_checker = CopyrightChecker()
comment_handler = comment_handlers[language]
copyright_lines = copyright_checker.get_copyright_text(years, other_copyrights)
comment_lines = comment_handler.create_comment_block(copyright_lines)
return '\n'.join(comment_lines) + '\n'
def process_options():
"""Process input options."""
parser = OptionParser()
parser.add_option('-l', '--lang',
help='Comment type to use (c or sh)')
parser.add_option('-y', '--years',
help='Comma-separated list of years')
parser.add_option('-F', '--files',
help='File to read list of files from')
parser.add_option('--check', action='store_true',
help='Do not modify the files, only check the copyright (default action). ' +
'If specified together with --update, do the modifications ' +
'but produce output as if only --check was provided.')
parser.add_option('--update-year', action='store_true',
help='Update the copyright year if outdated')
parser.add_option('--replace-years', action='store_true',
help='Replace the copyright years with those given with --years')
parser.add_option('--update-header', action='store_true',
help='Update the copyright header if outdated')
parser.add_option('--replace-header', action='store_true',
help='Replace any copyright header with the current one')
parser.add_option('--remove-old-copyrights', action='store_true',
help='Remove copyright statements not in the new format')
parser.add_option('--add-missing', action='store_true',
help='Add missing copyright headers')
options, args = parser.parse_args()
filenames = args
if options.files:
with open(options.files, 'r') as filelist:
filenames = [x.strip() for x in filelist.read().splitlines()]
elif not filenames:
filenames = ['-']
# Default is --check if nothing provided.
if not options.check and not options.update_year and \
not options.update_header and not options.replace_header and \
not options.add_missing:
options.check = True
return options, filenames
def main():
"""Do processing as a stand-alone script."""
options, filenames = process_options()
years = options.years
if not years:
years = str(datetime.date.today().year)
if years.endswith(','):
years = years[:-1]
checker = CopyrightChecker()
# Process each input file in turn.
for filename in filenames:
comment_handler = select_comment_handler(options.lang, filename)
# Read the input file. We are doing an in-place operation, so can't
# operate in pass-through mode.
if filename == '-':
contents = sys.stdin.read().splitlines()
reporter = Reporter(sys.stderr, '<stdin>')
else:
with open(filename, 'r') as inputfile:
contents = inputfile.read().splitlines()
reporter = Reporter(sys.stdout, filename)
output = []
# Keep lines that must be at the beginning of the file and skip them in
# the check.
if contents and (contents[0].startswith('#!/') or \
contents[0].startswith('%code requires') or \
contents[0].startswith('/* #if')):
output.append(contents[0])
contents = contents[1:]
# Remove and skip empty lines at the beginning.
while contents and len(contents[0]) == 0:
contents = contents[1:]
# Analyze the first comment block in the file.
comment_block, line_count = comment_handler.extract_first_comment_block(contents)
state = checker.check_copyright(comment_block)
need_update, file_years = checker.process_copyright(state, options, years, reporter)
if state.other_copyrights and options.remove_old_copyrights:
need_update = True
state.other_copyrights = []
reporter.report('old copyrights removed')
if need_update:
# Remove the original comment if it was a copyright comment.
if state.has_copyright:
contents = contents[line_count:]
new_block = checker.get_copyright_text(file_years, state.other_copyrights)
output.extend(comment_handler.create_comment_block(new_block))
# Write the output file if required.
if need_update or filename == '-':
# Append the rest of the input file as it was.
output.extend(contents)
output = '\n'.join(output) + '\n'
if filename == '-':
sys.stdout.write(output)
else:
with open(filename, 'w') as outputfile:
outputfile.write(output)
if __name__ == "__main__":
main()
|