You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-09 12:50:35 +00: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.
This commit is contained in:
Rémi Verschelde
@@ -5,6 +5,7 @@ import sys
|
||||
# This file is mostly based on platform/x11/detect.py.
|
||||
# If editing this file, make sure to apply relevant changes here too.
|
||||
|
||||
|
||||
def is_active():
|
||||
return True
|
||||
|
||||
@@ -14,14 +15,14 @@ def get_name():
|
||||
|
||||
|
||||
def get_program_suffix():
|
||||
if (sys.platform == "darwin"):
|
||||
if sys.platform == "darwin":
|
||||
return "osx"
|
||||
return "linuxbsd"
|
||||
|
||||
|
||||
def can_build():
|
||||
|
||||
if (os.name != "posix"):
|
||||
if os.name != "posix":
|
||||
return False
|
||||
|
||||
return True
|
||||
@@ -29,17 +30,18 @@ def can_build():
|
||||
|
||||
def get_opts():
|
||||
from SCons.Variables import BoolVariable, EnumVariable
|
||||
|
||||
return [
|
||||
BoolVariable('use_llvm', 'Use the LLVM compiler', False),
|
||||
BoolVariable('use_static_cpp', 'Link libgcc and libstdc++ statically for better portability', False),
|
||||
BoolVariable('use_coverage', 'Test Godot coverage', False),
|
||||
BoolVariable('use_ubsan', 'Use LLVM/GCC compiler undefined behavior sanitizer (UBSAN)', False),
|
||||
BoolVariable('use_asan', 'Use LLVM/GCC compiler address sanitizer (ASAN))', False),
|
||||
BoolVariable('use_lsan', 'Use LLVM/GCC compiler leak sanitizer (LSAN))', False),
|
||||
BoolVariable('use_tsan', 'Use LLVM/GCC compiler thread sanitizer (TSAN))', False),
|
||||
EnumVariable('debug_symbols', 'Add debugging symbols to release builds', 'yes', ('yes', 'no', 'full')),
|
||||
BoolVariable('separate_debug_symbols', 'Create a separate file containing debugging symbols', False),
|
||||
BoolVariable('execinfo', 'Use libexecinfo on systems where glibc is not available', False),
|
||||
BoolVariable("use_llvm", "Use the LLVM compiler", False),
|
||||
BoolVariable("use_static_cpp", "Link libgcc and libstdc++ statically for better portability", False),
|
||||
BoolVariable("use_coverage", "Test Godot coverage", False),
|
||||
BoolVariable("use_ubsan", "Use LLVM/GCC compiler undefined behavior sanitizer (UBSAN)", False),
|
||||
BoolVariable("use_asan", "Use LLVM/GCC compiler address sanitizer (ASAN))", False),
|
||||
BoolVariable("use_lsan", "Use LLVM/GCC compiler leak sanitizer (LSAN))", False),
|
||||
BoolVariable("use_tsan", "Use LLVM/GCC compiler thread sanitizer (TSAN))", False),
|
||||
EnumVariable("debug_symbols", "Add debugging symbols to release builds", "yes", ("yes", "no", "full")),
|
||||
BoolVariable("separate_debug_symbols", "Create a separate file containing debugging symbols", False),
|
||||
BoolVariable("execinfo", "Use libexecinfo on systems where glibc is not available", False),
|
||||
]
|
||||
|
||||
|
||||
@@ -52,89 +54,89 @@ def configure(env):
|
||||
|
||||
## Build type
|
||||
|
||||
if (env["target"] == "release"):
|
||||
if (env["optimize"] == "speed"): #optimize for speed (default)
|
||||
env.Prepend(CCFLAGS=['-O3'])
|
||||
else: #optimize for size
|
||||
env.Prepend(CCFLAGS=['-Os'])
|
||||
if env["target"] == "release":
|
||||
if env["optimize"] == "speed": # optimize for speed (default)
|
||||
env.Prepend(CCFLAGS=["-O3"])
|
||||
else: # optimize for size
|
||||
env.Prepend(CCFLAGS=["-Os"])
|
||||
|
||||
if (env["debug_symbols"] == "yes"):
|
||||
env.Prepend(CCFLAGS=['-g1'])
|
||||
if (env["debug_symbols"] == "full"):
|
||||
env.Prepend(CCFLAGS=['-g2'])
|
||||
if env["debug_symbols"] == "yes":
|
||||
env.Prepend(CCFLAGS=["-g1"])
|
||||
if env["debug_symbols"] == "full":
|
||||
env.Prepend(CCFLAGS=["-g2"])
|
||||
|
||||
elif (env["target"] == "release_debug"):
|
||||
if (env["optimize"] == "speed"): #optimize for speed (default)
|
||||
env.Prepend(CCFLAGS=['-O2'])
|
||||
else: #optimize for size
|
||||
env.Prepend(CCFLAGS=['-Os'])
|
||||
env.Prepend(CPPDEFINES=['DEBUG_ENABLED'])
|
||||
elif env["target"] == "release_debug":
|
||||
if env["optimize"] == "speed": # optimize for speed (default)
|
||||
env.Prepend(CCFLAGS=["-O2"])
|
||||
else: # optimize for size
|
||||
env.Prepend(CCFLAGS=["-Os"])
|
||||
env.Prepend(CPPDEFINES=["DEBUG_ENABLED"])
|
||||
|
||||
if (env["debug_symbols"] == "yes"):
|
||||
env.Prepend(CCFLAGS=['-g1'])
|
||||
if (env["debug_symbols"] == "full"):
|
||||
env.Prepend(CCFLAGS=['-g2'])
|
||||
if env["debug_symbols"] == "yes":
|
||||
env.Prepend(CCFLAGS=["-g1"])
|
||||
if env["debug_symbols"] == "full":
|
||||
env.Prepend(CCFLAGS=["-g2"])
|
||||
|
||||
elif (env["target"] == "debug"):
|
||||
env.Prepend(CCFLAGS=['-g3'])
|
||||
env.Prepend(CPPDEFINES=['DEBUG_ENABLED', 'DEBUG_MEMORY_ENABLED'])
|
||||
env.Append(LINKFLAGS=['-rdynamic'])
|
||||
elif env["target"] == "debug":
|
||||
env.Prepend(CCFLAGS=["-g3"])
|
||||
env.Prepend(CPPDEFINES=["DEBUG_ENABLED", "DEBUG_MEMORY_ENABLED"])
|
||||
env.Append(LINKFLAGS=["-rdynamic"])
|
||||
|
||||
## Architecture
|
||||
|
||||
is64 = sys.maxsize > 2**32
|
||||
if (env["bits"] == "default"):
|
||||
is64 = sys.maxsize > 2 ** 32
|
||||
if env["bits"] == "default":
|
||||
env["bits"] = "64" if is64 else "32"
|
||||
|
||||
## Compiler configuration
|
||||
|
||||
if 'CXX' in env and 'clang' in os.path.basename(env['CXX']):
|
||||
if "CXX" in env and "clang" in os.path.basename(env["CXX"]):
|
||||
# Convenience check to enforce the use_llvm overrides when CXX is clang(++)
|
||||
env['use_llvm'] = True
|
||||
env["use_llvm"] = True
|
||||
|
||||
if env['use_llvm']:
|
||||
if ('clang++' not in os.path.basename(env['CXX'])):
|
||||
if env["use_llvm"]:
|
||||
if "clang++" not in os.path.basename(env["CXX"]):
|
||||
env["CC"] = "clang"
|
||||
env["CXX"] = "clang++"
|
||||
env["LINK"] = "clang++"
|
||||
env.Append(CPPDEFINES=['TYPED_METHOD_BIND'])
|
||||
env.Append(CPPDEFINES=["TYPED_METHOD_BIND"])
|
||||
env.extra_suffix = ".llvm" + env.extra_suffix
|
||||
|
||||
if env['use_coverage']:
|
||||
env.Append(CCFLAGS=['-ftest-coverage', '-fprofile-arcs'])
|
||||
env.Append(LINKFLAGS=['-ftest-coverage', '-fprofile-arcs'])
|
||||
if env["use_coverage"]:
|
||||
env.Append(CCFLAGS=["-ftest-coverage", "-fprofile-arcs"])
|
||||
env.Append(LINKFLAGS=["-ftest-coverage", "-fprofile-arcs"])
|
||||
|
||||
if env['use_ubsan'] or env['use_asan'] or env['use_lsan'] or env['use_tsan']:
|
||||
if env["use_ubsan"] or env["use_asan"] or env["use_lsan"] or env["use_tsan"]:
|
||||
env.extra_suffix += "s"
|
||||
|
||||
if env['use_ubsan']:
|
||||
env.Append(CCFLAGS=['-fsanitize=undefined'])
|
||||
env.Append(LINKFLAGS=['-fsanitize=undefined'])
|
||||
if env["use_ubsan"]:
|
||||
env.Append(CCFLAGS=["-fsanitize=undefined"])
|
||||
env.Append(LINKFLAGS=["-fsanitize=undefined"])
|
||||
|
||||
if env['use_asan']:
|
||||
env.Append(CCFLAGS=['-fsanitize=address'])
|
||||
env.Append(LINKFLAGS=['-fsanitize=address'])
|
||||
if env["use_asan"]:
|
||||
env.Append(CCFLAGS=["-fsanitize=address"])
|
||||
env.Append(LINKFLAGS=["-fsanitize=address"])
|
||||
|
||||
if env['use_lsan']:
|
||||
env.Append(CCFLAGS=['-fsanitize=leak'])
|
||||
env.Append(LINKFLAGS=['-fsanitize=leak'])
|
||||
if env["use_lsan"]:
|
||||
env.Append(CCFLAGS=["-fsanitize=leak"])
|
||||
env.Append(LINKFLAGS=["-fsanitize=leak"])
|
||||
|
||||
if env['use_tsan']:
|
||||
env.Append(CCFLAGS=['-fsanitize=thread'])
|
||||
env.Append(LINKFLAGS=['-fsanitize=thread'])
|
||||
if env["use_tsan"]:
|
||||
env.Append(CCFLAGS=["-fsanitize=thread"])
|
||||
env.Append(LINKFLAGS=["-fsanitize=thread"])
|
||||
|
||||
if env['use_lto']:
|
||||
env.Append(CCFLAGS=['-flto'])
|
||||
if not env['use_llvm'] and env.GetOption("num_jobs") > 1:
|
||||
env.Append(LINKFLAGS=['-flto=' + str(env.GetOption("num_jobs"))])
|
||||
if env["use_lto"]:
|
||||
env.Append(CCFLAGS=["-flto"])
|
||||
if not env["use_llvm"] and env.GetOption("num_jobs") > 1:
|
||||
env.Append(LINKFLAGS=["-flto=" + str(env.GetOption("num_jobs"))])
|
||||
else:
|
||||
env.Append(LINKFLAGS=['-flto'])
|
||||
if not env['use_llvm']:
|
||||
env['RANLIB'] = 'gcc-ranlib'
|
||||
env['AR'] = 'gcc-ar'
|
||||
env.Append(LINKFLAGS=["-flto"])
|
||||
if not env["use_llvm"]:
|
||||
env["RANLIB"] = "gcc-ranlib"
|
||||
env["AR"] = "gcc-ar"
|
||||
|
||||
env.Append(CCFLAGS=['-pipe'])
|
||||
env.Append(LINKFLAGS=['-pipe'])
|
||||
env.Append(CCFLAGS=["-pipe"])
|
||||
env.Append(LINKFLAGS=["-pipe"])
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -142,109 +144,114 @@ def configure(env):
|
||||
|
||||
# freetype depends on libpng and zlib, so bundling one of them while keeping others
|
||||
# as shared libraries leads to weird issues
|
||||
if env['builtin_freetype'] or env['builtin_libpng'] or env['builtin_zlib']:
|
||||
env['builtin_freetype'] = True
|
||||
env['builtin_libpng'] = True
|
||||
env['builtin_zlib'] = True
|
||||
if env["builtin_freetype"] or env["builtin_libpng"] or env["builtin_zlib"]:
|
||||
env["builtin_freetype"] = True
|
||||
env["builtin_libpng"] = True
|
||||
env["builtin_zlib"] = True
|
||||
|
||||
if not env['builtin_freetype']:
|
||||
env.ParseConfig('pkg-config freetype2 --cflags --libs')
|
||||
if not env["builtin_freetype"]:
|
||||
env.ParseConfig("pkg-config freetype2 --cflags --libs")
|
||||
|
||||
if not env['builtin_libpng']:
|
||||
env.ParseConfig('pkg-config libpng16 --cflags --libs')
|
||||
if not env["builtin_libpng"]:
|
||||
env.ParseConfig("pkg-config libpng16 --cflags --libs")
|
||||
|
||||
if not env['builtin_bullet']:
|
||||
if not env["builtin_bullet"]:
|
||||
# We need at least version 2.89
|
||||
import subprocess
|
||||
bullet_version = subprocess.check_output(['pkg-config', 'bullet', '--modversion']).strip()
|
||||
|
||||
bullet_version = subprocess.check_output(["pkg-config", "bullet", "--modversion"]).strip()
|
||||
if str(bullet_version) < "2.89":
|
||||
# Abort as system bullet was requested but too old
|
||||
print("Bullet: System version {0} does not match minimal requirements ({1}). Aborting.".format(bullet_version, "2.89"))
|
||||
print(
|
||||
"Bullet: System version {0} does not match minimal requirements ({1}). Aborting.".format(
|
||||
bullet_version, "2.89"
|
||||
)
|
||||
)
|
||||
sys.exit(255)
|
||||
env.ParseConfig('pkg-config bullet --cflags --libs')
|
||||
env.ParseConfig("pkg-config bullet --cflags --libs")
|
||||
|
||||
if False: # not env['builtin_assimp']:
|
||||
# FIXME: Add min version check
|
||||
env.ParseConfig('pkg-config assimp --cflags --libs')
|
||||
env.ParseConfig("pkg-config assimp --cflags --libs")
|
||||
|
||||
if not env['builtin_enet']:
|
||||
env.ParseConfig('pkg-config libenet --cflags --libs')
|
||||
if not env["builtin_enet"]:
|
||||
env.ParseConfig("pkg-config libenet --cflags --libs")
|
||||
|
||||
if not env['builtin_squish']:
|
||||
env.ParseConfig('pkg-config libsquish --cflags --libs')
|
||||
if not env["builtin_squish"]:
|
||||
env.ParseConfig("pkg-config libsquish --cflags --libs")
|
||||
|
||||
if not env['builtin_zstd']:
|
||||
env.ParseConfig('pkg-config libzstd --cflags --libs')
|
||||
if not env["builtin_zstd"]:
|
||||
env.ParseConfig("pkg-config libzstd --cflags --libs")
|
||||
|
||||
# Sound and video libraries
|
||||
# Keep the order as it triggers chained dependencies (ogg needed by others, etc.)
|
||||
|
||||
if not env['builtin_libtheora']:
|
||||
env['builtin_libogg'] = False # Needed to link against system libtheora
|
||||
env['builtin_libvorbis'] = False # Needed to link against system libtheora
|
||||
env.ParseConfig('pkg-config theora theoradec --cflags --libs')
|
||||
if not env["builtin_libtheora"]:
|
||||
env["builtin_libogg"] = False # Needed to link against system libtheora
|
||||
env["builtin_libvorbis"] = False # Needed to link against system libtheora
|
||||
env.ParseConfig("pkg-config theora theoradec --cflags --libs")
|
||||
else:
|
||||
list_of_x86 = ['x86_64', 'x86', 'i386', 'i586']
|
||||
list_of_x86 = ["x86_64", "x86", "i386", "i586"]
|
||||
if any(platform.machine() in s for s in list_of_x86):
|
||||
env["x86_libtheora_opt_gcc"] = True
|
||||
|
||||
if not env['builtin_libvpx']:
|
||||
env.ParseConfig('pkg-config vpx --cflags --libs')
|
||||
if not env["builtin_libvpx"]:
|
||||
env.ParseConfig("pkg-config vpx --cflags --libs")
|
||||
|
||||
if not env['builtin_libvorbis']:
|
||||
env['builtin_libogg'] = False # Needed to link against system libvorbis
|
||||
env.ParseConfig('pkg-config vorbis vorbisfile --cflags --libs')
|
||||
if not env["builtin_libvorbis"]:
|
||||
env["builtin_libogg"] = False # Needed to link against system libvorbis
|
||||
env.ParseConfig("pkg-config vorbis vorbisfile --cflags --libs")
|
||||
|
||||
if not env['builtin_opus']:
|
||||
env['builtin_libogg'] = False # Needed to link against system opus
|
||||
env.ParseConfig('pkg-config opus opusfile --cflags --libs')
|
||||
if not env["builtin_opus"]:
|
||||
env["builtin_libogg"] = False # Needed to link against system opus
|
||||
env.ParseConfig("pkg-config opus opusfile --cflags --libs")
|
||||
|
||||
if not env['builtin_libogg']:
|
||||
env.ParseConfig('pkg-config ogg --cflags --libs')
|
||||
if not env["builtin_libogg"]:
|
||||
env.ParseConfig("pkg-config ogg --cflags --libs")
|
||||
|
||||
if not env['builtin_libwebp']:
|
||||
env.ParseConfig('pkg-config libwebp --cflags --libs')
|
||||
if not env["builtin_libwebp"]:
|
||||
env.ParseConfig("pkg-config libwebp --cflags --libs")
|
||||
|
||||
if not env['builtin_mbedtls']:
|
||||
if not env["builtin_mbedtls"]:
|
||||
# mbedTLS does not provide a pkgconfig config yet. See https://github.com/ARMmbed/mbedtls/issues/228
|
||||
env.Append(LIBS=['mbedtls', 'mbedcrypto', 'mbedx509'])
|
||||
env.Append(LIBS=["mbedtls", "mbedcrypto", "mbedx509"])
|
||||
|
||||
if not env['builtin_wslay']:
|
||||
env.ParseConfig('pkg-config libwslay --cflags --libs')
|
||||
if not env["builtin_wslay"]:
|
||||
env.ParseConfig("pkg-config libwslay --cflags --libs")
|
||||
|
||||
if not env['builtin_miniupnpc']:
|
||||
if not env["builtin_miniupnpc"]:
|
||||
# No pkgconfig file so far, hardcode default paths.
|
||||
env.Prepend(CPPPATH=["/usr/include/miniupnpc"])
|
||||
env.Append(LIBS=["miniupnpc"])
|
||||
|
||||
# On Linux wchar_t should be 32-bits
|
||||
# 16-bit library shouldn't be required due to compiler optimisations
|
||||
if not env['builtin_pcre2']:
|
||||
env.ParseConfig('pkg-config libpcre2-32 --cflags --libs')
|
||||
if not env["builtin_pcre2"]:
|
||||
env.ParseConfig("pkg-config libpcre2-32 --cflags --libs")
|
||||
|
||||
## Flags
|
||||
|
||||
# Linkflags below this line should typically stay the last ones
|
||||
if not env['builtin_zlib']:
|
||||
env.ParseConfig('pkg-config zlib --cflags --libs')
|
||||
if not env["builtin_zlib"]:
|
||||
env.ParseConfig("pkg-config zlib --cflags --libs")
|
||||
|
||||
env.Prepend(CPPPATH=['#platform/server'])
|
||||
env.Append(CPPDEFINES=['SERVER_ENABLED', 'UNIX_ENABLED'])
|
||||
env.Prepend(CPPPATH=["#platform/server"])
|
||||
env.Append(CPPDEFINES=["SERVER_ENABLED", "UNIX_ENABLED"])
|
||||
|
||||
if (platform.system() == "Darwin"):
|
||||
env.Append(LINKFLAGS=['-framework', 'Cocoa', '-framework', 'Carbon', '-lz', '-framework', 'IOKit'])
|
||||
if platform.system() == "Darwin":
|
||||
env.Append(LINKFLAGS=["-framework", "Cocoa", "-framework", "Carbon", "-lz", "-framework", "IOKit"])
|
||||
|
||||
env.Append(LIBS=['pthread'])
|
||||
env.Append(LIBS=["pthread"])
|
||||
|
||||
if (platform.system() == "Linux"):
|
||||
env.Append(LIBS=['dl'])
|
||||
if platform.system() == "Linux":
|
||||
env.Append(LIBS=["dl"])
|
||||
|
||||
if (platform.system().find("BSD") >= 0):
|
||||
if platform.system().find("BSD") >= 0:
|
||||
env["execinfo"] = True
|
||||
|
||||
if env["execinfo"]:
|
||||
env.Append(LIBS=['execinfo'])
|
||||
env.Append(LIBS=["execinfo"])
|
||||
|
||||
# Link those statically for portability
|
||||
if env['use_static_cpp']:
|
||||
env.Append(LINKFLAGS=['-static-libgcc', '-static-libstdc++'])
|
||||
if env["use_static_cpp"]:
|
||||
env.Append(LINKFLAGS=["-static-libgcc", "-static-libstdc++"])
|
||||
|
||||
Reference in New Issue
Block a user