virtualx-engine/modules/pvr/SCsub

#!/usr/bin/env python

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

env_pvr = env_modules.Clone()

# Thirdparty source files

thirdparty_obj = []

# Not unbundled so far since not widespread as shared library
thirdparty_dir = "#thirdparty/pvrtccompressor/"
thirdparty_sources = [
    "BitScale.cpp",
    "MortonTable.cpp",
    "PvrTcDecoder.cpp",
    "PvrTcEncoder.cpp",
    "PvrTcPacket.cpp",
]
thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]

env_pvr.Prepend(CPPPATH=[thirdparty_dir])

env_thirdparty = env_pvr.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_pvr.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)
SCsub: Add python shebang as a hint for syntax highlighting Also switch existing shebangs to "better" /usr/bin/env python. 2016-10-17 08:50:25 +02: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. (cherry picked from commit cd4e46ee65dab6baa6a143bf3b3f64244be36712) 2020-03-30 08:28:32 +02:00			`Import("env")`
			`Import("env_modules")`
dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00
modules: Clone env in each module This allows to pass include paths and flags only to a given thirdparty library, thus preventing conflicts between their files (e.g. between opus and openssl which both provide modes.h. This also has the nice effect of making the compilation command smaller for each module as it no longer related to all other modules, only the final linking brings them together. This however requires adding manually the ogg include path in opus and vorbis when building against the builtin ogg, since it is no longer in the global env. Also simplified template 'thirdparty_<module>_sources' to 'thirdparty_sources'. "Core" modules like cscript, gdscript, gridmap, ik and virtual_script still use the main env_modules, but it could be changed if need be. 2016-10-13 18:54:00 +02:00			`env_pvr = env_modules.Clone()`

dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00			`# 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. (cherry picked from commit c7b53c03ae7f7feb45a6023ee5cf764025ebb5e1) 2020-12-17 16:01:36 +01:00
			`thirdparty_obj = []`

dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00			`# Not unbundled so far since not widespread as shared library`
			`thirdparty_dir = "#thirdparty/pvrtccompressor/"`
modules: Clone env in each module This allows to pass include paths and flags only to a given thirdparty library, thus preventing conflicts between their files (e.g. between opus and openssl which both provide modes.h. This also has the nice effect of making the compilation command smaller for each module as it no longer related to all other modules, only the final linking brings them together. This however requires adding manually the ogg include path in opus and vorbis when building against the builtin ogg, since it is no longer in the global env. Also simplified template 'thirdparty_<module>_sources' to 'thirdparty_sources'. "Core" modules like cscript, gdscript, gridmap, ik and virtual_script still use the main env_modules, but it could be changed if need be. 2016-10-13 18:54:00 +02:00			`thirdparty_sources = [`
style: Start applying PEP8 to Python files, indentation issues Done with `autopep8 --select=E1`, fixes: - E101 - Reindent all lines. - E112 - Fix under-indented comments. - E113 - Fix over-indented comments. - E115 - Fix under-indented comments. - E116 - Fix over-indented comments. - E121 - Fix a badly indented line. - E122 - Fix a badly indented line. - E123 - Fix a badly indented line. - E124 - Fix a badly indented line. - E125 - Fix indentation undistinguish from the next logical line. - E126 - Fix a badly indented line. - E127 - Fix a badly indented line. - E128 - Fix a badly indented line. - E129 - Fix a badly indented line. 2016-10-30 18:44:57 +01:00			`"BitScale.cpp",`
			`"MortonTable.cpp",`
			`"PvrTcDecoder.cpp",`
			`"PvrTcEncoder.cpp",`
			`"PvrTcPacket.cpp",`
dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00			`]`
modules: Clone env in each module This allows to pass include paths and flags only to a given thirdparty library, thus preventing conflicts between their files (e.g. between opus and openssl which both provide modes.h. This also has the nice effect of making the compilation command smaller for each module as it no longer related to all other modules, only the final linking brings them together. This however requires adding manually the ogg include path in opus and vorbis when building against the builtin ogg, since it is no longer in the global env. Also simplified template 'thirdparty_<module>_sources' to 'thirdparty_sources'. "Core" modules like cscript, gdscript, gridmap, ik and virtual_script still use the main env_modules, but it could be changed if need be. 2016-10-13 18:54:00 +02:00			`thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]`
dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00
SCons: Always use env.Prepend for CPPPATH Include paths are processed from left to right, so we use Prepend to ensure that paths to bundled thirdparty files will have precedence over system paths (e.g. `/usr/include` should have lowest priority). 2019-04-30 13:12:02 +02:00			`env_pvr.Prepend(CPPPATH=[thirdparty_dir])`
dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02:00
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 13:29:52 +02:00			`env_thirdparty = env_pvr.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. (cherry picked from commit c7b53c03ae7f7feb45a6023ee5cf764025ebb5e1) 2020-12-17 16:01:36 +01: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 13:29:52 +02:00
dds/etc1/pbm/pvr: Make those modules and split thirdparty files They are not particularly packaged in Linux distros so we do not facilitate unbundling via SCons. There could be done if/when there is interest. Also s/pnm/pbm/, long-lived typo :) 2016-10-11 20:44:26 +02: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. (cherry picked from commit c7b53c03ae7f7feb45a6023ee5cf764025ebb5e1) 2020-12-17 16:01:36 +01:00
			`module_obj = []`

			`env_pvr.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)`