Differential D13752 Diff 46685 check_source/check_unity_build_namespaces.py

Changeset View

Standalone View

check_source/check_unity_build_namespaces.py

This file was added.

				#!/usr/bin/env python3

				# *** BEGIN GPL LICENSE BLOCK ***
				#
				# This program is free software; you can redistribute it and/or
				# modify it under the terms of the GNU General Public License
				# as published by the Free Software Foundation; either version 2
				# of the License, or (at your option) any later version.
				#
				# This program 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 General Public License for more details.
				#
				# You should have received a copy of the GNU General Public License
				# along with this program; if not, write to the Free Software Foundation,
				# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
				#
				# #** END GPL LICENSE BLOCK #**

				'''
				Some modules (e.g. `bf_nodes_geometry`) use unity builds to speed-up compilation time.
				When unity builds are used, multiple source files are concatenated and compiled together.
				This can break when multiple files use the same names for static functions.
				To prevent this, we added namespaces which have the name of the corresponding source file.

				This script checks if the namespace names are update to date and optionally updates
				a comment right before the namespace.
				'''

				import glob
				from pathlib import Path

				root_dir = Path("/home/jacques/blender-git/blender")
				insert_comment = True
				BlendifyUnsubmitted Not Done Inline Actions Other scripts have a function to find the root directory based on the presence of the .git folder. You can copy that function here. Blendify: Other scripts have a function to find the root directory based on the presence of the .git…
				comment = "/* File namespace to support unity builds. */"

				def iter_files_to_check():
				for path in glob.glob("*/.cc", root_dir=root_dir, recursive=True):
				path = root_dir / path
				if "extern" in str(path):
				continue
				yield path

				for path in iter_files_to_check():
				with open(path) as file:
				code = file.read()

				expected_namespace_name = path.name.replace(".", "_")
				found_wrong_namespace_names = set()

				lines = code.splitlines()
				new_lines = []
				for i, line in enumerate(lines):
				if not (line.startswith("namespace") and line.endswith("_cc {")):
				for found_name in found_wrong_namespace_names:
				line = line.replace(found_name, expected_namespace_name)
				new_lines.append(line)
				continue

				if insert_comment:
				if i == 0:
				new_lines.append(comment)
				else:
				prev_line = new_lines[-1]
				if prev_line != comment:
				if prev_line.startswith("/*"):
				new_lines[-1] = comment
				else:
				new_lines.append(comment)

				namespace_name = line.split("::")[-1].split(" ")[0]
				if expected_namespace_name != namespace_name:
				found_wrong_namespace_names.add(namespace_name)
				for found_name in found_wrong_namespace_names:
				line = line.replace(found_name, expected_namespace_name)
				new_lines.append(line)


				new_lines.append("")
				new_code = "\n".join(new_lines)
				if code != new_code:
				with open(path, "w") as file:
				file.write(new_code)

				print(f"Updated {path}")

				for found_name in found_wrong_namespace_names:
				print(f" {found_name} -> {expected_namespace_name}")