blender/tools/check_source/check_header_duplicate.py
Campbell Barton e955c94ed3 License Headers: Set copyright to "Blender Authors", add AUTHORS
Listing the "Blender Foundation" as copyright holder implied the Blender
Foundation holds copyright to files which may include work from many
developers.

While keeping copyright on headers makes sense for isolated libraries,
Blender's own code may be refactored or moved between files in a way
that makes the per file copyright holders less meaningful.

Copyright references to the "Blender Foundation" have been replaced with
"Blender Authors", with the exception of `./extern/` since these this
contains libraries which are more isolated, any changed to license
headers there can be handled on a case-by-case basis.

Some directories in `./intern/` have also been excluded:

- `./intern/cycles/` it's own `AUTHORS` file is planned.
- `./intern/opensubdiv/`.

An "AUTHORS" file has been added, using the chromium projects authors
file as a template.

Design task: #110784

Ref !110783.
2023-08-16 00:20:26 +10:00

91 lines
2.1 KiB
Python
Executable File

#!/usr/bin/env python3
# SPDX-FileCopyrightText: 2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
"""
Run this script to check if headers are included multiple times.
python3 check_header_duplicate.py ../../
Now build the code to find duplicate errors, resolve them manually.
Then restore the headers to their original state:
python3 check_header_duplicate.py --restore ../../
"""
# Use GCC's __INCLUDE_LEVEL__ to find direct duplicate includes
UUID = 0
def source_filepath_guard(filepath):
global UUID
footer = """
#if __INCLUDE_LEVEL__ == 1
# ifdef _DOUBLEHEADERGUARD_%d
# error "duplicate header!"
# endif
#endif
#if __INCLUDE_LEVEL__ == 1
# define _DOUBLEHEADERGUARD_%d
#endif
""" % (UUID, UUID)
UUID += 1
with open(filepath, 'a', encoding='utf-8') as f:
f.write(footer)
def source_filepath_restore(filepath):
import os
os.system("git co %s" % filepath)
def scan_source_recursive(dirpath, is_restore):
import os
from os.path import join, splitext
# ensure git working dir is ok
os.chdir(dirpath)
def source_list(path, filename_check=None):
for dirpath, dirnames, filenames in os.walk(path):
# skip '.git'
dirnames[:] = [d for d in dirnames if not d.startswith(".")]
for filename in filenames:
filepath = join(dirpath, filename)
if filename_check is None or filename_check(filepath):
yield filepath
def is_source(filename):
ext = splitext(filename)[1]
return (ext in {".hpp", ".hxx", ".h", ".hh"})
def is_ignore(filename):
pass
for filepath in sorted(source_list(dirpath, is_source)):
print("file:", filepath)
if is_ignore(filepath):
continue
if is_restore:
source_filepath_restore(filepath)
else:
source_filepath_guard(filepath)
def main():
import sys
is_restore = ("--restore" in sys.argv[1:])
scan_source_recursive(sys.argv[-1], is_restore)
if __name__ == "__main__":
main()