virtualx-engine/modules/modules_builders.py

"""Functions used to generate source files during build time"""


def generate_modules_enabled(target, source, env):
    with open(target[0].path, "w", encoding="utf-8", newline="\n") as f:
        for module in env.module_list:
            f.write("#define %s\n" % ("MODULE_" + module.upper() + "_ENABLED"))


def generate_modules_tests(target, source, env):
    import os

    with open(target[0].path, "w", encoding="utf-8", newline="\n") as f:
        for header in source:
            f.write('#include "%s"\n' % (os.path.normpath(header.path)))
SCons: Remove `run_in_subprocess` dependency 2024-03-11 19:05:37 +01:00			`"""Functions used to generate source files during build time"""`
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. 2020-02-06 17:28:32 +01:00

			`def generate_modules_enabled(target, source, env):`
Enforce `\n` eol for Python writes • Ensure utf-8 encoding if previously unspecified 2024-03-09 21:29:24 +01:00			`with open(target[0].path, "w", encoding="utf-8", newline="\n") as f:`
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. 2020-02-06 17:28:32 +01:00			`for module in env.module_list:`
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 08:28:32 +02:00			`f.write("#define %s\n" % ("MODULE_" + module.upper() + "_ENABLED"))`
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. 2020-02-06 17:28:32 +01:00

Enable support for C++ modules tests Modules-specific tests can be written under respective module folders. Each module should have "tests" folder created with the tests implemented as `doctest` headers, so they can be collected by the buildsystem and included directly in `tests/test_main.cpp` to be compiled. 2020-07-26 13:46:44 +02:00			`def generate_modules_tests(target, source, env):`
			`import os`

Enforce `\n` eol for Python writes • Ensure utf-8 encoding if previously unspecified 2024-03-09 21:29:24 +01:00			`with open(target[0].path, "w", encoding="utf-8", newline="\n") as f:`
SCons: Improve logic to generate `modules_tests.gen.h` This removes the need for `AlwaysBuild` by ensuring that the proper files are being tracked as `Depends`. 2022-02-08 12:39:40 +01:00			`for header in source:`
			`f.write('#include "%s"\n' % (os.path.normpath(header.path)))`