39facb35a0
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.
124 lines
4.5 KiB
Python
124 lines
4.5 KiB
Python
#!/usr/bin/env python
|
|
|
|
Import("env")
|
|
|
|
env.editor_sources = []
|
|
|
|
import os
|
|
import glob
|
|
import editor_builders
|
|
|
|
|
|
def _make_doc_data_class_path(to_path):
|
|
# NOTE: It is safe to generate this file here, since this is still executed serially
|
|
g = open(os.path.join(to_path, "doc_data_class_path.gen.h"), "w", encoding="utf-8")
|
|
g.write("static const int _doc_data_class_path_count = " + str(len(env.doc_class_path)) + ";\n")
|
|
g.write("struct _DocDataClassPath { const char* name; const char* path; };\n")
|
|
|
|
g.write("static const _DocDataClassPath _doc_data_class_paths[" + str(len(env.doc_class_path) + 1) + "] = {\n")
|
|
for c in sorted(env.doc_class_path):
|
|
g.write('\t{"' + c + '", "' + env.doc_class_path[c] + '"},\n')
|
|
g.write("\t{nullptr, nullptr}\n")
|
|
g.write("};\n")
|
|
|
|
g.close()
|
|
|
|
|
|
if env.editor_build:
|
|
# Register exporters
|
|
reg_exporters_inc = '#include "register_exporters.h"\n'
|
|
reg_exporters = "void register_exporters() {\n"
|
|
for e in env.platform_exporters:
|
|
# Glob all .cpp files in export folder
|
|
files = Glob("#platform/" + e + "/export/" + "*.cpp")
|
|
env.add_source_files(env.editor_sources, files)
|
|
|
|
reg_exporters += "\tregister_" + e + "_exporter();\n"
|
|
reg_exporters_inc += '#include "platform/' + e + '/export/export.h"\n'
|
|
reg_exporters += "}\n"
|
|
|
|
# NOTE: It is safe to generate this file here, since this is still executed serially
|
|
with open("register_exporters.gen.cpp", "w", encoding="utf-8") as f:
|
|
f.write(reg_exporters_inc)
|
|
f.write(reg_exporters)
|
|
|
|
# Core API documentation.
|
|
docs = []
|
|
docs += Glob("#doc/classes/*.xml")
|
|
|
|
# Module API documentation.
|
|
module_dirs = []
|
|
for d in env.doc_class_path.values():
|
|
if d not in module_dirs:
|
|
module_dirs.append(d)
|
|
|
|
for d in module_dirs:
|
|
if not os.path.isabs(d):
|
|
docs += Glob("#" + d + "/*.xml") # Built-in.
|
|
else:
|
|
docs += Glob(d + "/*.xml") # Custom.
|
|
|
|
_make_doc_data_class_path(env.Dir("#editor").abspath)
|
|
|
|
docs = sorted(docs)
|
|
env.Depends("#editor/doc_data_compressed.gen.h", docs)
|
|
env.CommandNoCache(
|
|
"#editor/doc_data_compressed.gen.h",
|
|
docs,
|
|
env.Run(editor_builders.make_doc_header, "Generating documentation header."),
|
|
)
|
|
|
|
# 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
|
|
# ratio (20% for the editor UI, 10% for the class reference).
|
|
# Generated with `make include-list` for each resource.
|
|
|
|
# Editor translations
|
|
to_include = (
|
|
"ar,bg,ca,cs,de,el,eo,es_AR,es,fi,fr,gl,he,hu,id,it,ja,ko,lv,ms,nb,nl,pl,pt_BR,pt,ro,ru,sk,sv,th,tr,uk,vi,zh_CN,zh_TW"
|
|
).split(",")
|
|
tlist = [env.Dir("#editor/translations").abspath + "/" + f + ".po" for f in to_include]
|
|
env.Depends("#editor/editor_translations.gen.h", tlist)
|
|
env.CommandNoCache(
|
|
"#editor/editor_translations.gen.h",
|
|
tlist,
|
|
env.Run(editor_builders.make_editor_translations_header, "Generating editor translations header."),
|
|
)
|
|
|
|
# Documentation translations
|
|
to_include = "de,es,fr,ja,zh_CN".split(",")
|
|
tlist = [env.Dir("#doc/translations").abspath + "/" + f + ".po" for f in to_include]
|
|
env.Depends("#editor/doc_translations.gen.h", tlist)
|
|
env.CommandNoCache(
|
|
"#editor/doc_translations.gen.h",
|
|
tlist,
|
|
env.Run(editor_builders.make_doc_translations_header, "Generating translations header."),
|
|
)
|
|
|
|
# Fonts
|
|
flist = glob.glob(env.Dir("#thirdparty").abspath + "/fonts/*.ttf")
|
|
flist.extend(glob.glob(env.Dir("#thirdparty").abspath + "/fonts/*.otf"))
|
|
flist.extend(glob.glob(env.Dir("#thirdparty").abspath + "/fonts/*.woff"))
|
|
flist.extend(glob.glob(env.Dir("#thirdparty").abspath + "/fonts/*.woff2"))
|
|
flist.sort()
|
|
env.Depends("#editor/builtin_fonts.gen.h", flist)
|
|
env.CommandNoCache(
|
|
"#editor/builtin_fonts.gen.h",
|
|
flist,
|
|
env.Run(editor_builders.make_fonts_header, "Generating builtin fonts header."),
|
|
)
|
|
|
|
env.add_source_files(env.editor_sources, "*.cpp")
|
|
env.add_source_files(env.editor_sources, "register_exporters.gen.cpp")
|
|
|
|
SConscript("debugger/SCsub")
|
|
SConscript("export/SCsub")
|
|
SConscript("fileserver/SCsub")
|
|
SConscript("icons/SCsub")
|
|
SConscript("import/SCsub")
|
|
SConscript("plugins/SCsub")
|
|
|
|
lib = env.add_library("editor", env.editor_sources)
|
|
env.Prepend(LIBS=[lib])
|