From c7b53c03ae7f7feb45a6023ee5cf764025ebb5e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Thu, 17 Dec 2020 16:01:36 +0100
Subject: SCons: Add explicit dependencies on thirdparty code in cloned env

Since we clone the environments to build thirdparty code, we don't get an
explicit dependency on the build objects produced by that environment.

So when we update thirdparty code, Godot code using it is not necessarily
rebuilt (I think it is for changed headers, but not for changed .c/.cpp files),
which can lead to an invalid compilation output (linking old Godot .o files
with a newer, potentially ABI breaking version of thirdparty code).

This was only seen as really problematic with bullet updates (leading to
crashes when rebuilding Godot after a bullet update without cleaning .o files),
but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
---
 modules/text_server_adv/SCsub | 62 ++++++++++++++++++++++++++-----------------
 1 file changed, 37 insertions(+), 25 deletions(-)

(limited to 'modules/text_server_adv/SCsub')

diff --git a/modules/text_server_adv/SCsub b/modules/text_server_adv/SCsub
index 7403b01a4c..3589c8546d 100644
--- a/modules/text_server_adv/SCsub
+++ b/modules/text_server_adv/SCsub
@@ -35,10 +35,14 @@ def make_icu_data(target, source, env):
     g.write("#endif")
 
 
+# Thirdparty source files
+
+thirdparty_obj = []
+
 if env["builtin_harfbuzz"]:
     env_harfbuzz = env_modules.Clone()
+    env_harfbuzz.disable_warnings()
 
-    # Thirdparty source files
     thirdparty_dir = "#thirdparty/harfbuzz/"
     thirdparty_sources = [
         "src/hb-aat-layout.cc",
@@ -107,6 +111,15 @@ if env["builtin_harfbuzz"]:
     ]
     thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]
 
+    env_harfbuzz.Append(
+        CPPPATH=[
+            "#thirdparty/harfbuzz/src",
+            "#thirdparty/freetype/include",
+            "#thirdparty/graphite/include",
+            "#thirdparty/icu4c/common/",
+        ]
+    )
+
     if env["platform"] == "android" or env["platform"] == "linuxbsd" or env["platform"] == "server":
         env_harfbuzz.Append(CCFLAGS=["-DHAVE_PTHREAD"])
 
@@ -116,14 +129,6 @@ if env["builtin_harfbuzz"]:
         else:
             env_harfbuzz.Append(CCFLAGS=["-DHB_NO_MT"])
 
-    env_harfbuzz.Append(
-        CPPPATH=[
-            "#thirdparty/harfbuzz/src",
-            "#thirdparty/freetype/include",
-            "#thirdparty/graphite/include",
-            "#thirdparty/icu4c/common/",
-        ]
-    )
     env_harfbuzz.Append(
         CCFLAGS=[
             "-DHAVE_ICU_BUILTIN",
@@ -133,10 +138,9 @@ if env["builtin_harfbuzz"]:
             "-DGRAPHITE2_STATIC",
         ]
     )
-    env_harfbuzz.disable_warnings()
-    env_thirdparty = env_harfbuzz.Clone()
-    env_thirdparty.disable_warnings()
-    lib = env_thirdparty.add_library("harfbuzz_builtin", thirdparty_sources)
+
+    lib = env_harfbuzz.add_library("harfbuzz_builtin", thirdparty_sources)
+    thirdparty_obj += lib
 
     # Needs to be appended to arrive after libscene in the linker call,
     # but we don't want it to arrive *after* system libs, so manual hack
@@ -151,10 +155,11 @@ if env["builtin_harfbuzz"]:
     if not inserted:
         env.Append(LIBS=[lib])
 
+
 if env["builtin_graphite"]:
     env_graphite = env_modules.Clone()
+    env_graphite.disable_warnings()
 
-    # Thirdparty source files
     thirdparty_dir = "#thirdparty/graphite/"
     thirdparty_sources = [
         "src/gr_char_info.cpp",
@@ -203,10 +208,9 @@ if env["builtin_graphite"]:
             "-DGRAPHITE2_NFILEFACE",
         ]
     )
-    env_graphite.disable_warnings()
-    env_thirdparty = env_graphite.Clone()
-    env_thirdparty.disable_warnings()
-    lib = env_thirdparty.add_library("graphite_builtin", thirdparty_sources)
+
+    lib = env_graphite.add_library("graphite_builtin", thirdparty_sources)
+    thirdparty_obj += lib
 
     # Needs to be appended to arrive after libscene in the linker call,
     # but we don't want it to arrive *after* system libs, so manual hack
@@ -221,12 +225,12 @@ if env["builtin_graphite"]:
     if not inserted:
         env.Append(LIBS=[lib])
 
+
 if env["builtin_icu"]:
     env_icu = env_modules.Clone()
+    env_icu.disable_warnings()
 
-    # Thirdparty source files
     thirdparty_dir = "#thirdparty/icu4c/"
-    # Thirdparty source files
     thirdparty_sources = [
         "common/appendable.cpp",
         "common/bmpset.cpp",
@@ -457,10 +461,8 @@ if env["builtin_icu"]:
         ]
     )
 
-    env_icu.disable_warnings()
-    env_thirdparty = env_icu.Clone()
-    env_thirdparty.disable_warnings()
-    lib = env_thirdparty.add_library("icu_builtin", thirdparty_sources)
+    lib = env_icu.add_library("icu_builtin", thirdparty_sources)
+    thirdparty_obj += lib
 
     # Needs to be appended to arrive after libscene in the linker call,
     # but we don't want it to arrive *after* system libs, so manual hack
@@ -475,6 +477,11 @@ if env["builtin_icu"]:
     if not inserted:
         env.Append(LIBS=[lib])
 
+
+# Godot source files
+
+module_obj = []
+
 if env_text_server_adv["tools"]:
     env_text_server_adv.Append(CXXFLAGS=["-DICU_STATIC_DATA"])
 
@@ -486,4 +493,9 @@ env_text_server_adv.Append(
         "#thirdparty/icu4c/common/",
     ]
 )
-env_text_server_adv.add_source_files(env.modules_sources, "*.cpp")
+
+env_text_server_adv.add_source_files(module_obj, "*.cpp")
+env.modules_sources += module_obj
+
+# Needed to force rebuilding the module files when the thirdparty library is updated.
+env.Depends(module_obj, thirdparty_obj)
-- 
cgit v1.2.3