From 46b7d7a4001e209d7201ed5cad38cad2f1ad2a7f Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 11 Feb 2017 01:15:56 -0500
Subject: 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.
---
 .../Logging/ConsoleInterceptionManager.cs          | 86 ++++++++++++++++++++++
 .../Framework/Logging/InterceptingTextWriter.cs    | 79 ++++++++++++++++++++
 .../Framework/Logging/LogFileManager.cs            | 48 ++++++++++++
 3 files changed, 213 insertions(+)
 create mode 100644 src/StardewModdingAPI/Framework/Logging/ConsoleInterceptionManager.cs
 create mode 100644 src/StardewModdingAPI/Framework/Logging/InterceptingTextWriter.cs
 create mode 100644 src/StardewModdingAPI/Framework/Logging/LogFileManager.cs

(limited to 'src/StardewModdingAPI/Framework/Logging')

diff --git a/src/StardewModdingAPI/Framework/Logging/ConsoleInterceptionManager.cs b/src/StardewModdingAPI/Framework/Logging/ConsoleInterceptionManager.cs
new file mode 100644
index 00000000..d84671ee
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Logging/ConsoleInterceptionManager.cs
@@ -0,0 +1,86 @@
+using System;
+
+namespace StardewModdingAPI.Framework.Logging
+{
+    /// <summary>Manages console output interception.</summary>
+    internal class ConsoleInterceptionManager : IDisposable
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The intercepting console writer.</summary>
+        private readonly InterceptingTextWriter Output;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether the current console supports color formatting.</summary>
+        public bool SupportsColor { get; }
+
+        /// <summary>The event raised when something writes a line to the console directly.</summary>
+        public event Action<string> OnLineIntercepted;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public ConsoleInterceptionManager()
+        {
+            // redirect output through interceptor
+            this.Output = new InterceptingTextWriter(Console.Out);
+            this.Output.OnLineIntercepted += line => this.OnLineIntercepted?.Invoke(line);
+            Console.SetOut(this.Output);
+
+            // test color support
+            this.SupportsColor = this.TestColorSupport();
+        }
+
+        /// <summary>Get an exclusive lock and write to the console output without interception.</summary>
+        /// <param name="action">The action to perform within the exclusive write block.</param>
+        public void ExclusiveWriteWithoutInterception(Action action)
+        {
+            lock (Console.Out)
+            {
+                try
+                {
+                    this.Output.ShouldIntercept = false;
+                    action();
+                }
+                finally
+                {
+                    this.Output.ShouldIntercept = true;
+                }
+            }
+        }
+
+        /// <summary>Release all resources.</summary>
+        public void Dispose()
+        {
+            Console.SetOut(this.Output.Out);
+            this.Output.Dispose();
+        }
+
+
+        /*********
+        ** private methods
+        *********/
+        /// <summary>Test whether the current console supports color formatting.</summary>
+        private bool TestColorSupport()
+        {
+            try
+            {
+                this.ExclusiveWriteWithoutInterception(() =>
+                {
+                    Console.ForegroundColor = Console.ForegroundColor;
+                });
+                return true;
+            }
+            catch (Exception)
+            {
+                return false; // Mono bug
+            }
+        }
+    }
+}
diff --git a/src/StardewModdingAPI/Framework/Logging/InterceptingTextWriter.cs b/src/StardewModdingAPI/Framework/Logging/InterceptingTextWriter.cs
new file mode 100644
index 00000000..14789109
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Logging/InterceptingTextWriter.cs
@@ -0,0 +1,79 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+
+namespace StardewModdingAPI.Framework.Logging
+{
+    /// <summary>A text writer which allows intercepting output.</summary>
+    internal class InterceptingTextWriter : TextWriter
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The current line being intercepted.</summary>
+        private readonly List<char> Line = new List<char>();
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The underlying console output.</summary>
+        public TextWriter Out { get; }
+
+        /// <summary>The character encoding in which the output is written.</summary>
+        public override Encoding Encoding => this.Out.Encoding;
+
+        /// <summary>Whether to intercept console output.</summary>
+        public bool ShouldIntercept { get; set; }
+
+        /// <summary>The event raised when a line of text is intercepted.</summary>
+        public event Action<string> OnLineIntercepted;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="output">The underlying output writer.</param>
+        public InterceptingTextWriter(TextWriter output)
+        {
+            this.Out = output;
+        }
+
+        /// <summary>Writes a character to the text string or stream.</summary>
+        /// <param name="ch">The character to write to the text stream.</param>
+        public override void Write(char ch)
+        {
+            // intercept
+            if (this.ShouldIntercept)
+            {
+                switch (ch)
+                {
+                    case '\r':
+                        return;
+
+                    case '\n':
+                        this.OnLineIntercepted?.Invoke(new string(this.Line.ToArray()));
+                        this.Line.Clear();
+                        break;
+
+                    default:
+                        this.Line.Add(ch);
+                        break;
+                }
+            }
+
+            // pass through
+            else
+                this.Out.Write(ch);
+        }
+
+        /// <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.TextWriter" /> and optionally releases the managed resources.</summary>
+        /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+        protected override void Dispose(bool disposing)
+        {
+            this.OnLineIntercepted = null;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI/Framework/Logging/LogFileManager.cs b/src/StardewModdingAPI/Framework/Logging/LogFileManager.cs
new file mode 100644
index 00000000..1f6ade1d
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Logging/LogFileManager.cs
@@ -0,0 +1,48 @@
+using System;
+using System.IO;
+
+namespace StardewModdingAPI.Framework.Logging
+{
+    /// <summary>Manages reading and writing to log file.</summary>
+    internal class LogFileManager : IDisposable
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying stream writer.</summary>
+        private readonly StreamWriter Stream;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="path">The log file to write.</param>
+        public LogFileManager(string path)
+        {
+            // create log directory if needed
+            string logDir = Path.GetDirectoryName(path);
+            if (logDir == null)
+                throw new ArgumentException($"The log path '{path}' is not valid.");
+            Directory.CreateDirectory(logDir);
+
+            // open log file stream
+            this.Stream = new StreamWriter(path, append: false) { AutoFlush = true };
+        }
+
+        /// <summary>Write a message to the log.</summary>
+        /// <param name="message">The message to log.</param>
+        public void WriteLine(string message)
+        {
+            // always use Windows-style line endings for convenience
+            // (Linux/Mac editors are fine with them, Windows editors often require them)
+            this.Stream.Write(message + "\r\n");
+        }
+
+        /// <summary>Release all resources.</summary>
+        public void Dispose()
+        {
+            this.Stream.Dispose();
+        }
+    }
+}
-- 
cgit