From 1989b1bf572d58f05098f130c90e3654dd358c10 Mon Sep 17 00:00:00 2001
From: Thaddeus Crews <repiteo@outlook.com>
Date: Tue, 25 Jun 2024 09:20:59 -0500
Subject: [PATCH] SCons: Add `silence_msvc` option

---
 tools/windows.py | 69 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)

diff --git a/tools/windows.py b/tools/windows.py
index a263241a..0d7a3419 100644
--- a/tools/windows.py
+++ b/tools/windows.py
@@ -5,10 +5,76 @@ from SCons.Tool import msvc, mingw
 from SCons.Variables import *
 
 
+def silence_msvc(env):
+    import os
+    import re
+    import tempfile
+
+    # Ensure we have a location to write captured output to, in case of false positives.
+    capture_path = os.path.join(os.path.dirname(__file__), "..", "msvc_capture.log")
+    with open(capture_path, "wt", encoding="utf-8"):
+        pass
+
+    old_spawn = env["SPAWN"]
+    re_redirect_stream = re.compile(r"^[12]?>")
+    re_cl_capture = re.compile(r"^.+\.(c|cc|cpp|cxx|c[+]{2})$", re.IGNORECASE)
+    re_link_capture = re.compile(r'\s{3}\S.+\s(?:"[^"]+.lib"|\S+.lib)\s.+\s(?:"[^"]+.exp"|\S+.exp)')
+
+    def spawn_capture(sh, escape, cmd, args, env):
+        # We only care about cl/link, process everything else as normal.
+        if args[0] not in ["cl", "link"]:
+            return old_spawn(sh, escape, cmd, args, env)
+
+        # Process as normal if the user is manually rerouting output.
+        for arg in args:
+            if re_redirect_stream.match(arg):
+                return old_spawn(sh, escape, cmd, args, env)
+
+        tmp_stdout, tmp_stdout_name = tempfile.mkstemp()
+        os.close(tmp_stdout)
+        args.append(f">{tmp_stdout_name}")
+        ret = old_spawn(sh, escape, cmd, args, env)
+
+        try:
+            with open(tmp_stdout_name, "r", encoding=sys.stdout.encoding, errors="replace") as tmp_stdout:
+                lines = tmp_stdout.read().splitlines()
+            os.remove(tmp_stdout_name)
+        except OSError:
+            pass
+
+        # Early process no lines (OSError)
+        if not lines:
+            return ret
+
+        is_cl = args[0] == "cl"
+        content = ""
+        caught = False
+        for line in lines:
+            # These conditions are far from all-encompassing, but are specialized
+            # for what can be reasonably expected to show up in the repository.
+            if not caught and (is_cl and re_cl_capture.match(line)) or (not is_cl and re_link_capture.match(line)):
+                caught = True
+                try:
+                    with open(capture_path, "a", encoding=sys.stdout.encoding) as log:
+                        log.write(line + "\n")
+                except OSError:
+                    print(f'WARNING: Failed to log captured line: "{line}".')
+                continue
+            content += line + "\n"
+        # Content remaining assumed to be an error/warning.
+        if content:
+            sys.stderr.write(content)
+
+        return ret
+
+    env["SPAWN"] = spawn_capture
+
+
 def options(opts):
     opts.Add(BoolVariable("use_mingw", "Use the MinGW compiler instead of MSVC - only effective on Windows", False))
     opts.Add(BoolVariable("use_clang_cl", "Use the clang driver instead of MSVC - only effective on Windows", False))
     opts.Add(BoolVariable("use_static_cpp", "Link MinGW/MSVC C++ runtime libraries statically", True))
+    opts.Add(BoolVariable("silence_msvc", "Silence MSVC's cl/link stdout bloat, redirecting errors to stderr.", True))
 
 
 def exists(env):
@@ -42,6 +108,9 @@ def generate(env):
         else:
             env.Append(CCFLAGS=["/MD"])
 
+        if env["silence_msvc"] and not env.GetOption("clean"):
+            silence_msvc(env)
+
     elif sys.platform == "win32" or sys.platform == "msys":
         env["use_mingw"] = True
         mingw.generate(env)