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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
#if SMAPI_1_x
using System;
using System.Threading;
using StardewModdingAPI.Framework;
using Monitor = StardewModdingAPI.Framework.Monitor;
namespace StardewModdingAPI
{
/// <summary>A singleton which logs messages to the SMAPI console and log file.</summary>
[Obsolete("Use " + nameof(Mod) + "." + nameof(Mod.Monitor))]
public static class Log
{
/*********
** Properties
*********/
/// <summary>Manages deprecation warnings.</summary>
private static DeprecationManager DeprecationManager;
/// <summary>The underlying logger.</summary>
private static Monitor Monitor;
/// <summary>Tracks the installed mods.</summary>
private static ModRegistry ModRegistry;
/*********
** Public methods
*********/
/// <summary>Injects types required for backwards compatibility.</summary>
/// <param name="deprecationManager">Manages deprecation warnings.</param>
/// <param name="monitor">The underlying logger.</param>
/// <param name="modRegistry">Tracks the installed mods.</param>
internal static void Shim(DeprecationManager deprecationManager, Monitor monitor, ModRegistry modRegistry)
{
Log.DeprecationManager = deprecationManager;
Log.Monitor = monitor;
Log.ModRegistry = modRegistry;
}
/****
** Exceptions
****/
/// <summary>Log an exception event.</summary>
/// <param name="sender">The event sender.</param>
/// <param name="e">The event arguments.</param>
public static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
{
Log.WarnDeprecated();
Log.Monitor.Log($"Critical app domain exception: {e.ExceptionObject}", LogLevel.Error);
}
/// <summary>Log a thread exception event.</summary>
/// <param name="sender">The event sender.</param>
/// <param name="e">The event arguments.</param>
public static void Application_ThreadException(object sender, ThreadExceptionEventArgs e)
{
Log.WarnDeprecated();
Log.Monitor.Log($"Critical thread exception: {e.Exception}", LogLevel.Error);
}
/****
** Synchronous logging
****/
/// <summary>Synchronously log a message to the console. NOTE: synchronous logging is discouraged; use asynchronous methods instead.</summary>
/// <param name="message">The message to log.</param>
/// <param name="color">The message color.</param>
public static void SyncColour(object message, ConsoleColor color)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), color);
}
/****
** Asynchronous logging
****/
/// <summary>Asynchronously log a message to the console with the specified color.</summary>
/// <param name="message">The message to log.</param>
/// <param name="color">The message color.</param>
public static void AsyncColour(object message, ConsoleColor color)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), color);
}
/// <summary>Asynchronously log a message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Async(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Gray);
}
/// <summary>Asynchronously log a red message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncR(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Red);
}
/// <summary>Asynchronously log an orange message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncO(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.DarkYellow);
}
/// <summary>Asynchronously log a yellow message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncY(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Yellow);
}
/// <summary>Asynchronously log a green message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncG(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Green);
}
/// <summary>Asynchronously log a cyan message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncC(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Cyan);
}
/// <summary>Asynchronously log a magenta message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void AsyncM(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Magenta);
}
/// <summary>Asynchronously log a warning to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Warning(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Yellow, LogLevel.Warn);
}
/// <summary>Asynchronously log an error to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Error(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Red, LogLevel.Error);
}
/// <summary>Asynchronously log a success message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Success(object message)
{
Log.WarnDeprecated();
Log.AsyncG(message);
}
/// <summary>Asynchronously log an info message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Info(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.White, LogLevel.Info);
}
/// <summary>Asynchronously log an info message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Out(object message)
{
Log.WarnDeprecated();
Log.Async($"[OUT] {message}");
}
/// <summary>Asynchronously log a debug message to the console.</summary>
/// <param name="message">The message to log.</param>
public static void Debug(object message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.DarkGray);
}
/// <summary>Asynchronously log a message to the file that's not shown in the console.</summary>
/// <param name="message">The message to log.</param>
internal static void LogToFile(string message)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message, ConsoleColor.DarkGray, LogLevel.Trace);
}
/// <summary>Obsolete.</summary>
public static void LogValueNotSpecified()
{
Log.WarnDeprecated();
Log.AsyncR("<value> must be specified");
}
/// <summary>Obsolete.</summary>
public static void LogObjectValueNotSpecified()
{
Log.WarnDeprecated();
Log.AsyncR("<object> and <value> must be specified");
}
/// <summary>Obsolete.</summary>
public static void LogValueInvalid()
{
Log.WarnDeprecated();
Log.AsyncR("<value> is invalid");
}
/// <summary>Obsolete.</summary>
public static void LogObjectInvalid()
{
Log.WarnDeprecated();
Log.AsyncR("<object> is invalid");
}
/// <summary>Obsolete.</summary>
public static void LogValueNotInt32()
{
Log.WarnDeprecated();
Log.AsyncR("<value> must be a whole number (Int32)");
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="disableLogging">Obsolete.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
private static void PrintLog(object message, bool disableLogging, params object[] values)
{
Log.WarnDeprecated();
Log.Monitor.LegacyLog(Log.GetModName(), message?.ToString(), ConsoleColor.Gray);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Success(object message, params object[] values)
{
Log.WarnDeprecated();
Log.Success(message);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Verbose(object message, params object[] values)
{
Log.WarnDeprecated();
Log.Out(message);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Comment(object message, params object[] values)
{
Log.WarnDeprecated();
Log.AsyncC(message);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Info(object message, params object[] values)
{
Log.WarnDeprecated();
Log.Info(message);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Error(object message, params object[] values)
{
Log.WarnDeprecated();
Log.Error(message);
}
/// <summary>Obsolete.</summary>
/// <param name="message">The message to log.</param>
/// <param name="values">Obsolete.</param>
[Obsolete("Parameter 'values' is no longer supported. Format before logging.")]
public static void Debug(object message, params object[] values)
{
Log.WarnDeprecated();
Log.Debug(message);
}
/*********
** Private methods
*********/
/// <summary>Raise a deprecation warning.</summary>
private static void WarnDeprecated()
{
Log.DeprecationManager.Warn($"the {nameof(Log)} class", "1.1", DeprecationLevel.PendingRemoval);
}
/// <summary>Get the name of the mod logging a message from the stack.</summary>
private static string GetModName()
{
return Log.ModRegistry.GetModFromStack() ?? "<unknown mod>";
}
}
}
#endif
|
