summaryrefslogtreecommitdiff
path: root/src/SMAPI.Internal/ConsoleWriting/ColorfulConsoleWriter.cs
blob: c04cf0e76eadbce0a4122583a263609682ed9abe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
using System;
using System.Collections.Generic;

namespace StardewModdingAPI.Internal.ConsoleWriting
{
    /// <summary>Provides a wrapper for writing color-coded text to the console.</summary>
    internal class ColorfulConsoleWriter
    {
        /*********
        ** Properties
        *********/
        /// <summary>The console text color for each log level.</summary>
        private readonly IDictionary<ConsoleLogLevel, ConsoleColor> Colors;

        /// <summary>Whether the current console supports color formatting.</summary>
        private readonly bool SupportsColor;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="platform">The target platform.</param>
        /// <param name="colorScheme">The console color scheme to use.</param>
        public ColorfulConsoleWriter(Platform platform, MonitorColorScheme colorScheme)
        {
            this.SupportsColor = this.TestColorSupport();
            this.Colors = this.GetConsoleColorScheme(platform, colorScheme);
        }

        /// <summary>Write a message line to the log.</summary>
        /// <param name="message">The message to log.</param>
        /// <param name="level">The log level.</param>
        public void WriteLine(string message, ConsoleLogLevel level)
        {
            if (this.SupportsColor)
            {
                if (level == ConsoleLogLevel.Critical)
                {
                    Console.BackgroundColor = ConsoleColor.Red;
                    Console.ForegroundColor = ConsoleColor.White;
                    Console.WriteLine(message);
                    Console.ResetColor();
                }
                else
                {
                    Console.ForegroundColor = this.Colors[level];
                    Console.WriteLine(message);
                    Console.ResetColor();
                }
            }
            else
                Console.WriteLine(message);
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Test whether the current console supports color formatting.</summary>
        private bool TestColorSupport()
        {
            try
            {
                Console.ForegroundColor = Console.ForegroundColor;
                return true;
            }
            catch (Exception)
            {
                return false; // Mono bug
            }
        }

        /// <summary>Get the color scheme to use for the current console.</summary>
        /// <param name="platform">The target platform.</param>
        /// <param name="colorScheme">The console color scheme to use.</param>
        private IDictionary<ConsoleLogLevel, ConsoleColor> GetConsoleColorScheme(Platform platform, MonitorColorScheme colorScheme)
        {
            // auto detect color scheme
            if (colorScheme == MonitorColorScheme.AutoDetect)
            {
                colorScheme = platform == Platform.Mac
                    ? MonitorColorScheme.LightBackground // MacOS doesn't provide console background color info, but it's usually white.
                    : ColorfulConsoleWriter.IsDark(Console.BackgroundColor) ? MonitorColorScheme.DarkBackground : MonitorColorScheme.LightBackground;
            }

            // get colors for scheme
            switch (colorScheme)
            {
                case MonitorColorScheme.DarkBackground:
                    return new Dictionary<ConsoleLogLevel, ConsoleColor>
                    {
                        [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
                        [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
                        [ConsoleLogLevel.Info] = ConsoleColor.White,
                        [ConsoleLogLevel.Warn] = ConsoleColor.Yellow,
                        [ConsoleLogLevel.Error] = ConsoleColor.Red,
                        [ConsoleLogLevel.Alert] = ConsoleColor.Magenta,
                        [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
                    };

                case MonitorColorScheme.LightBackground:
                    return new Dictionary<ConsoleLogLevel, ConsoleColor>
                    {
                        [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
                        [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
                        [ConsoleLogLevel.Info] = ConsoleColor.Black,
                        [ConsoleLogLevel.Warn] = ConsoleColor.DarkYellow,
                        [ConsoleLogLevel.Error] = ConsoleColor.Red,
                        [ConsoleLogLevel.Alert] = ConsoleColor.DarkMagenta,
                        [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
                    };

                default:
                    throw new NotSupportedException($"Unknown color scheme '{colorScheme}'.");
            }
        }

        /// <summary>Get whether a console color should be considered dark, which is subjectively defined as 'white looks better than black on this text'.</summary>
        /// <param name="color">The color to check.</param>
        private static bool IsDark(ConsoleColor color)
        {
            switch (color)
            {
                case ConsoleColor.Black:
                case ConsoleColor.Blue:
                case ConsoleColor.DarkBlue:
                case ConsoleColor.DarkMagenta: // Powershell
                case ConsoleColor.DarkRed:
                case ConsoleColor.Red:
                    return true;

                default:
                    return false;
            }
        }
    }
}