claunia/SabreTools
1
0
Fork 0
mirror of https://github.com/claunia/SabreTools.git synced 2025-12-16 19:14:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable nullability everywhere

Browse Source
This commit is contained in:
Matt Nadareski
2024-02-28 19:19:50 -05:00
parent 11d024bd16
commit 823a9ca7b7
145 changed files with 1545 additions and 1260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
SabreTools.Logging/LogEventArgs.cs
View File

@@ -7,7 +7,7 @@ namespace SabreTools.Logging
/// <summary>
/// Generic delegate type for log events
/// </summary>
public delegate void LogEventHandler(object sender, LogEventArgs args);
public delegate void LogEventHandler(object? sender, LogEventArgs args);
/// <summary>
/// Logging specific event arguments
@@ -22,12 +22,12 @@ namespace SabreTools.Logging
/// <summary>
/// Log statement to be printed
/// </summary>
public string Statement { get; set; } = null;
public string? Statement { get; set; } = null;
/// <summary>
/// Exception to be passed along to the event handler
/// </summary>
public Exception Exception { get; set; } = null;
public Exception? Exception { get; set; } = null;
/// <summary>
/// Total count for progress log events
@@ -42,7 +42,7 @@ namespace SabreTools.Logging
/// <summary>
/// Statement and exception constructor
/// </summary>
public LogEventArgs(LogLevel logLevel = LogLevel.VERBOSE, string statement = null, Exception exception = null)
public LogEventArgs(LogLevel logLevel = LogLevel.VERBOSE, string? statement = null, Exception? exception = null)
{
this.LogLevel = logLevel;
this.Statement = statement;
@@ -52,7 +52,7 @@ namespace SabreTools.Logging
/// <summary>
/// Progress constructor
/// </summary>
public LogEventArgs(long total, long current, LogLevel logLevel = LogLevel.VERBOSE, string statement = null)
public LogEventArgs(long total, long current, LogLevel logLevel = LogLevel.VERBOSE, string? statement = null)
{
this.LogLevel = logLevel;
this.Statement = statement;

20
SabreTools.Logging/Logger.cs
View File

@@ -11,12 +11,12 @@ namespace SabreTools.Logging
/// Instance associated with this logger
/// </summary>
/// TODO: Derive class name for this object, if possible
private readonly object instance;
private readonly object? instance;
/// <summary>
/// Constructor
/// </summary>
public Logger(object instance = null)
public Logger(object? instance = null)
{
this.instance = instance;
}
@@ -29,7 +29,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public void Verbose(Exception ex, string output = null)
public void Verbose(Exception ex, string? output = null)
{
LoggerImpl.Verbose(this.instance, ex, output);
}
@@ -50,7 +50,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public void Verbose(long total, long current, string output = null)
public void Verbose(long total, long current, string? output = null)
{
LoggerImpl.Verbose(instance, total, current, output);
}
@@ -61,7 +61,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public void User(Exception ex, string output = null)
public void User(Exception ex, string? output = null)
{
LoggerImpl.User(this.instance, ex, output);
}
@@ -82,7 +82,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public void User(long total, long current, string output = null)
public void User(long total, long current, string? output = null)
{
LoggerImpl.User(instance, total, current, output);
}
@@ -93,7 +93,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public void Warning(Exception ex, string output = null)
public void Warning(Exception ex, string? output = null)
{
LoggerImpl.Warning(this.instance, ex, output);
}
@@ -114,7 +114,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public void Warning(long total, long current, string output = null)
public void Warning(long total, long current, string? output = null)
{
LoggerImpl.Warning(instance, total, current, output);
}
@@ -125,7 +125,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public void Error(Exception ex, string output = null)
public void Error(Exception ex, string? output = null)
{
LoggerImpl.Error(this.instance, ex, output);
}
@@ -146,7 +146,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public void Error(long total, long current, string output = null)
public void Error(long total, long current, string? output = null)
{
LoggerImpl.Error(instance, total, current, output);
}

44
SabreTools.Logging/LoggerImpl.cs
View File

@@ -17,7 +17,7 @@ namespace SabreTools.Logging
/// <summary>
/// Optional output filename for logs
/// </summary>
public static string Filename { get; private set; } = null;
public static string? Filename { get; private set; } = null;
/// <summary>
/// Determines if we're logging to file or not
@@ -27,7 +27,7 @@ namespace SabreTools.Logging
/// <summary>
/// Optional output log directory
/// </summary>
public static string LogDirectory { get; private set; } = null;
public static string? LogDirectory { get; private set; } = null;
/// <summary>
/// Determines the lowest log level to output
@@ -66,7 +66,7 @@ namespace SabreTools.Logging
/// <summary>
/// StreamWriter representing the output log file
/// </summary>
private static StreamWriter _log;
private static StreamWriter? _log;
/// <summary>
/// Object lock for multithreaded logging
@@ -117,7 +117,7 @@ namespace SabreTools.Logging
if (!string.IsNullOrEmpty(LogDirectory) && !Directory.Exists(LogDirectory))
Directory.CreateDirectory(LogDirectory);
FileStream logfile = File.Create(Path.Combine(LogDirectory, Filename));
FileStream logfile = File.Create(Path.Combine(LogDirectory ?? string.Empty, Filename ?? string.Empty));
_log = new StreamWriter(logfile, Encoding.UTF8, 4096, true)
{
AutoFlush = true
@@ -166,10 +166,10 @@ namespace SabreTools.Logging
try
{
_log.WriteLine($"Logging ended {DateTime.Now:yyyy-MM-dd HH:mm:ss}");
_log.WriteLine($"Total runtime: {total}");
_log?.WriteLine($"Logging ended {DateTime.Now:yyyy-MM-dd HH:mm:ss}");
_log?.WriteLine($"Total runtime: {total}");
Console.WriteLine($"Total runtime: {total}");
_log.Close();
_log?.Close();
}
catch
{
@@ -180,7 +180,7 @@ namespace SabreTools.Logging
{
try
{
_log.Close();
_log?.Close();
}
catch
{
@@ -203,7 +203,7 @@ namespace SabreTools.Logging
/// <summary>
/// Default log event handling
/// </summary>
public static void HandleLogEvent(object sender, LogEventArgs args)
public static void HandleLogEvent(object? sender, LogEventArgs args)
{
// Null args means we can't handle it
if (args == null)
@@ -261,7 +261,7 @@ namespace SabreTools.Logging
{
lock (_lock)
{
_log.WriteLine((AppendPrefix ? $"{loglevel} - {DateTime.Now} - " : string.Empty) + output);
_log?.WriteLine((AppendPrefix ? $"{loglevel} - {DateTime.Now} - " : string.Empty) + output);
}
}
catch (Exception ex) when (ThrowOnError)
@@ -286,7 +286,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Verbose(object instance, Exception ex, string output = null)
public static void Verbose(object? instance, Exception ex, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.VERBOSE, output, ex));
}
@@ -297,7 +297,7 @@ namespace SabreTools.Logging
/// <param name="instance">Instance object that's the source of logging</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Verbose(object instance, string output)
public static void Verbose(object? instance, string output)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.VERBOSE, output, null));
}
@@ -309,7 +309,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public static void Verbose(object instance, long total, long current, string output = null)
public static void Verbose(object? instance, long total, long current, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(total, current, LogLevel.VERBOSE, output));
}
@@ -321,7 +321,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void User(object instance, Exception ex, string output = null)
public static void User(object? instance, Exception ex, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.USER, output, ex));
}
@@ -332,7 +332,7 @@ namespace SabreTools.Logging
/// <param name="instance">Instance object that's the source of logging</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void User(object instance, string output)
public static void User(object? instance, string output)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.USER, output, null));
}
@@ -344,7 +344,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public static void User(object instance, long total, long current, string output = null)
public static void User(object? instance, long total, long current, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(total, current, LogLevel.USER, output));
}
@@ -356,7 +356,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Warning(object instance, Exception ex, string output = null)
public static void Warning(object? instance, Exception ex, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.WARNING, output, ex));
}
@@ -367,7 +367,7 @@ namespace SabreTools.Logging
/// <param name="instance">Instance object that's the source of logging</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Warning(object instance, string output)
public static void Warning(object? instance, string output)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.WARNING, output, null));
}
@@ -379,7 +379,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public static void Warning(object instance, long total, long current, string output = null)
public static void Warning(object? instance, long total, long current, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(total, current, LogLevel.WARNING, output));
}
@@ -391,7 +391,7 @@ namespace SabreTools.Logging
/// <param name="ex">Exception to be written log</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Error(object instance, Exception ex, string output = null)
public static void Error(object? instance, Exception ex, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.ERROR, output, ex));
}
@@ -402,7 +402,7 @@ namespace SabreTools.Logging
/// <param name="instance">Instance object that's the source of logging</param>
/// <param name="output">String to be written log</param>
/// <returns>True if the output could be written, false otherwise</returns>
public static void Error(object instance, string output)
public static void Error(object? instance, string output)
{
LogEventHandler(instance, new LogEventArgs(LogLevel.ERROR, output, null));
}
@@ -414,7 +414,7 @@ namespace SabreTools.Logging
/// <param name="total">Total count for progress</param>
/// <param name="current">Current count for progres</param>
/// <param name="output">String to be written log</param>
public static void Error(object instance, long total, long current, string output = null)
public static void Error(object? instance, long total, long current, string? output = null)
{
LogEventHandler(instance, new LogEventArgs(total, current, LogLevel.ERROR, output));
}

2
SabreTools.Logging/SabreTools.Logging.csproj
View File

@@ -12,7 +12,7 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="SabreTools.IO" Version="1.2.0" />
<PackageReference Include="SabreTools.IO" Version="1.3.0" />
</ItemGroup>
</Project>