redirect the game's debug messages into trace logs (#233)

The game writes debug messages directly to the console, which shows up for SMAPI users. This commit redirects direct console messages to a monitor.

1 files changed, 24 insertions, 32 deletions

diff --git a/src/StardewModdingAPI/Framework/Monitor.cs b/src/StardewModdingAPI/Framework/Monitor.cs
index 39b567d8..33c1bbf4 100644
--- a/src/StardewModdingAPI/Framework/Monitor.cs
+++ b/src/StardewModdingAPI/Framework/Monitor.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using StardewModdingAPI.Framework.Logging;
 
 namespace StardewModdingAPI.Framework
 {
@@ -13,6 +14,9 @@ namespace StardewModdingAPI.Framework
         /// <summary>The name of the module which logs messages using this instance.</summary>
         private readonly string Source;
 
+        /// <summary>Manages access to the console output.</summary>
+        private readonly ConsoleInterceptionManager ConsoleManager;
+
         /// <summary>The log file to which to write messages.</summary>
         private readonly LogFileManager LogFile;
 
@@ -34,9 +38,6 @@ namespace StardewModdingAPI.Framework
         /*********
         ** Accessors
         *********/
-        /// <summary>Whether the current console supports color codes.</summary>
-        internal static readonly bool ConsoleSupportsColor = Monitor.GetConsoleSupportsColor();
-
         /// <summary>Whether to show trace messages in the console.</summary>
         internal bool ShowTraceInConsole { get; set; }
 
@@ -49,8 +50,9 @@ namespace StardewModdingAPI.Framework
         *********/
         /// <summary>Construct an instance.</summary>
         /// <param name="source">The name of the module which logs messages using this instance.</param>
+        /// <param name="consoleManager">Manages access to the console output.</param>
         /// <param name="logFile">The log file to which to write messages.</param>
-        public Monitor(string source, LogFileManager logFile)
+        public Monitor(string source, ConsoleInterceptionManager consoleManager, LogFileManager logFile)
         {
             // validate
             if (string.IsNullOrWhiteSpace(source))
@@ -61,6 +63,7 @@ namespace StardewModdingAPI.Framework
             // initialise
             this.Source = source;
             this.LogFile = logFile;
+            this.ConsoleManager = consoleManager;
         }
 
         /// <summary>Log a message for the player or developer.</summary>
@@ -68,7 +71,7 @@ namespace StardewModdingAPI.Framework
         /// <param name="level">The log severity level.</param>
         public void Log(string message, LogLevel level = LogLevel.Debug)
         {
-            this.LogImpl(this.Source, message, Monitor.Colors[level], level);
+            this.LogImpl(this.Source, message, level, Monitor.Colors[level]);
         }
 
         /// <summary>Immediately exit the game without saving. This should only be invoked when an irrecoverable fatal error happens that risks save corruption or game-breaking bugs.</summary>
@@ -83,8 +86,7 @@ namespace StardewModdingAPI.Framework
         /// <param name="message">The message to log.</param>
         internal void LogFatal(string message)
         {
-            Console.BackgroundColor = ConsoleColor.Red;
-            this.LogImpl(this.Source, message, ConsoleColor.White, LogLevel.Error);
+            this.LogImpl(this.Source, message, LogLevel.Error, ConsoleColor.White, background: ConsoleColor.Red);
         }
 
         /// <summary>Log a message for the player or developer, using the specified console color.</summary>
@@ -95,7 +97,7 @@ namespace StardewModdingAPI.Framework
         [Obsolete("This method is provided for backwards compatibility and otherwise should not be used. Use " + nameof(Monitor) + "." + nameof(Monitor.Log) + " instead.")]
         internal void LegacyLog(string source, string message, ConsoleColor color, LogLevel level = LogLevel.Debug)
         {
-            this.LogImpl(source, message, color, level);
+            this.LogImpl(source, message, level, color);
         }
 
 
@@ -105,9 +107,10 @@ namespace StardewModdingAPI.Framework
         /// <summary>Write a message line to the log.</summary>
         /// <param name="source">The name of the mod logging the message.</param>
         /// <param name="message">The message to log.</param>
-        /// <param name="color">The console color.</param>
         /// <param name="level">The log level.</param>
-        private void LogImpl(string source, string message, ConsoleColor color, LogLevel level)
+        /// <param name="color">The console foreground color.</param>
+        /// <param name="background">The console background color (or <c>null</c> to leave it as-is).</param>
+        private void LogImpl(string source, string message, LogLevel level, ConsoleColor color, ConsoleColor? background = null)
         {
             // generate message
             string levelStr = level.ToString().ToUpper().PadRight(Monitor.MaxLevelLength);
@@ -116,30 +119,19 @@ namespace StardewModdingAPI.Framework
             // log
             if (this.WriteToConsole && (this.ShowTraceInConsole || level != LogLevel.Trace))
             {
-                if (Monitor.ConsoleSupportsColor)
+                this.ConsoleManager.ExclusiveWriteWithoutInterception(() =>
                 {
-                    Console.ForegroundColor = color;
-                    Console.WriteLine(message);
-                    Console.ResetColor();
-                }
-                else
-                    Console.WriteLine(message);
+                    if (this.ConsoleManager.SupportsColor)
+                    {
+                        Console.ForegroundColor = color;
+                        Console.WriteLine(message);
+                        Console.ResetColor();
+                    }
+                    else
+                        Console.WriteLine(message);
+                });
             }
             this.LogFile.WriteLine(message);
         }
-
-        /// <summary>Test whether the current console supports color formatting.</summary>
-        private static bool GetConsoleSupportsColor()
-        {
-            try
-            {
-                Console.ForegroundColor = Console.ForegroundColor;
-                return true;
-            }
-            catch (Exception)
-            {
-                return false; // Mono bug
-            }
-        }
     }
-}
\ No newline at end of file
+}