File: UpdateCopyrightStatementsInITK.py

package info (click to toggle)
insighttoolkit4 4.13.3withdata-dfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 489,260 kB
  • sloc: cpp: 557,342; ansic: 146,850; fortran: 34,788; python: 16,572; sh: 2,187; lisp: 2,070; tcl: 993; java: 362; perl: 200; makefile: 129; csh: 81; pascal: 69; xml: 19; ruby: 10
file content (152 lines) | stat: -rwxr-xr-x 6,491 bytes parent folder | download | duplicates (5)
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
#!/usr/bin/python
#==========================================================================
#
#   Copyright Insight Software Consortium
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#          http://www.apache.org/licenses/LICENSE-2.0.txt
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
#==========================================================================*/

#
# \author Hans J. Johnson
#
# This script is designed to help change the copyright notices in all ITK files to a common format.
# For files that are .h, .cxx, .hxx, .c, if there is no other copyright information, add the itkCopyright.

from __future__ import print_function

import re
import sys
import os

## New license as specified on: https://itk.org/Wiki/ITK_Release_4/Licensing
NewITKCopyrightNotice="""/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
"""
NewVTKDependantCopyrightNotice="""/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
"""

## Patterns that match the old copyright notice sections
## ITK only copyright
ITKOnlyOldHeader=""" */\* *==.*Program:.*Insight Segmentation & Registration Toolkit.*Copyright .* Insight.*Consortium. All rights reserved.*See ITKCopyright.txt or https://www.itk.org/HTML/Copyright.htm for details.[\n\r ]*This software is distributed WITHOUT ANY WARRANTY; without even.*the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR.*PURPOSE.  See the above copyright notices for more information.*=== *\*/[\n\r ]*"""
ITKOnlyOldRE=re.compile(ITKOnlyOldHeader,re.MULTILINE|re.DOTALL|re.IGNORECASE)

## Files that originated in VTK, and now have ITK also
ITKVTKOldHeader=""" */\* *==.*Program:.*Insight Segmentation & Registration Toolkit.*Copyright .* Insight Software Consortium. All rights reserved.*See ITKCopyright.txt or https://www.itk.org/HTML/Copyright.htm for details.[\n\r ]*.*VTKCopyright.txt.*This software is distributed WITHOUT ANY WARRANTY; without even.*the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR.*PURPOSE.  See the above copyright notices for more information.*=== *\*/[\n\r ]*"""
ITKVTKOldRE=re.compile(ITKVTKOldHeader,re.MULTILINE|re.DOTALL|re.IGNORECASE)

## Looking for new files.
NewITKHeader=""" */\* *==.*http://www.apache.org/licenses/LICENSE-2.0.txt.*=== *\*/"""
NewITKHeaderRE=re.compile(NewITKHeader,re.MULTILINE|re.DOTALL|re.IGNORECASE)

eolSpaceRemove=re.compile(r'  *$',re.MULTILINE)

## The exception list contains files that should not have the ITK copyright notices added.
ExclusionList=['Utilities','.git']

ExtensionsThatNeedCopyright=['.cxx','.c','.h','.hxx']


############
############
############
############
############
############
############

if len(sys.argv) != 2:
    print("USAGE:  {0} <Top of ITK tree to process>".format(sys.argv[0]))
    sys.exit(-1)

HeadOfITKTree=sys.argv[1]

for top,directory,files in os.walk(HeadOfITKTree):
    ## First remove Excluded directories
    for dd in directory:
      if dd[0] == '.': #Skip all directories that begin with '.'
        directory.remove(dd)
        continue
      if dd in ExclusionList:
          directory.remove(dd)
          continue
    ##  Now process each file
    for ff in files:
      if ff in ExclusionList:
        files.remove(ff)
        continue
      if ff[0] == '.': #Skip all files that begin with '.'
        files.remove(ff)
        #print("@@@@@@@",ff)
        continue
      currFile=os.path.join(top,ff)
      print(currFile)

      infile=open(currFile,'r')
      file_text=infile.read()
      newstring=file_text # default output to input, just in case all search patterns fail
      infile.close()

      substitutionMade=0
      testITKOnlySearch=ITKOnlyOldRE.search(file_text)
      if testITKOnlySearch:
        print("{0} is ITKOnlyHeader".format(currFile))
        newstring=ITKOnlyOldRE.sub(NewITKCopyrightNotice,file_text)
        newstring=eolSpaceRemove.sub("",newstring) ## a few files still have eol spaces
        substitutionMade=1

      testITKVTKSearch=ITKVTKOldRE.search(file_text)
      if testITKVTKSearch:
        print("{0} is VTKITKHeader".format(currFile))
        newstring=ITKVTKOldRE.sub(NewITKCopyrightNotice+NewVTKDependantCopyrightNotice,file_text)
        newstring=eolSpaceRemove.sub("",newstring) ## a few files still have eol spaces
        substitutionMade=1

      ##Add new copyright if it had not already existed.
      root,ext=os.path.splitext(currFile)
      if ext in ExtensionsThatNeedCopyright:
        testNewITKHeaderRE=NewITKHeaderRE.search(file_text) # see if new CopyRight notice already exists.
        if testNewITKHeaderRE:
          print("Already Processed {0}".format(currFile))
        elif (substitutionMade == 0):
          print("{0} needed copyright header.".format(currFile))
          newstring=NewITKCopyrightNotice+file_text
          newstring=eolSpaceRemove.sub("",newstring) ## a few files still have eol spaces

      outfile=open(currFile,'w')
      outfile.write(newstring)
      outfile.close()