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.

2 files changed, 173 insertions, 122 deletions

diff --git a/platform/iphone/SCsub b/platform/iphone/SCsub
index 1f82f51888..a48629f720 100644
--- a/platform/iphone/SCsub
+++ b/platform/iphone/SCsub
@@ -1,31 +1,35 @@
 #!/usr/bin/env python
 
-Import('env')
+Import("env")
 
 iphone_lib = [
-    'godot_iphone.cpp',
-    'os_iphone.cpp',
-    'semaphore_iphone.cpp',
-    'gl_view.mm',
-    'main.m',
-    'app_delegate.mm',
-    'view_controller.mm',
-    'game_center.mm',
-    'in_app_store.mm',
-    'icloud.mm',
-    'ios.mm',
-    'vulkan_context_iphone.mm',
+    "godot_iphone.cpp",
+    "os_iphone.cpp",
+    "semaphore_iphone.cpp",
+    "gl_view.mm",
+    "main.m",
+    "app_delegate.mm",
+    "view_controller.mm",
+    "game_center.mm",
+    "in_app_store.mm",
+    "icloud.mm",
+    "ios.mm",
+    "vulkan_context_iphone.mm",
 ]
 
 env_ios = env.Clone()
-ios_lib = env_ios.add_library('iphone', iphone_lib)
+ios_lib = env_ios.add_library("iphone", iphone_lib)
+
 
 def combine_libs(target=None, source=None, env=None):
     lib_path = target[0].srcnode().abspath
     if "osxcross" in env:
-        libtool = '$IPHONEPATH/usr/bin/${ios_triple}libtool'
+        libtool = "$IPHONEPATH/usr/bin/${ios_triple}libtool"
     else:
         libtool = "$IPHONEPATH/usr/bin/libtool"
-    env.Execute(libtool + ' -static -o "' + lib_path + '" ' + ' '.join([('"' + lib.srcnode().abspath + '"') for lib in source]))
+    env.Execute(
+        libtool + ' -static -o "' + lib_path + '" ' + " ".join([('"' + lib.srcnode().abspath + '"') for lib in source])
+    )
+
 
-combine_command = env_ios.Command('#bin/libgodot' + env_ios['LIBSUFFIX'], [ios_lib] + env_ios['LIBS'], combine_libs)
+combine_command = env_ios.Command("#bin/libgodot" + env_ios["LIBSUFFIX"], [ios_lib] + env_ios["LIBS"], combine_libs)
diff --git a/platform/iphone/detect.py b/platform/iphone/detect.py
index e01950c1db..3e6c2f0ecf 100644
--- a/platform/iphone/detect.py
+++ b/platform/iphone/detect.py
@@ -2,6 +2,7 @@ import os
 import sys
 from methods import detect_darwin_sdk_path
 
+
 def is_active():
     return True
 
@@ -12,7 +13,7 @@ def get_name():
 
 def can_build():
 
-    if sys.platform == 'darwin' or ("OSXCROSS_IOS" in os.environ):
+    if sys.platform == "darwin" or ("OSXCROSS_IOS" in os.environ):
         return True
 
     return False
@@ -20,22 +21,31 @@ def can_build():
 
 def get_opts():
     from SCons.Variables import BoolVariable
+
     return [
-        ('IPHONEPATH', 'Path to iPhone toolchain', '/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain'),
-        ('IPHONESDK', 'Path to the iPhone SDK', ''),
-        BoolVariable('use_static_mvk', 'Link MoltenVK statically as Level-0 driver (better portability) or use Vulkan ICD loader (enables validation layers)', False),
-        BoolVariable('game_center', 'Support for game center', True),
-        BoolVariable('store_kit', 'Support for in-app store', True),
-        BoolVariable('icloud', 'Support for iCloud', True),
-        BoolVariable('ios_exceptions', 'Enable exceptions', False),
-        ('ios_triple', 'Triple for ios toolchain', ''),
+        (
+            "IPHONEPATH",
+            "Path to iPhone toolchain",
+            "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
+        ),
+        ("IPHONESDK", "Path to the iPhone SDK", ""),
+        BoolVariable(
+            "use_static_mvk",
+            "Link MoltenVK statically as Level-0 driver (better portability) or use Vulkan ICD loader (enables validation layers)",
+            False,
+        ),
+        BoolVariable("game_center", "Support for game center", True),
+        BoolVariable("store_kit", "Support for in-app store", True),
+        BoolVariable("icloud", "Support for iCloud", True),
+        BoolVariable("ios_exceptions", "Enable exceptions", False),
+        ("ios_triple", "Triple for ios toolchain", ""),
     ]
 
 
 def get_flags():
 
     return [
-        ('tools', False),
+        ("tools", False),
     ]
 
 
@@ -43,32 +53,32 @@ def configure(env):
 
     ## Build type
 
-    if (env["target"].startswith("release")):
-        env.Append(CPPDEFINES=['NDEBUG', ('NS_BLOCK_ASSERTIONS', 1)])
-        if (env["optimize"] == "speed"): #optimize for speed (default)
-            env.Append(CCFLAGS=['-O2', '-ftree-vectorize', '-fomit-frame-pointer'])
-            env.Append(LINKFLAGS=['-O2'])
-        else: #optimize for size
-            env.Append(CCFLAGS=['-Os', '-ftree-vectorize'])
-            env.Append(LINKFLAGS=['-Os'])
+    if env["target"].startswith("release"):
+        env.Append(CPPDEFINES=["NDEBUG", ("NS_BLOCK_ASSERTIONS", 1)])
+        if env["optimize"] == "speed":  # optimize for speed (default)
+            env.Append(CCFLAGS=["-O2", "-ftree-vectorize", "-fomit-frame-pointer"])
+            env.Append(LINKFLAGS=["-O2"])
+        else:  # optimize for size
+            env.Append(CCFLAGS=["-Os", "-ftree-vectorize"])
+            env.Append(LINKFLAGS=["-Os"])
 
         if env["target"] == "release_debug":
-            env.Append(CPPDEFINES=['DEBUG_ENABLED'])
+            env.Append(CPPDEFINES=["DEBUG_ENABLED"])
 
-    elif (env["target"] == "debug"):
-        env.Append(CCFLAGS=['-gdwarf-2', '-O0'])
-        env.Append(CPPDEFINES=['_DEBUG', ('DEBUG', 1), 'DEBUG_ENABLED', 'DEBUG_MEMORY_ENABLED'])
+    elif env["target"] == "debug":
+        env.Append(CCFLAGS=["-gdwarf-2", "-O0"])
+        env.Append(CPPDEFINES=["_DEBUG", ("DEBUG", 1), "DEBUG_ENABLED", "DEBUG_MEMORY_ENABLED"])
 
-    if (env["use_lto"]):
-        env.Append(CCFLAGS=['-flto'])
-        env.Append(LINKFLAGS=['-flto'])
+    if env["use_lto"]:
+        env.Append(CCFLAGS=["-flto"])
+        env.Append(LINKFLAGS=["-flto"])
 
     ## Architecture
     if env["arch"] == "x86":  # i386
         env["bits"] = "32"
     elif env["arch"] == "x86_64":
         env["bits"] = "64"
-    elif (env["arch"] == "arm" or env["arch"] == "arm32" or env["arch"] == "armv7" or env["bits"] == "32"):  # arm
+    elif env["arch"] == "arm" or env["arch"] == "arm32" or env["arch"] == "armv7" or env["bits"] == "32":  # arm
         env["arch"] = "arm"
         env["bits"] = "32"
     else:  # armv64
@@ -81,108 +91,145 @@ def configure(env):
     if "OSXCROSS_IOS" in os.environ:
         env["osxcross"] = True
 
-    env['ENV']['PATH'] = env['IPHONEPATH'] + "/Developer/usr/bin/:" + env['ENV']['PATH']
+    env["ENV"]["PATH"] = env["IPHONEPATH"] + "/Developer/usr/bin/:" + env["ENV"]["PATH"]
 
-    compiler_path = '$IPHONEPATH/usr/bin/${ios_triple}'
-    s_compiler_path = '$IPHONEPATH/Developer/usr/bin/'
+    compiler_path = "$IPHONEPATH/usr/bin/${ios_triple}"
+    s_compiler_path = "$IPHONEPATH/Developer/usr/bin/"
 
     ccache_path = os.environ.get("CCACHE")
     if ccache_path is None:
-        env['CC'] = compiler_path + 'clang'
-        env['CXX'] = compiler_path + 'clang++'
-        env['S_compiler'] = s_compiler_path + 'gcc'
+        env["CC"] = compiler_path + "clang"
+        env["CXX"] = compiler_path + "clang++"
+        env["S_compiler"] = s_compiler_path + "gcc"
     else:
         # there aren't any ccache wrappers available for iOS,
         # to enable caching we need to prepend the path to the ccache binary
-        env['CC'] = ccache_path + ' ' + compiler_path + 'clang'
-        env['CXX'] = ccache_path + ' ' + compiler_path + 'clang++'
-        env['S_compiler'] = ccache_path + ' ' + s_compiler_path + 'gcc'
-    env['AR'] = compiler_path + 'ar'
-    env['RANLIB'] = compiler_path + 'ranlib'
+        env["CC"] = ccache_path + " " + compiler_path + "clang"
+        env["CXX"] = ccache_path + " " + compiler_path + "clang++"
+        env["S_compiler"] = ccache_path + " " + s_compiler_path + "gcc"
+    env["AR"] = compiler_path + "ar"
+    env["RANLIB"] = compiler_path + "ranlib"
 
     ## Compile flags
 
-    if (env["arch"] == "x86" or env["arch"] == "x86_64"):
-        detect_darwin_sdk_path('iphonesimulator', env)
-        env['ENV']['MACOSX_DEPLOYMENT_TARGET'] = '10.9'
+    if env["arch"] == "x86" or env["arch"] == "x86_64":
+        detect_darwin_sdk_path("iphonesimulator", env)
+        env["ENV"]["MACOSX_DEPLOYMENT_TARGET"] = "10.9"
         arch_flag = "i386" if env["arch"] == "x86" else env["arch"]
-        env.Append(CCFLAGS=('-arch ' + arch_flag + ' -fobjc-abi-version=2 -fobjc-legacy-dispatch -fmessage-length=0 -fpascal-strings -fblocks -fasm-blocks -isysroot $IPHONESDK -mios-simulator-version-min=10.0').split())
-    elif (env["arch"] == "arm"):
-        detect_darwin_sdk_path('iphone', env)
-        env.Append(CCFLAGS='-fno-objc-arc -arch armv7 -fmessage-length=0 -fno-strict-aliasing -fdiagnostics-print-source-range-info -fdiagnostics-show-category=id -fdiagnostics-parseable-fixits -fpascal-strings -fblocks -isysroot $IPHONESDK -fvisibility=hidden -mthumb "-DIBOutlet=__attribute__((iboutlet))" "-DIBOutletCollection(ClassName)=__attribute__((iboutletcollection(ClassName)))" "-DIBAction=void)__attribute__((ibaction)" -miphoneos-version-min=10.0 -MMD -MT dependencies'.split())
-    elif (env["arch"] == "arm64"):
-        detect_darwin_sdk_path('iphone', env)
-        env.Append(CCFLAGS='-fno-objc-arc -arch arm64 -fmessage-length=0 -fno-strict-aliasing -fdiagnostics-print-source-range-info -fdiagnostics-show-category=id -fdiagnostics-parseable-fixits -fpascal-strings -fblocks -fvisibility=hidden -MMD -MT dependencies -miphoneos-version-min=10.0 -isysroot $IPHONESDK'.split())
-        env.Append(CPPDEFINES=['NEED_LONG_INT'])
-        env.Append(CPPDEFINES=['LIBYUV_DISABLE_NEON'])
+        env.Append(
+            CCFLAGS=(
+                "-arch "
+                + arch_flag
+                + " -fobjc-abi-version=2 -fobjc-legacy-dispatch -fmessage-length=0 -fpascal-strings -fblocks -fasm-blocks -isysroot $IPHONESDK -mios-simulator-version-min=10.0"
+            ).split()
+        )
+    elif env["arch"] == "arm":
+        detect_darwin_sdk_path("iphone", env)
+        env.Append(
+            CCFLAGS='-fno-objc-arc -arch armv7 -fmessage-length=0 -fno-strict-aliasing -fdiagnostics-print-source-range-info -fdiagnostics-show-category=id -fdiagnostics-parseable-fixits -fpascal-strings -fblocks -isysroot $IPHONESDK -fvisibility=hidden -mthumb "-DIBOutlet=__attribute__((iboutlet))" "-DIBOutletCollection(ClassName)=__attribute__((iboutletcollection(ClassName)))" "-DIBAction=void)__attribute__((ibaction)" -miphoneos-version-min=10.0 -MMD -MT dependencies'.split()
+        )
+    elif env["arch"] == "arm64":
+        detect_darwin_sdk_path("iphone", env)
+        env.Append(
+            CCFLAGS="-fno-objc-arc -arch arm64 -fmessage-length=0 -fno-strict-aliasing -fdiagnostics-print-source-range-info -fdiagnostics-show-category=id -fdiagnostics-parseable-fixits -fpascal-strings -fblocks -fvisibility=hidden -MMD -MT dependencies -miphoneos-version-min=10.0 -isysroot $IPHONESDK".split()
+        )
+        env.Append(CPPDEFINES=["NEED_LONG_INT"])
+        env.Append(CPPDEFINES=["LIBYUV_DISABLE_NEON"])
 
     # Disable exceptions on non-tools (template) builds
-    if not env['tools']:
-        if env['ios_exceptions']:
-            env.Append(CCFLAGS=['-fexceptions'])
+    if not env["tools"]:
+        if env["ios_exceptions"]:
+            env.Append(CCFLAGS=["-fexceptions"])
         else:
-            env.Append(CCFLAGS=['-fno-exceptions'])
+            env.Append(CCFLAGS=["-fno-exceptions"])
 
     ## Link flags
 
-    if (env["arch"] == "x86" or env["arch"] == "x86_64"):
+    if env["arch"] == "x86" or env["arch"] == "x86_64":
         arch_flag = "i386" if env["arch"] == "x86" else env["arch"]
-        env.Append(LINKFLAGS=['-arch', arch_flag, '-mios-simulator-version-min=10.0',
-                              '-isysroot', '$IPHONESDK',
-                              '-Xlinker',
-                              '-objc_abi_version',
-                              '-Xlinker', '2',
-                              '-F$IPHONESDK',
-                              ])
-    elif (env["arch"] == "arm"):
-        env.Append(LINKFLAGS=['-arch', 'armv7', '-Wl,-dead_strip', '-miphoneos-version-min=10.0'])
-    if (env["arch"] == "arm64"):
-        env.Append(LINKFLAGS=['-arch', 'arm64', '-Wl,-dead_strip', '-miphoneos-version-min=10.0'])
-
-    env.Append(LINKFLAGS=['-isysroot', '$IPHONESDK',
-                          '-framework', 'AudioToolbox',
-                          '-framework', 'AVFoundation',
-                          '-framework', 'CoreAudio',
-                          '-framework', 'CoreGraphics',
-                          '-framework', 'CoreMedia',
-                          '-framework', 'CoreVideo',
-                          '-framework', 'CoreMotion',
-                          '-framework', 'Foundation',
-                          '-framework', 'GameController',
-                          '-framework', 'MediaPlayer',
-                          '-framework', 'Metal',
-                          '-framework', 'QuartzCore',
-                          '-framework', 'Security',
-                          '-framework', 'SystemConfiguration',
-                          '-framework', 'UIKit',
-                          '-framework', 'ARKit',
-                          ])
+        env.Append(
+            LINKFLAGS=[
+                "-arch",
+                arch_flag,
+                "-mios-simulator-version-min=10.0",
+                "-isysroot",
+                "$IPHONESDK",
+                "-Xlinker",
+                "-objc_abi_version",
+                "-Xlinker",
+                "2",
+                "-F$IPHONESDK",
+            ]
+        )
+    elif env["arch"] == "arm":
+        env.Append(LINKFLAGS=["-arch", "armv7", "-Wl,-dead_strip", "-miphoneos-version-min=10.0"])
+    if env["arch"] == "arm64":
+        env.Append(LINKFLAGS=["-arch", "arm64", "-Wl,-dead_strip", "-miphoneos-version-min=10.0"])
+
+    env.Append(
+        LINKFLAGS=[
+            "-isysroot",
+            "$IPHONESDK",
+            "-framework",
+            "AudioToolbox",
+            "-framework",
+            "AVFoundation",
+            "-framework",
+            "CoreAudio",
+            "-framework",
+            "CoreGraphics",
+            "-framework",
+            "CoreMedia",
+            "-framework",
+            "CoreVideo",
+            "-framework",
+            "CoreMotion",
+            "-framework",
+            "Foundation",
+            "-framework",
+            "GameController",
+            "-framework",
+            "MediaPlayer",
+            "-framework",
+            "Metal",
+            "-framework",
+            "QuartzCore",
+            "-framework",
+            "Security",
+            "-framework",
+            "SystemConfiguration",
+            "-framework",
+            "UIKit",
+            "-framework",
+            "ARKit",
+        ]
+    )
 
     # Feature options
-    if env['game_center']:
-        env.Append(CPPDEFINES=['GAME_CENTER_ENABLED'])
-        env.Append(LINKFLAGS=['-framework', 'GameKit'])
+    if env["game_center"]:
+        env.Append(CPPDEFINES=["GAME_CENTER_ENABLED"])
+        env.Append(LINKFLAGS=["-framework", "GameKit"])
 
-    if env['store_kit']:
-        env.Append(CPPDEFINES=['STOREKIT_ENABLED'])
-        env.Append(LINKFLAGS=['-framework', 'StoreKit'])
+    if env["store_kit"]:
+        env.Append(CPPDEFINES=["STOREKIT_ENABLED"])
+        env.Append(LINKFLAGS=["-framework", "StoreKit"])
 
-    if env['icloud']:
-        env.Append(CPPDEFINES=['ICLOUD_ENABLED'])
+    if env["icloud"]:
+        env.Append(CPPDEFINES=["ICLOUD_ENABLED"])
 
-    env.Prepend(CPPPATH=['$IPHONESDK/usr/include',
-                         '$IPHONESDK/System/Library/Frameworks/AudioUnit.framework/Headers',
-                         ])
+    env.Prepend(
+        CPPPATH=["$IPHONESDK/usr/include", "$IPHONESDK/System/Library/Frameworks/AudioUnit.framework/Headers",]
+    )
 
-    env['ENV']['CODESIGN_ALLOCATE'] = '/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/codesign_allocate'
+    env["ENV"]["CODESIGN_ALLOCATE"] = "/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/codesign_allocate"
 
-    env.Prepend(CPPPATH=['#platform/iphone'])
-    env.Append(CPPDEFINES=['IPHONE_ENABLED', 'UNIX_ENABLED', 'COREAUDIO_ENABLED'])
+    env.Prepend(CPPPATH=["#platform/iphone"])
+    env.Append(CPPDEFINES=["IPHONE_ENABLED", "UNIX_ENABLED", "COREAUDIO_ENABLED"])
 
-    env.Append(CPPDEFINES=['VULKAN_ENABLED'])
-    env.Append(LINKFLAGS=['-framework', 'IOSurface'])
-    if (env['use_static_mvk']):
-        env.Append(LINKFLAGS=['-framework', 'MoltenVK'])
-        env['builtin_vulkan'] = False
-    elif not env['builtin_vulkan']:
-        env.Append(LIBS=['vulkan'])
+    env.Append(CPPDEFINES=["VULKAN_ENABLED"])
+    env.Append(LINKFLAGS=["-framework", "IOSurface"])
+    if env["use_static_mvk"]:
+        env.Append(LINKFLAGS=["-framework", "MoltenVK"])
+        env["builtin_vulkan"] = False
+    elif not env["builtin_vulkan"]:
+        env.Append(LIBS=["vulkan"])