a96f0e98d7
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.
98 lines
3.4 KiB
Python
98 lines
3.4 KiB
Python
#!/usr/bin/env python
|
|
|
|
Import("env")
|
|
|
|
env.editor_sources = []
|
|
|
|
import os
|
|
import os.path
|
|
import glob
|
|
from platform_methods import run_in_subprocess
|
|
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["tools"]:
|
|
# Register exporters
|
|
reg_exporters_inc = '#include "register_exporters.h"\n'
|
|
reg_exporters = "void register_exporters() {\n"
|
|
for e in env.platform_exporters:
|
|
env.add_source_files(env.editor_sources, "#platform/" + e + "/export/export.cpp")
|
|
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(os.path.join(env.Dir("#").abspath, "editor"))
|
|
|
|
docs = sorted(docs)
|
|
env.Depends("#editor/doc_data_compressed.gen.h", docs)
|
|
env.CommandNoCache("#editor/doc_data_compressed.gen.h", docs, run_in_subprocess(editor_builders.make_doc_header))
|
|
|
|
path = env.Dir(".").abspath
|
|
|
|
# Editor translations
|
|
tlist = glob.glob(path + "/translations/*.po")
|
|
env.Depends("#editor/editor_translations.gen.h", tlist)
|
|
env.CommandNoCache(
|
|
"#editor/editor_translations.gen.h", tlist, run_in_subprocess(editor_builders.make_editor_translations_header)
|
|
)
|
|
|
|
# Documentation translations
|
|
tlist = glob.glob(env.Dir("#doc").abspath + "/translations/*.po")
|
|
env.Depends("#editor/doc_translations.gen.h", tlist)
|
|
env.CommandNoCache(
|
|
"#editor/doc_translations.gen.h", tlist, run_in_subprocess(editor_builders.make_doc_translations_header)
|
|
)
|
|
|
|
# Fonts
|
|
flist = glob.glob(path + "/../thirdparty/fonts/*.ttf")
|
|
flist.extend(glob.glob(path + "/../thirdparty/fonts/*.otf"))
|
|
flist.sort()
|
|
env.Depends("#editor/builtin_fonts.gen.h", flist)
|
|
env.CommandNoCache("#editor/builtin_fonts.gen.h", flist, run_in_subprocess(editor_builders.make_fonts_header))
|
|
|
|
env.add_source_files(env.editor_sources, "*.cpp")
|
|
|
|
SConscript("debugger/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])
|