2016-10-17 06:50:25 +00:00
|
|
|
#!/usr/bin/env python
|
2024-06-11 20:19:07 +00:00
|
|
|
from misc.utility.scons_hints import *
|
2016-10-17 06:50:25 +00:00
|
|
|
|
2020-03-30 06:28:32 +00:00
|
|
|
Import("env")
|
2018-09-28 11:29:52 +00:00
|
|
|
|
2017-02-08 23:07:44 +00:00
|
|
|
env.editor_sources = []
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2020-03-08 16:34:09 +00:00
|
|
|
import glob
|
2024-05-21 13:14:59 +00:00
|
|
|
import os
|
|
|
|
|
2018-03-17 22:23:55 +00:00
|
|
|
import editor_builders
|
2017-02-08 23:07:44 +00:00
|
|
|
|
2024-05-21 13:14:59 +00:00
|
|
|
import methods
|
2018-03-10 17:37:33 +00:00
|
|
|
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 06:28:55 +00:00
|
|
|
if env.editor_build:
|
2024-05-03 14:44:57 +00:00
|
|
|
# Generate doc data paths
|
|
|
|
def doc_data_class_path_builder(target, source, env):
|
|
|
|
paths = dict(sorted(source[0].read().items()))
|
|
|
|
data = "\n".join([f'\t{{"{key}", "{value}"}},' for key, value in paths.items()])
|
|
|
|
with methods.generated_wrapper(target) as file:
|
|
|
|
file.write(
|
|
|
|
f"""\
|
|
|
|
static const int _doc_data_class_path_count = {len(paths)};
|
|
|
|
|
|
|
|
struct _DocDataClassPath {{
|
|
|
|
const char *name;
|
|
|
|
const char *path;
|
|
|
|
}};
|
|
|
|
|
|
|
|
static const _DocDataClassPath _doc_data_class_paths[{len(env.doc_class_path) + 1}] = {{
|
|
|
|
{data}
|
|
|
|
{{nullptr, nullptr}},
|
|
|
|
}};
|
|
|
|
"""
|
|
|
|
)
|
|
|
|
|
|
|
|
env.CommandNoCache("doc_data_class_path.gen.h", env.Value(env.doc_class_path), env.Run(doc_data_class_path_builder))
|
|
|
|
|
2017-02-08 23:07:44 +00:00
|
|
|
# Register exporters
|
2024-05-03 14:44:57 +00:00
|
|
|
def register_exporters_builder(target, source, env):
|
|
|
|
platforms = source[0].read()
|
|
|
|
exp_inc = "\n".join([f'#include "platform/{p}/export/export.h"' for p in platforms])
|
|
|
|
exp_reg = "\n".join([f"\tregister_{p}_exporter();" for p in platforms])
|
|
|
|
exp_type = "\n".join([f"\tregister_{p}_exporter_types();" for p in platforms])
|
|
|
|
with methods.generated_wrapper(target) as file:
|
|
|
|
file.write(
|
|
|
|
f"""\
|
|
|
|
#include "register_exporters.h"
|
|
|
|
|
|
|
|
{exp_inc}
|
|
|
|
|
|
|
|
void register_exporters() {{
|
|
|
|
{exp_reg}
|
|
|
|
}}
|
|
|
|
|
|
|
|
void register_exporter_types() {{
|
|
|
|
{exp_type}
|
|
|
|
}}
|
|
|
|
"""
|
|
|
|
)
|
|
|
|
|
|
|
|
gen_exporters = env.CommandNoCache(
|
|
|
|
"register_exporters.gen.cpp", env.Value(env.platform_exporters), env.Run(register_exporters_builder)
|
|
|
|
)
|
2016-10-30 17:44:57 +00:00
|
|
|
for e in env.platform_exporters:
|
2023-05-17 15:22:26 +00:00
|
|
|
# Add all .cpp files in export folder
|
2024-05-03 14:44:57 +00:00
|
|
|
env.add_source_files(env.editor_sources, f"../platform/{e}/export/*.cpp")
|
2016-10-30 17:44:57 +00:00
|
|
|
|
2020-03-08 16:34:09 +00:00
|
|
|
# Core API documentation.
|
2017-10-21 17:31:23 +00:00
|
|
|
docs = []
|
2020-03-08 16:34:09 +00:00
|
|
|
docs += Glob("#doc/classes/*.xml")
|
2017-11-16 17:53:54 +00:00
|
|
|
|
2020-03-08 16:34:09 +00:00
|
|
|
# Module API documentation.
|
|
|
|
module_dirs = []
|
|
|
|
for d in env.doc_class_path.values():
|
|
|
|
if d not in module_dirs:
|
|
|
|
module_dirs.append(d)
|
2017-11-16 17:53:54 +00:00
|
|
|
|
2020-03-08 16:34:09 +00:00
|
|
|
for d in module_dirs:
|
|
|
|
if not os.path.isabs(d):
|
|
|
|
docs += Glob("#" + d + "/*.xml") # Built-in.
|
|
|
|
else:
|
|
|
|
docs += Glob(d + "/*.xml") # Custom.
|
2017-09-12 20:42:36 +00:00
|
|
|
|
2017-11-15 19:16:51 +00:00
|
|
|
docs = sorted(docs)
|
2017-06-23 15:03:41 +00:00
|
|
|
env.Depends("#editor/doc_data_compressed.gen.h", docs)
|
2020-07-27 18:00:26 +00:00
|
|
|
env.CommandNoCache(
|
|
|
|
"#editor/doc_data_compressed.gen.h",
|
|
|
|
docs,
|
2023-11-20 20:31:56 +00:00
|
|
|
env.Run(editor_builders.make_doc_header),
|
2020-07-27 18:00:26 +00:00
|
|
|
)
|
2018-03-17 22:23:55 +00:00
|
|
|
|
2021-10-20 11:47:50 +00:00
|
|
|
# Editor interface and class reference translations incur a significant size
|
|
|
|
# cost for the editor binary (see godot-proposals#3421).
|
|
|
|
# To limit it, we only include translations with a high enough completion
|
2022-04-25 15:14:49 +00:00
|
|
|
# ratio (20% for the editor UI, 10% for the class reference).
|
2021-10-20 11:47:50 +00:00
|
|
|
# Generated with `make include-list` for each resource.
|
2016-10-30 17:44:57 +00:00
|
|
|
|
2020-03-18 17:34:36 +00:00
|
|
|
# Editor translations
|
2022-12-27 02:58:01 +00:00
|
|
|
tlist = glob.glob(env.Dir("#editor/translations/editor").abspath + "/*.po")
|
2020-03-30 06:28:32 +00:00
|
|
|
env.Depends("#editor/editor_translations.gen.h", tlist)
|
|
|
|
env.CommandNoCache(
|
2020-07-27 18:00:26 +00:00
|
|
|
"#editor/editor_translations.gen.h",
|
|
|
|
tlist,
|
2023-11-20 20:31:56 +00:00
|
|
|
env.Run(editor_builders.make_editor_translations_header),
|
2020-03-30 06:28:32 +00:00
|
|
|
)
|
2020-03-18 17:34:36 +00:00
|
|
|
|
2022-12-27 02:58:01 +00:00
|
|
|
# Property translations
|
|
|
|
tlist = glob.glob(env.Dir("#editor/translations/properties").abspath + "/*.po")
|
|
|
|
env.Depends("#editor/property_translations.gen.h", tlist)
|
|
|
|
env.CommandNoCache(
|
|
|
|
"#editor/property_translations.gen.h",
|
|
|
|
tlist,
|
2023-11-20 20:31:56 +00:00
|
|
|
env.Run(editor_builders.make_property_translations_header),
|
2022-12-27 02:58:01 +00:00
|
|
|
)
|
|
|
|
|
2020-03-18 17:34:36 +00:00
|
|
|
# Documentation translations
|
2022-12-27 02:58:01 +00:00
|
|
|
tlist = glob.glob(env.Dir("#doc/translations").abspath + "/*.po")
|
2020-03-30 06:28:32 +00:00
|
|
|
env.Depends("#editor/doc_translations.gen.h", tlist)
|
|
|
|
env.CommandNoCache(
|
2020-07-27 18:00:26 +00:00
|
|
|
"#editor/doc_translations.gen.h",
|
|
|
|
tlist,
|
2023-11-20 20:31:56 +00:00
|
|
|
env.Run(editor_builders.make_doc_translations_header),
|
2020-03-30 06:28:32 +00:00
|
|
|
)
|
2016-10-30 17:44:57 +00:00
|
|
|
|
2023-12-15 23:56:06 +00:00
|
|
|
# Extractable translations
|
|
|
|
tlist = glob.glob(env.Dir("#editor/translations/extractable").abspath + "/*.po")
|
2024-03-06 19:10:23 +00:00
|
|
|
tlist.extend(glob.glob(env.Dir("#editor/translations/extractable").abspath + "/extractable.pot"))
|
2023-12-15 23:56:06 +00:00
|
|
|
env.Depends("#editor/extractable_translations.gen.h", tlist)
|
|
|
|
env.CommandNoCache(
|
|
|
|
"#editor/extractable_translations.gen.h",
|
|
|
|
tlist,
|
2023-11-20 20:31:56 +00:00
|
|
|
env.Run(editor_builders.make_extractable_translations_header),
|
2023-12-15 23:56:06 +00:00
|
|
|
)
|
|
|
|
|
2017-02-08 23:07:44 +00:00
|
|
|
env.add_source_files(env.editor_sources, "*.cpp")
|
2024-05-03 14:44:57 +00:00
|
|
|
env.add_source_files(env.editor_sources, gen_exporters)
|
2017-02-08 23:07:44 +00:00
|
|
|
|
2020-03-30 06:28:32 +00:00
|
|
|
SConscript("debugger/SCsub")
|
2022-07-17 17:24:37 +00:00
|
|
|
SConscript("export/SCsub")
|
2023-04-07 16:59:49 +00:00
|
|
|
SConscript("gui/SCsub")
|
2020-03-30 06:28:32 +00:00
|
|
|
SConscript("icons/SCsub")
|
|
|
|
SConscript("import/SCsub")
|
|
|
|
SConscript("plugins/SCsub")
|
2024-01-16 18:50:38 +00:00
|
|
|
SConscript("project_manager/SCsub")
|
2024-01-15 12:14:55 +00:00
|
|
|
SConscript("themes/SCsub")
|
2017-02-08 23:07:44 +00:00
|
|
|
|
2017-11-28 20:27:57 +00:00
|
|
|
lib = env.add_library("editor", env.editor_sources)
|
2017-02-08 23:07:44 +00:00
|
|
|
env.Prepend(LIBS=[lib])
|