From e2dfb656f4508643acf38014dd8461782505ba12 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Thu, 14 Oct 2021 12:01:22 +0200
Subject: [PATCH] SCons: Add `DEV_ENABLED` defines for `target=debug` builds

This will allow adding developer checks which will be fully compiled out in
user builds, unlike `DEBUG_ENABLED` which is included in debug tempates and
the editor builds.

This define is not used yet, but we'll soon add code that uses it, and change
some existing `DEBUG_ENABLED` checks to be performed only in dev builds.

Related to godotengine/godot-proposals#3371.
---
 platform/android/detect.py    | 1 +
 platform/iphone/detect.py     | 1 +
 platform/javascript/detect.py | 1 +
 platform/linuxbsd/detect.py   | 1 +
 platform/osx/detect.py        | 1 +
 platform/uwp/detect.py        | 1 +
 platform/windows/detect.py    | 2 ++
 7 files changed, 8 insertions(+)

diff --git a/platform/android/detect.py b/platform/android/detect.py
index 406f10de89..6b0c60fe8b 100644
--- a/platform/android/detect.py
+++ b/platform/android/detect.py
@@ -203,6 +203,7 @@ def configure(env):
         env.Append(LINKFLAGS=["-O0"])
         env.Append(CCFLAGS=["-O0", "-g", "-fno-limit-debug-info"])
         env.Append(CPPDEFINES=["_DEBUG", "DEBUG_ENABLED"])
+        env.Append(CPPDEFINES=["DEV_ENABLED"])
         env.Append(CPPFLAGS=["-UNDEBUG"])
 
     # Compiler configuration
diff --git a/platform/iphone/detect.py b/platform/iphone/detect.py
index 05e24c5003..3c6453ff9b 100644
--- a/platform/iphone/detect.py
+++ b/platform/iphone/detect.py
@@ -59,6 +59,7 @@ def configure(env):
     elif env["target"] == "debug":
         env.Append(CCFLAGS=["-gdwarf-2", "-O0"])
         env.Append(CPPDEFINES=["_DEBUG", ("DEBUG", 1), "DEBUG_ENABLED"])
+        env.Append(CPPDEFINES=["DEV_ENABLED"])
 
     if env["use_lto"]:
         env.Append(CCFLAGS=["-flto"])
diff --git a/platform/javascript/detect.py b/platform/javascript/detect.py
index 173b558b6d..9494ab6fa5 100644
--- a/platform/javascript/detect.py
+++ b/platform/javascript/detect.py
@@ -82,6 +82,7 @@ def configure(env):
             env.Append(LINKFLAGS=["--profiling-funcs"])
     else:  # "debug"
         env.Append(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Append(CPPDEFINES=["DEV_ENABLED"])
         env.Append(CCFLAGS=["-O1", "-g"])
         env.Append(LINKFLAGS=["-O1", "-g"])
         env["use_assertions"] = True
diff --git a/platform/linuxbsd/detect.py b/platform/linuxbsd/detect.py
index 8eb22c1c72..afb7c7b2ab 100644
--- a/platform/linuxbsd/detect.py
+++ b/platform/linuxbsd/detect.py
@@ -113,6 +113,7 @@ def configure(env):
     elif env["target"] == "debug":
         env.Prepend(CCFLAGS=["-g3"])
         env.Prepend(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Prepend(CPPDEFINES=["DEV_ENABLED"])
         env.Append(LINKFLAGS=["-rdynamic"])
 
     ## Architecture
diff --git a/platform/osx/detect.py b/platform/osx/detect.py
index 6b25daf05d..10cf2b591e 100644
--- a/platform/osx/detect.py
+++ b/platform/osx/detect.py
@@ -64,6 +64,7 @@ def configure(env):
     elif env["target"] == "debug":
         env.Prepend(CCFLAGS=["-g3"])
         env.Prepend(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Prepend(CPPDEFINES=["DEV_ENABLED"])
         env.Prepend(LINKFLAGS=["-Xlinker", "-no_deduplicate"])
 
     ## Architecture
diff --git a/platform/uwp/detect.py b/platform/uwp/detect.py
index 28922a4f59..f31b43cd49 100644
--- a/platform/uwp/detect.py
+++ b/platform/uwp/detect.py
@@ -72,6 +72,7 @@ def configure(env):
         env.Append(CCFLAGS=["/Zi"])
         env.Append(CCFLAGS=["/MDd"])
         env.Append(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Append(CPPDEFINES=["DEV_ENABLED"])
         env.Append(LINKFLAGS=["/SUBSYSTEM:CONSOLE"])
         env.AppendUnique(CPPDEFINES=["WINDOWS_SUBSYSTEM_CONSOLE"])
         env.Append(LINKFLAGS=["/DEBUG"])
diff --git a/platform/windows/detect.py b/platform/windows/detect.py
index 3961480d23..6f99368e99 100644
--- a/platform/windows/detect.py
+++ b/platform/windows/detect.py
@@ -208,6 +208,7 @@ def configure_msvc(env, manual_msvc_config):
     elif env["target"] == "debug":
         env.AppendUnique(CCFLAGS=["/Zi", "/FS", "/Od", "/EHsc"])
         env.AppendUnique(CPPDEFINES=["DEBUG_ENABLED"])
+        env.AppendUnique(CPPDEFINES=["DEV_ENABLED"])
         env.Append(LINKFLAGS=["/DEBUG"])
 
     if env["debug_symbols"]:
@@ -362,6 +363,7 @@ def configure_mingw(env):
     elif env["target"] == "debug":
         env.Append(CCFLAGS=["-g3"])
         env.Append(CPPDEFINES=["DEBUG_ENABLED"])
+        env.Append(CPPDEFINES=["DEV_ENABLED"])
 
     if env["windows_subsystem"] == "gui":
         env.Append(LINKFLAGS=["-Wl,--subsystem,windows"])