virtualx-engine/modules/SCsub

#!/usr/bin/env python

Import("env")

import os

import modules_builders

env_modules = env.Clone()

Export("env_modules")

env.Depends("modules_enabled.gen.h", Value(env.module_list))
env.CommandNoCache("modules_enabled.gen.h", Value(env.module_list), modules_builders.generate_modules_enabled)

env.modules_sources = []
env_modules.add_source_files(env.modules_sources, "register_module_types.gen.cpp")

for name, path in env.module_list.items():
    if not os.path.isabs(path):
        SConscript(name + "/SCsub")  # Built-in.
    else:
        SConscript(path + "/SCsub")  # Custom.

if env["split_libmodules"]:
    env.split_lib("modules", env_lib=env_modules)
else:
    lib = env_modules.add_library("modules", env.modules_sources)

    env.Prepend(LIBS=[lib])
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`

Add `custom_modules` build option to compile external user modules This patch adds ability to include external, user-defined C++ modules to be compiled as part of Godot via `custom_modules` build option which can be passed to `scons`. ``` scons platform=x11 tools=yes custom_modules="../project/modules" ``` Features: - detects all available modules under `custom_modules` directory the same way as it does for built-in modules (not recursive); - works with both relative and absolute paths on the filesystem; - multiple search paths can be specified as a comma-separated list. Module custom documentation and editor icons collection and generation process is adapted to work with absolute paths needed by such modules. Also fixed doctool bug mixing absolute and relative paths respectively. Implementation details: - `env.module_list` is a dictionary now, which holds both module name as key and either a relative or absolute path to a module as a value. - `methods.detect_modules` is run twice: once for built-in modules, and second for external modules, all combined later. - `methods.detect_modules` was not doing what it says on the tin. It is split into `detect_modules` which collects a list of available modules and `write_modules` which generates `register_types` sources for each. - whether a module is built-in or external is distinguished by relative or absolute paths respectively. `custom_modules` scons converter ensures that the path is absolute even if relative path is supplied, including expanding user paths and symbolic links. - treats the parent directory as if it was Godot's base directory, so that there's no need to change include paths in cases where custom modules are included as dependencies in other modules. (cherry picked from commit a96f0e98d74839fecfe6ac553aa5a5521e69ddfd) 2020-04-04 13:46:15 +02:00			`Import("env")`

			`import os`
Remove trailing spaces 2016-04-02 20:26:12 +02:00
SCons: Generate header with info on which modules are enabled We already had `MODULE__ENABLED` defines but only in the modules environment, and a few custom `_ENABLED` defines in the main env when we needed the information in core. Now this is defined in a single header which can be included in the files that need this information. (cherry picked from commit b7297fb39ca7a55390f9390666bd29803adc827f) 2020-02-06 17:28:32 +01:00			`import modules_builders`

Remove trailing spaces 2016-04-02 20:26:12 +02:00			`env_modules = env.Clone()`

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			`Export("env_modules")`
Remove trailing spaces 2016-04-02 20:26:12 +02:00
Add env.Depends to modules_enabled.gen.h generator Sometimes scons doesn't detects that a new module is being added. This commit fix it. (cherry picked from commit b667e72adf372321775a45b56114b74d5d6da2a5) 2021-05-05 11:35:33 +02:00			`env.Depends("modules_enabled.gen.h", Value(env.module_list))`
SCons: Generate header with info on which modules are enabled We already had `MODULE__ENABLED` defines but only in the modules environment, and a few custom `_ENABLED` defines in the main env when we needed the information in core. Now this is defined in a single header which can be included in the files that need this information. (cherry picked from commit b7297fb39ca7a55390f9390666bd29803adc827f) 2020-02-06 17:28:32 +01:00			`env.CommandNoCache("modules_enabled.gen.h", Value(env.module_list), modules_builders.generate_modules_enabled)`
SCons: Fix uses of [].append instead of env.add_source_files() Also added support for SCons project-absolute paths (starting with #) and warning about duplicates in add_source_files(), and fixed default_controller_mappings.gen.cpp being included twice after first build due to *.cpp globbing. Part of #30270. 2019-07-22 13:57:39 +02:00
SCons: Generate header with info on which modules are enabled We already had `MODULE__ENABLED` defines but only in the modules environment, and a few custom `_ENABLED` defines in the main env when we needed the information in core. Now this is defined in a single header which can be included in the files that need this information. (cherry picked from commit b7297fb39ca7a55390f9390666bd29803adc827f) 2020-02-06 17:28:32 +01:00			`env.modules_sources = []`
SCons: Fix uses of [].append instead of env.add_source_files() Also added support for SCons project-absolute paths (starting with #) and warning about duplicates in add_source_files(), and fixed default_controller_mappings.gen.cpp being included twice after first build due to *.cpp globbing. Part of #30270. 2019-07-22 13:57:39 +02:00			`env_modules.add_source_files(env.modules_sources, "register_module_types.gen.cpp")`
Remove trailing spaces 2016-04-02 20:26:12 +02:00
Add `custom_modules` build option to compile external user modules This patch adds ability to include external, user-defined C++ modules to be compiled as part of Godot via `custom_modules` build option which can be passed to `scons`. ``` scons platform=x11 tools=yes custom_modules="../project/modules" ``` Features: - detects all available modules under `custom_modules` directory the same way as it does for built-in modules (not recursive); - works with both relative and absolute paths on the filesystem; - multiple search paths can be specified as a comma-separated list. Module custom documentation and editor icons collection and generation process is adapted to work with absolute paths needed by such modules. Also fixed doctool bug mixing absolute and relative paths respectively. Implementation details: - `env.module_list` is a dictionary now, which holds both module name as key and either a relative or absolute path to a module as a value. - `methods.detect_modules` is run twice: once for built-in modules, and second for external modules, all combined later. - `methods.detect_modules` was not doing what it says on the tin. It is split into `detect_modules` which collects a list of available modules and `write_modules` which generates `register_types` sources for each. - whether a module is built-in or external is distinguished by relative or absolute paths respectively. `custom_modules` scons converter ensures that the path is absolute even if relative path is supplied, including expanding user paths and symbolic links. - treats the parent directory as if it was Godot's base directory, so that there's no need to change include paths in cases where custom modules are included as dependencies in other modules. (cherry picked from commit a96f0e98d74839fecfe6ac553aa5a5521e69ddfd) 2020-04-04 13:46:15 +02:00			`for name, path in env.module_list.items():`
			`if not os.path.isabs(path):`
			`SConscript(name + "/SCsub") # Built-in.`
			`else:`
			`SConscript(path + "/SCsub") # Custom.`
Remove trailing spaces 2016-04-02 20:26:12 +02:00
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			`if env["split_libmodules"]:`
			`env.split_lib("modules", env_lib=env_modules)`
adding option to split modules library 2018-01-19 01:26:04 +01:00			`else:`
SCsub: fix mixed indentation 2018-01-19 01:35:02 +01:00			`lib = env_modules.add_library("modules", env.modules_sources)`

			`env.Prepend(LIBS=[lib])`