summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Log.cs
blob: 15c4ce55a0c257c59ea47b2923b32541db3cc3f8 (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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

namespace StardewModdingAPI
{
    public static class Log
    {
        private static readonly LogWriter _writer;

        static Log()
        {
            _writer = LogWriter.Instance;
        }

        private static void PrintLog(LogInfo li)
        {
            _writer.WriteToLog(li);
        }

        #region Exception Logging

        /// <summary>
        ///     Catch unhandled exception from the application
        /// </summary>
        /// <remarks>Should be moved out of here if we do more than just log the exception.</remarks>
        public static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
        {
            Console.WriteLine("An exception has been caught");
            File.WriteAllText(Path.Combine(Constants.LogDir, $"MODDED_ErrorLog.Log_{DateTime.UtcNow.Ticks}.txt"), e.ExceptionObject.ToString());
        }

        /// <summary>
        ///     Catch thread exception from the application
        /// </summary>
        /// <remarks>Should be moved out of here if we do more than just log the exception.</remarks>
        public static void Application_ThreadException(object sender, ThreadExceptionEventArgs e)
        {
            Console.WriteLine("A thread exception has been caught");
            File.WriteAllText(Path.Combine(Constants.LogDir, $"MODDED_ErrorLog.Log_{Extensions.Random.Next(100000000, 999999999)}.txt"), e.Exception.ToString());
        }

        #endregion

        #region Sync Logging

        /// <summary>
        ///     NOTICE: Sync logging is discouraged. Please use Async instead.
        /// </summary>
        /// <param name="message">Message to log</param>
        /// <param name="colour">Colour of message</param>
        public static void SyncColour(object message, ConsoleColor colour)
        {
            PrintLog(new LogInfo(message?.ToString(), colour));
        }

        #endregion

        #region Async Logging

        public static void AsyncColour(object message, ConsoleColor colour)
        {
            Task.Run(() => { PrintLog(new LogInfo(message?.ToString(), colour)); });
        }

        public static void Async(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Gray);
        }

        public static void AsyncR(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Red);
        }

        public static void AsyncO(object message)
        {
            AsyncColour(message.ToString(), ConsoleColor.DarkYellow);
        }

        public static void AsyncY(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Yellow);
        }

        public static void AsyncG(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Green);
        }

        public static void AsyncC(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Cyan);
        }

        public static void AsyncM(object message)
        {
            AsyncColour(message?.ToString(), ConsoleColor.Magenta);
        }

        public static void Error(object message)
        {
            AsyncR("[ERROR] " + message);
        }

        public static void Success(object message)
        {
            AsyncG("[SUCCESS] " + message);
        }

        public static void Info(object message)
        {
            AsyncY("[INFO] " + message);
        }

        public static void Out(object message)
        {
            Async("[OUT] " + message);
        }

        public static void Debug(object message)
        {
            AsyncO("[DEBUG] " + message);
        }

        #endregion

        #region ToRemove

        public static void LogValueNotSpecified()
        {
            AsyncR("<value> must be specified");
        }

        public static void LogObjectValueNotSpecified()
        {
            AsyncR("<object> and <value> must be specified");
        }

        public static void LogValueInvalid()
        {
            AsyncR("<value> is invalid");
        }

        public static void LogObjectInvalid()
        {
            AsyncR("<object> is invalid");
        }

        public static void LogValueNotInt32()
        {
            AsyncR("<value> must be a whole number (Int32)");
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        private static void PrintLog(object message, bool disableLogging, params object[] values)
        {
            PrintLog(new LogInfo(message?.ToString()));
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Success(object message, params object[] values)
        {
            Success(message);
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Verbose(object message, params object[] values)
        {
            Out(message);
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Comment(object message, params object[] values)
        {
            AsyncC(message);
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Info(object message, params object[] values)
        {
            Info(message);
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Error(object message, params object[] values)
        {
            Error(message);
        }

        [Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
        public static void Debug(object message, params object[] values)
        {
            Debug(message);
        }

        #endregion
    }
}