From c13348053129d4a356a0df1ada208809997799fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 15 Oct 2021 21:59:11 +0200 Subject: [PATCH] SCons: List `.gen.cpp` sources explicitly to avoid globbing errors Whenever we change the name (or remove) generated cpp files with the `.gen.cpp` extension, users run into build issues when switching between branches (i.e. switching before and after the name change/removal). This is because we glob `*.cpp` so if a now-obsolete file from a previous build is present, we'll include it too, potentially leading to bugs or compilation failure (due to missing headers or invalid code). So globbing patterns in `add_source_files` will now skip files ending with `.gen.cpp`, which should instead be passed explicitly where they're used. --- core/SCsub | 1 + core/input/SCsub | 14 +++++--------- editor/SCsub | 1 + methods.py | 13 ++++++++----- 4 files changed, 15 insertions(+), 14 deletions(-) diff --git a/core/SCsub b/core/SCsub index 14dfa3487fbe..c12dd4e60e24 100644 --- a/core/SCsub +++ b/core/SCsub @@ -146,6 +146,7 @@ env.core_sources += thirdparty_obj # Godot source files env.add_source_files(env.core_sources, "*.cpp") +env.add_source_files(env.core_sources, "script_encryption_key.gen.cpp") # Certificates env.Depends( diff --git a/core/input/SCsub b/core/input/SCsub index 740398b2662d..b12bf561de58 100644 --- a/core/input/SCsub +++ b/core/input/SCsub @@ -7,19 +7,15 @@ import input_builders # Order matters here. Higher index controller database files write on top of lower index database files. controller_databases = [ - "#core/input/gamecontrollerdb.txt", - "#core/input/godotcontrollerdb.txt", + "gamecontrollerdb.txt", + "godotcontrollerdb.txt", ] -env.Depends("#core/input/default_controller_mappings.gen.cpp", controller_databases) -env.CommandNoCache( - "#core/input/default_controller_mappings.gen.cpp", +gensource = env.CommandNoCache( + "default_controller_mappings.gen.cpp", controller_databases, env.Run(input_builders.make_default_controller_mappings, "Generating default controller mappings."), ) env.add_source_files(env.core_sources, "*.cpp") - -# Don't warn about duplicate entry here, we need it registered manually for first build, -# even if later builds will pick it up twice due to above *.cpp globbing. -env.add_source_files(env.core_sources, "#core/input/default_controller_mappings.gen.cpp", warn_duplicates=False) +env.add_source_files(env.core_sources, gensource) diff --git a/editor/SCsub b/editor/SCsub index d149cc627320..e8d417319a82 100644 --- a/editor/SCsub +++ b/editor/SCsub @@ -101,6 +101,7 @@ if env["tools"]: ) env.add_source_files(env.editor_sources, "*.cpp") + env.add_source_files(env.editor_sources, "register_exporters.gen.cpp") SConscript("debugger/SCsub") SConscript("fileserver/SCsub") diff --git a/methods.py b/methods.py index 0e71adb40d1d..428405fb0435 100644 --- a/methods.py +++ b/methods.py @@ -14,7 +14,7 @@ from platform_methods import run_in_subprocess -def add_source_files(self, sources, files, warn_duplicates=True): +def add_source_files(self, sources, files): # Convert string to list of absolute paths (including expanding wildcard) if isinstance(files, (str, bytes)): # Keep SCons project-absolute path as they are (no wildcard support) @@ -24,17 +24,20 @@ def add_source_files(self, sources, files, warn_duplicates=True): return files = [files] else: + # Exclude .gen.cpp files from globbing, to avoid including obsolete ones. + # They should instead be added manually. + skip_gen_cpp = "*" in files dir_path = self.Dir(".").abspath files = sorted(glob.glob(dir_path + "/" + files)) + if skip_gen_cpp: + files = [f for f in files if not f.endswith(".gen.cpp")] # Add each path as compiled Object following environment (self) configuration for path in files: obj = self.Object(path) if obj in sources: - if warn_duplicates: - print('WARNING: Object "{}" already included in environment sources.'.format(obj)) - else: - continue + print('WARNING: Object "{}" already included in environment sources.'.format(obj)) + continue sources.append(obj)