Buildsystem: Improve detect.py readability and fix issues

Tried to organize the configure(env) calls in sections, using the same order
for all platforms whenever possible.

Apart from cosmetic changes, the following issues were fixed:
- Android: cleanup linkage, remove GLESv1_CM and GLESv2
- iPhone: Remove obsolete "ios_gles22_override" option
- OSX:
  * Fix bits detection (default to 64) and remove obsolete "force_64_bits" option
    (closes #9449)
  * Make "fat" bits argument explicit
- Server: sync with X11
- Windows: clean up old DirectX 9 stuff
- X11:
  * Do not require system OpenSSL for building (closes #9443)
  * Fix typo'ed use_leak_sanitizer option
  * Fix .llvm suffix overriding custom extra_suffix

1 files changed, 77 insertions, 195 deletions

diff --git a/platform/windows/detect.py b/platform/windows/detect.py
index 5e56c1db49..a2bc5a11ab 100644
--- a/platform/windows/detect.py
+++ b/platform/windows/detect.py
@@ -1,104 +1,7 @@
-#
-#   tested on                   | Windows native    | Linux cross-compilation
-#   ----------------------------+-------------------+---------------------------
-#   Visual C++ Build Tools 2015 | WORKS             | n/a
-#   MSVS C++ 2010 Express       | WORKS             | n/a
-#   Mingw-w64                   | WORKS             | WORKS
-#   Mingw-w32                   | WORKS             | WORKS
-#   MinGW                       | WORKS             | untested
-#
-#####
-# Note about Visual C++ Build Tools :
-#
-#	- Visual C++ Build Tools is the standalone MSVC compiler :
-#		http://landinghub.visualstudio.com/visual-cpp-build-tools
-#
-#####
-# Notes about MSVS C++ :
-#
-# 	- MSVC2010-Express compiles to 32bits only.
-#
-#####
-# Notes about Mingw-w64 and Mingw-w32 under Windows :
-#
-#	- both can be installed using the official installer :
-#		http://mingw-w64.sourceforge.net/download.php#mingw-builds
-#
-#	- if you want to compile both 32bits and 64bits, don't forget to
-#	run the installer twice to install them both.
-#
-#	- install them into a path that does not contain spaces
-#		( example : "C:/Mingw-w32", "C:/Mingw-w64" )
-#
-#	- if you want to compile faster using the "-j" option, don't forget
-#	to install the appropriate version of the Pywin32 python extension
-#	available from : http://sourceforge.net/projects/pywin32/files/
-#
-#	- before running scons, you must add into the environment path
-#	the path to the "/bin" directory of the Mingw version you want
-#	to use :
-#
-#		set PATH=C:/Mingw-w32/bin;%PATH%
-#
-#	- then, scons should be able to detect gcc.
-#	- Mingw-w32 only compiles 32bits.
-#	- Mingw-w64 only compiles 64bits.
-#
-#	- it is possible to add them both at the same time into the PATH env,
-#	if you also define the MINGW32_PREFIX and MINGW64_PREFIX environment
-#	variables.
-#	For instance, you could store that set of commands into a .bat script
-#	that you would run just before scons :
-#
-#			set PATH=C:\mingw-w32\bin;%PATH%
-#			set PATH=C:\mingw-w64\bin;%PATH%
-#			set MINGW32_PREFIX=C:\mingw-w32\bin\
-#			set MINGW64_PREFIX=C:\mingw-w64\bin\
-#
-#####
-# Notes about Mingw, Mingw-w64 and Mingw-w32 under Linux :
-#
-#	- default toolchain prefixes are :
-#		"i586-mingw32msvc-" for MinGW
-#		"i686-w64-mingw32-"	for Mingw-w32
-#		"x86_64-w64-mingw32-" for Mingw-w64
-#
-#	- if both MinGW and Mingw-w32 are installed on your system
-#	Mingw-w32 should take the priority over MinGW.
-#
-#	- it is possible to manually override prefixes by defining
-#	the MINGW32_PREFIX and MINGW64_PREFIX environment variables.
-#
-#####
-# Notes about Mingw under Windows :
-#
-#	- this is the MinGW version from http://mingw.org/
-#	- install it into a path that does not contain spaces
-#		( example : "C:/MinGW" )
-#	- several DirectX headers might be missing. You can copy them into
-#	the C:/MinGW/include" directory from this page :
-#	 https://code.google.com/p/mingw-lib/source/browse/trunk/working/avcodec_to_widget_5/directx_include/
-#	- before running scons, add the path to the "/bin" directory :
-#		set PATH=C:/MinGW/bin;%PATH%
-#	- scons should be able to detect gcc.
-#
-
-#####
-# TODO :
-#
-#	- finish to cleanup this script to remove all the remains of previous hacks and workarounds
-#	- make it work with the Windows7 SDK that is supposed to enable 64bits compilation for MSVC2010-Express
-#	- confirm it works well with other Visual Studio versions.
-#	- update the wiki about the pywin32 extension required for the "-j" option under Windows.
-#	- update the wiki to document MINGW32_PREFIX and MINGW64_PREFIX
-#
-
+import methods
 import os
-
 import sys
 
-import methods
-
 
 def is_active():
     return True
@@ -115,7 +18,7 @@ def can_build():
         if (os.getenv("VCINSTALLDIR")):
             return True
         else:
-            print("\nMSVC not detected, attempting Mingw.")
+            print("\nMSVC not detected, attempting MinGW.")
             mingw32 = ""
             mingw64 = ""
             if (os.getenv("MINGW32_PREFIX")):
@@ -126,7 +29,7 @@ def can_build():
             test = "gcc --version > NUL 2>&1"
             if os.system(test) != 0 and os.system(mingw32 + test) != 0 and os.system(mingw64 + test) != 0:
                 print("- could not detect gcc.")
-                print("Please, make sure a path to a Mingw /bin directory is accessible into the environment PATH.\n")
+                print("Please, make sure a path to a MinGW /bin directory is accessible into the environment PATH.\n")
                 return False
             else:
                 print("- gcc detected.")
@@ -172,8 +75,8 @@ def get_opts():
         mingw64 = os.getenv("MINGW64_PREFIX")
 
     return [
-        ('mingw_prefix', 'Mingw Prefix', mingw32),
-        ('mingw_prefix_64', 'Mingw Prefix 64 bits', mingw64),
+        ('mingw_prefix', 'MinGW Prefix', mingw32),
+        ('mingw_prefix_64', 'MinGW Prefix 64 bits', mingw64),
     ]
 
 
@@ -211,55 +114,86 @@ def configure(env):
     # Targeted Windows version: Vista (and later)
     winver = "0x0600" # Windows Vista is the minimum target for windows builds
 
-    env['is_mingw'] = False
-    if (os.name == "nt" and os.getenv("VCINSTALLDIR")):
-        # build using visual studio
+    if (os.name == "nt" and os.getenv("VCINSTALLDIR")): # MSVC
+
         env['ENV']['TMP'] = os.environ['TMP']
-        env.Append(CPPPATH=['#platform/windows/include'])
-        env.Append(LIBPATH=['#platform/windows/lib'])
-        env.Append(CCFLAGS=['/DWINVER=%s' % winver, '/D_WIN32_WINNT=%s' % winver])
 
-        if (env["target"] == "release"):
+        ## Build type
 
+        if (env["target"] == "release"):
             env.Append(CCFLAGS=['/O2'])
             env.Append(LINKFLAGS=['/SUBSYSTEM:WINDOWS'])
             env.Append(LINKFLAGS=['/ENTRY:mainCRTStartup'])
 
         elif (env["target"] == "release_debug"):
-
             env.Append(CCFLAGS=['/O2', '/DDEBUG_ENABLED'])
             env.Append(LINKFLAGS=['/SUBSYSTEM:CONSOLE'])
-        elif (env["target"] == "debug_release"):
 
+        elif (env["target"] == "debug_release"):
             env.Append(CCFLAGS=['/Z7', '/Od'])
             env.Append(LINKFLAGS=['/DEBUG'])
             env.Append(LINKFLAGS=['/SUBSYSTEM:WINDOWS'])
             env.Append(LINKFLAGS=['/ENTRY:mainCRTStartup'])
 
         elif (env["target"] == "debug"):
-
             env.Append(CCFLAGS=['/Z7', '/DDEBUG_ENABLED', '/DDEBUG_MEMORY_ENABLED', '/DD3D_DEBUG_INFO', '/Od'])
             env.Append(LINKFLAGS=['/SUBSYSTEM:CONSOLE'])
             env.Append(LINKFLAGS=['/DEBUG'])
 
-	env.Append(CCFLAGS=['/MT', '/Gd', '/GR', '/nologo'])
+        ## Architecture
+
+        # Note: this detection/override code from here onward should be here instead of in SConstruct because it's platform and compiler specific (MSVC/Windows)
+        if (env["bits"] != "default"):
+            print("Error: bits argument is disabled for MSVC")
+            print("""
+                Bits argument is not supported for MSVC compilation. Architecture depends on the Native/Cross Compile Tools Prompt/Developer Console
+                (or Visual Studio settings) that is being used to run SCons. As a consequence, bits argument is disabled. Run scons again without bits
+                argument (example: scons p=windows) and SCons will attempt to detect what MSVC compiler will be executed and inform you.
+                """)
+            sys.exit()
+
+        # Forcing bits argument because MSVC does not have a flag to set this through SCons... it's different compilers (cl.exe's) called from the proper command prompt
+        # that decide the architecture that is build for. Scons can only detect the os.getenviron (because vsvarsall.bat sets a lot of stuff for cl.exe to work with)
+        env["bits"] = "32"
+        env["x86_libtheora_opt_vc"] = True
+
+        ## Compiler configuration
+
+        env['ENV'] = os.environ
+        # This detection function needs the tools env (that is env['ENV'], not SCons's env), and that is why it's this far bellow in the code
+        compiler_version_str = methods.detect_visual_c_compiler_version(env['ENV'])
+
+        print("Detected MSVC compiler: " + compiler_version_str)
+        # If building for 64bit architecture, disable assembly optimisations for 32 bit builds (theora as of writting)... vc compiler for 64bit can not compile _asm
+        if(compiler_version_str == "amd64" or compiler_version_str == "x86_amd64"):
+            env["bits"] = "64"
+            env["x86_libtheora_opt_vc"] = False
+            print("Compiled program architecture will be a 64 bit executable (forcing bits=64).")
+        elif (compiler_version_str == "x86" or compiler_version_str == "amd64_x86"):
+            print("Compiled program architecture will be a 32 bit executable. (forcing bits=32).")
+        else:
+            print("Failed to detect MSVC compiler architecture version... Defaulting to 32bit executable settings (forcing bits=32). Compilation attempt will continue, but SCons can not detect for what architecture this build is compiled for. You should check your settings/compilation setup.")
+
+        ## Compile flags
+
+        env.Append(CCFLAGS=['/MT', '/Gd', '/GR', '/nologo'])
         env.Append(CXXFLAGS=['/TP'])
         env.Append(CPPFLAGS=['/DMSVC', '/GR', ])
         env.Append(CCFLAGS=['/I' + os.getenv("WindowsSdkDir") + "/Include"])
+
         env.Append(CCFLAGS=['/DWINDOWS_ENABLED'])
+        env.Append(CCFLAGS=['/DOPENGL_ENABLED'])
         env.Append(CCFLAGS=['/DRTAUDIO_ENABLED'])
-        env.Append(CCFLAGS=['/DWIN32'])
         env.Append(CCFLAGS=['/DTYPED_METHOD_BIND'])
+        env.Append(CCFLAGS=['/DWIN32'])
+        env.Append(CCFLAGS=['/DWINVER=%s' % winver, '/D_WIN32_WINNT=%s' % winver])
+        if env["bits"] == "64":
+            env.Append(CCFLAGS=['/D_WIN64'])
 
-        env.Append(CCFLAGS=['/DOPENGL_ENABLED'])
         LIBS = ['winmm', 'opengl32', 'dsound', 'kernel32', 'ole32', 'oleaut32', 'user32', 'gdi32', 'IPHLPAPI', 'Shlwapi', 'wsock32', 'Ws2_32', 'shell32', 'advapi32', 'dinput8', 'dxguid']
         env.Append(LINKFLAGS=[p + env["LIBSUFFIX"] for p in LIBS])
 
         env.Append(LIBPATH=[os.getenv("WindowsSdkDir") + "/Lib"])
-        if (os.getenv("DXSDK_DIR")):
-            DIRECTX_PATH = os.getenv("DXSDK_DIR")
-        else:
-            DIRECTX_PATH = "C:/Program Files/Microsoft DirectX SDK (March 2009)"
 
         if (os.getenv("VCINSTALLDIR")):
             VC_PATH = os.getenv("VCINSTALLDIR")
@@ -268,51 +202,37 @@ def configure(env):
 
         env.Append(CCFLAGS=["/I" + p for p in os.getenv("INCLUDE").split(";")])
         env.Append(LIBPATH=[p for p in os.getenv("LIB").split(";")])
-        env.Append(CCFLAGS=["/I" + DIRECTX_PATH + "/Include"])
-        env.Append(LIBPATH=[DIRECTX_PATH + "/Lib/x86"])
-        env['ENV'] = os.environ
-
-        # This detection function needs the tools env (that is env['ENV'], not SCons's env), and that is why it's this far bellow in the code
-        compiler_version_str = methods.detect_visual_c_compiler_version(env['ENV'])
-
-        # Note: this detection/override code from here onward should be here instead of in SConstruct because it's platform and compiler specific (MSVC/Windows)
-        if(env["bits"] != "default"):
-            print "Error: bits argument is disabled for MSVC"
-            print ("Bits argument is not supported for MSVC compilation. Architecture depends on the Native/Cross Compile Tools Prompt/Developer Console (or Visual Studio settings)"
-                   + " that is being used to run SCons. As a consequence, bits argument is disabled. Run scons again without bits argument (example: scons p=windows) and SCons will attempt to detect what MSVC compiler"
-                   + " will be executed and inform you.")
-            sys.exit()
-
-        # Forcing bits argument because MSVC does not have a flag to set this through SCons... it's different compilers (cl.exe's) called from the proper command prompt
-        # that decide the architecture that is build for. Scons can only detect the os.getenviron (because vsvarsall.bat sets a lot of stuff for cl.exe to work with)
-        env["bits"] = "32"
-        env["x86_libtheora_opt_vc"] = True
-
-        print "Detected MSVC compiler: " + compiler_version_str
-        # If building for 64bit architecture, disable assembly optimisations for 32 bit builds (theora as of writting)... vc compiler for 64bit can not compile _asm
-        if(compiler_version_str == "amd64" or compiler_version_str == "x86_amd64"):
-            env["bits"] = "64"
-            env["x86_libtheora_opt_vc"] = False
-            print "Compiled program architecture will be a 64 bit executable (forcing bits=64)."
-        elif (compiler_version_str == "x86" or compiler_version_str == "amd64_x86"):
-            print "Compiled program architecture will be a 32 bit executable. (forcing bits=32)."
-        else:
-            print "Failed to detect MSVC compiler architecture version... Defaulting to 32bit executable settings (forcing bits=32). Compilation attempt will continue, but SCons can not detect for what architecture this build is compiled for. You should check your settings/compilation setup."
-        if env["bits"] == "64":
-            env.Append(CCFLAGS=['/D_WIN64'])
 
         # Incremental linking fix
         env['BUILDERS']['ProgramOriginal'] = env['BUILDERS']['Program']
         env['BUILDERS']['Program'] = methods.precious_program
 
-    else:
+    else: # MinGW
 
         # Workaround for MinGW. See:
         # http://www.scons.org/wiki/LongCmdLinesOnWin32
         env.use_windows_spawn_fix()
 
-        # build using mingw
-        env.Append(CCFLAGS=['-DWINVER=%s' % winver, '-D_WIN32_WINNT=%s' % winver])
+        ## Build type
+
+        if (env["target"] == "release"):
+            env.Append(CCFLAGS=['-msse2'])
+
+            if (env["bits"] == "64"):
+                env.Append(CCFLAGS=['-O3'])
+            else:
+                env.Append(CCFLAGS=['-O2'])
+
+            env.Append(LINKFLAGS=['-Wl,--subsystem,windows'])
+
+        elif (env["target"] == "release_debug"):
+            env.Append(CCFLAGS=['-O2', '-DDEBUG_ENABLED'])
+
+        elif (env["target"] == "debug"):
+            env.Append(CCFLAGS=['-g', '-DDEBUG_ENABLED', '-DDEBUG_MEMORY_ENABLED'])
+
+        ## Compiler configuration
+
         if (os.name == "nt"):
             env['ENV']['TMP'] = os.environ['TMP']  # way to go scons, you can be so stupid sometimes
         else:
@@ -339,30 +259,6 @@ def configure(env):
         else:
             nulstr = ">nul"
 
-        # if os.system(mingw_prefix+"gcc --version"+nulstr)!=0:
-            # #not really super consistent but..
-            # print("Can't find Windows compiler: "+mingw_prefix)
-            # sys.exit(255)
-
-        if (env["target"] == "release"):
-
-            env.Append(CCFLAGS=['-msse2'])
-
-            if (env["bits"] == "64"):
-                env.Append(CCFLAGS=['-O3'])
-            else:
-                env.Append(CCFLAGS=['-O2'])
-
-            env.Append(LINKFLAGS=['-Wl,--subsystem,windows'])
-
-        elif (env["target"] == "release_debug"):
-
-            env.Append(CCFLAGS=['-O2', '-DDEBUG_ENABLED'])
-
-        elif (env["target"] == "debug"):
-
-            env.Append(CCFLAGS=['-g', '-DDEBUG_ENABLED', '-DDEBUG_MEMORY_ENABLED'])
-
         env["CC"] = mingw_prefix + "gcc"
         env['AS'] = mingw_prefix + "as"
         env['CXX'] = mingw_prefix + "g++"
@@ -371,29 +267,15 @@ def configure(env):
         env['LD'] = mingw_prefix + "g++"
         env["x86_libtheora_opt_gcc"] = True
 
-        #env['CC'] = "winegcc"
-        #env['CXX'] = "wineg++"
+        ## Compile flags
 
         env.Append(CCFLAGS=['-DWINDOWS_ENABLED', '-mwindows'])
-        env.Append(CPPFLAGS=['-DRTAUDIO_ENABLED'])
         env.Append(CCFLAGS=['-DOPENGL_ENABLED'])
+        env.Append(CCFLAGS=['-DRTAUDIO_ENABLED'])
+        env.Append(CCFLAGS=['-DWINVER=%s' % winver, '-D_WIN32_WINNT=%s' % winver])
         env.Append(LIBS=['mingw32', 'opengl32', 'dsound', 'ole32', 'd3d9', 'winmm', 'gdi32', 'iphlpapi', 'shlwapi', 'wsock32', 'ws2_32', 'kernel32', 'oleaut32', 'dinput8', 'dxguid'])
 
-        # if (env["bits"]=="32"):
-        # env.Append(LIBS=['gcc_s'])
-        # #--with-arch=i686
-        # env.Append(CPPFLAGS=['-march=i686'])
-        # env.Append(LINKFLAGS=['-march=i686'])
-
-        #'d3dx9d'
         env.Append(CPPFLAGS=['-DMINGW_ENABLED'])
-        # env.Append(LINKFLAGS=['-g'])
 
         # resrc
-        env['is_mingw'] = True
         env.Append(BUILDERS={'RES': env.Builder(action=build_res_file, suffix='.o', src_suffix='.rc')})
-
-    env.Append(BUILDERS={'GLSL120': env.Builder(action=methods.build_legacygl_headers, suffix='glsl.h', src_suffix='.glsl')})
-    env.Append(BUILDERS={'GLSL': env.Builder(action=methods.build_glsl_headers, suffix='glsl.h', src_suffix='.glsl')})
-    env.Append(BUILDERS={'HLSL9': env.Builder(action=methods.build_hlsl_dx9_headers, suffix='hlsl.h', src_suffix='.hlsl')})
-    env.Append(BUILDERS={'GLSL120GLES': env.Builder(action=methods.build_gles2_headers, suffix='glsl.h', src_suffix='.glsl')})