godot/modules/cvtt/SCsub

#!/usr/bin/env python

Import("env")
Import("env_modules")

env_cvtt = env_modules.Clone()

# Thirdparty source files

thirdparty_obj = []

thirdparty_dir = "#thirdparty/cvtt/"
thirdparty_sources = [
    "ConvectionKernels.cpp",
]

thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]

env_cvtt.Prepend(CPPPATH=[thirdparty_dir])

env_thirdparty = env_cvtt.Clone()
env_thirdparty.disable_warnings()
env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)
env.modules_sources += thirdparty_obj

# Godot source files

module_obj = []

env_cvtt.add_source_files(module_obj, "*.cpp")
env.modules_sources += module_obj

# Needed to force rebuilding the module files when the thirdparty library is updated.
env.Depends(module_obj, thirdparty_obj)
BPTC support 2018-08-22 10:56:04 +08:00			`#!/usr/bin/env python`

SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted. 2020-03-30 14:28:32 +08:00			`Import("env")`
			`Import("env_modules")`
BPTC support 2018-08-22 10:56:04 +08:00
			`env_cvtt = env_modules.Clone()`

			`# Thirdparty source files`
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate. 2020-12-17 23:01:36 +08:00
			`thirdparty_obj = []`

Allow building cvtt with system squish It looks like the SCsub for cvtt was copied from squish and it left the `if env['build_squish']:` line intact. This means that using `scons builtin_squish=no modules/cvtt` would fail and overal builds would also fail because they'd fail to find `ConvectionKernels.h` 2019-09-23 17:53:29 +08:00			`thirdparty_dir = "#thirdparty/cvtt/"`
			`thirdparty_sources = [`
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted. 2020-03-30 14:28:32 +08:00			`"ConvectionKernels.cpp",`
Allow building cvtt with system squish It looks like the SCsub for cvtt was copied from squish and it left the `if env['build_squish']:` line intact. This means that using `scons builtin_squish=no modules/cvtt` would fail and overal builds would also fail because they'd fail to find `ConvectionKernels.h` 2019-09-23 17:53:29 +08:00			`]`
BPTC support 2018-08-22 10:56:04 +08:00
Allow building cvtt with system squish It looks like the SCsub for cvtt was copied from squish and it left the `if env['build_squish']:` line intact. This means that using `scons builtin_squish=no modules/cvtt` would fail and overal builds would also fail because they'd fail to find `ConvectionKernels.h` 2019-09-23 17:53:29 +08:00			`thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]`
BPTC support 2018-08-22 10:56:04 +08:00
Allow building cvtt with system squish It looks like the SCsub for cvtt was copied from squish and it left the `if env['build_squish']:` line intact. This means that using `scons builtin_squish=no modules/cvtt` would fail and overal builds would also fail because they'd fail to find `ConvectionKernels.h` 2019-09-23 17:53:29 +08:00			`env_cvtt.Prepend(CPPPATH=[thirdparty_dir])`
BPTC support 2018-08-22 10:56:04 +08:00
Allow building cvtt with system squish It looks like the SCsub for cvtt was copied from squish and it left the `if env['build_squish']:` line intact. This means that using `scons builtin_squish=no modules/cvtt` would fail and overal builds would also fail because they'd fail to find `ConvectionKernels.h` 2019-09-23 17:53:29 +08:00			`env_thirdparty = env_cvtt.Clone()`
			`env_thirdparty.disable_warnings()`
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate. 2020-12-17 23:01:36 +08:00			`env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)`
			`env.modules_sources += thirdparty_obj`
SCons: Build thirdparty code in own env, disable warnings Also remove unnecessary `Export('env')` in other SCsubs, Export should only be used when exporting new objects. 2018-09-28 19:29:52 +08:00
BPTC support 2018-08-22 10:56:04 +08:00			`# Godot source files`
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate. 2020-12-17 23:01:36 +08:00
			`module_obj = []`

			`env_cvtt.add_source_files(module_obj, "*.cpp")`
			`env.modules_sources += module_obj`

			`# Needed to force rebuilding the module files when the thirdparty library is updated.`
			`env.Depends(module_obj, thirdparty_obj)`