godotengine/platform/SCsub

#!/usr/bin/env python
from misc.utility.scons_hints import *

from glob import glob

import platform_builders

Import("env")

env.platform_sources = []


# Generate export icons
for platform in env.platform_exporters:
    for path in glob(f"{platform}/export/*.svg"):
        env.CommandNoCache(path.replace(".svg", "_svg.gen.h"), path, env.Run(platform_builders.export_icon_builder))


# Register platform-exclusive APIs
register_platform_apis = env.CommandNoCache(
    "register_platform_apis.gen.cpp",
    env.Value(env.platform_apis),
    env.Run(platform_builders.register_platform_apis_builder),
)
env.add_source_files(env.platform_sources, register_platform_apis)
for platform in env.platform_apis:
    env.add_source_files(env.platform_sources, f"{platform}/api/*.cpp")

lib = env.add_library("platform", env.platform_sources)
env.Prepend(LIBS=[lib])
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01:00			`#!/usr/bin/env python`
SCons: Add unobtrusive type hints in SCons files 2024-06-11 15:19:07 -05:00			`from misc.utility.scons_hints import *`
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01:00
SCons: Generate all scripts natively 2024-05-03 09:44:57 -05:00			`from glob import glob`
SCons: unify code generations routine and minimize timestamp changes Previously, all of the code generation routines would just needlessly write the same files over and over, even when not needed. This became a problem with the advent of the experimental ninja backend for SCons, which can be trivially enabled with a few lines of code and relies on timestamp changes, making it thus impractical. 2024-03-13 17:54:14 +01:00
SCons: Begin decoupling generation & build code 2025-04-21 11:07:42 -05:00			`import platform_builders`
Update pre-commit hooks configuration to use `ruff` instead of `black` 2024-05-21 15:14:59 +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. 2020-03-30 08:28:32 +02:00			`Import("env")`
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.platform_sources = []`
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01:00
SCons: Generate all scripts natively 2024-05-03 09:44:57 -05:00
			`# Generate export icons`
			`for platform in env.platform_exporters:`
			`for path in glob(f"{platform}/export/*.svg"):`
SCons: Begin decoupling generation & build code 2025-04-21 11:07:42 -05:00			`env.CommandNoCache(path.replace(".svg", "_svg.gen.h"), path, env.Run(platform_builders.export_icon_builder))`
SCons: Generate all scripts natively 2024-05-03 09:44:57 -05:00

Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01:00			`# Register platform-exclusive APIs`
SCons: Generate all scripts natively 2024-05-03 09:44:57 -05:00			`register_platform_apis = env.CommandNoCache(`
SCons: Begin decoupling generation & build code 2025-04-21 11:07:42 -05:00			`"register_platform_apis.gen.cpp",`
			`env.Value(env.platform_apis),`
			`env.Run(platform_builders.register_platform_apis_builder),`
SCons: Generate all scripts natively 2024-05-03 09:44:57 -05:00			`)`
			`env.add_source_files(env.platform_sources, register_platform_apis)`
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01:00			`for platform in env.platform_apis:`
Allow multiple platform API files 2024-10-31 16:07:01 +01:00			`env.add_source_files(env.platform_sources, f"{platform}/api/*.cpp")`
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton. 2017-11-16 01:33:48 +01: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. 2020-03-30 08:28:32 +02:00			`lib = env.add_library("platform", env.platform_sources)`
Always use lists for `LIBS` in SCons This closes #31288. 2019-08-12 22:30:57 +02:00			`env.Prepend(LIBS=[lib])`