From d67327231bb323d2a72bd1507a59ea3e4ce80e9a Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Wed, 8 Jan 2025 16:59:44 -0500 Subject: [PATCH] Make Logger naming consistent --- SabreTools.DatFiles/DatFile.cs | 30 +++++++++---------- SabreTools.DatFiles/DatFileTool.cs | 4 +-- SabreTools.DatFiles/Formats/ClrMamePro.cs | 10 +++---- SabreTools.DatFiles/Formats/Hashfile.cs | 10 +++---- SabreTools.DatFiles/Formats/Listxml.cs | 2 +- SabreTools.DatFiles/Formats/Logiqx.cs | 8 ++--- SabreTools.DatFiles/Formats/Missfile.cs | 16 +++++----- SabreTools.DatFiles/Formats/SabreJSON.cs | 18 +++++------ SabreTools.DatFiles/Formats/SabreXML.cs | 18 +++++------ SabreTools.DatFiles/Formats/SeparatedValue.cs | 10 +++---- SabreTools.DatFiles/ItemDictionary.cs | 16 +++++----- SabreTools.DatFiles/ItemDictionaryDB.cs | 6 ++-- SabreTools.DatFiles/Parser.cs | 4 +-- SabreTools.DatFiles/SerializableDatFile.cs | 18 +++++------ SabreTools.DatItems/DatItem.cs | 2 +- SabreTools.DatTools/Cleaner.cs | 4 +-- SabreTools.DatTools/DatFromDir.cs | 26 ++++++++-------- SabreTools.DatTools/ExtraIni.cs | 10 +++---- SabreTools.DatTools/MergeSplit.cs | 16 +++++----- SabreTools.DatTools/Rebuilder.cs | 24 +++++++-------- SabreTools.DatTools/Remover.cs | 6 ++-- SabreTools.DatTools/Setter.cs | 6 ++-- SabreTools.DatTools/Splitter.cs | 8 ++--- SabreTools.DatTools/Statistics.cs | 8 ++--- SabreTools.DatTools/Verification.cs | 10 +++---- SabreTools.DatTools/Writer.cs | 12 ++++---- SabreTools.FileTypes/FileTypeTool.cs | 8 ++--- SabreTools.Help/TopLevel.cs | 6 ++-- SabreTools.Reports/BaseReport.cs | 2 +- SabreTools.Reports/Formats/Html.cs | 4 +-- SabreTools.Reports/Formats/SeparatedValue.cs | 4 +-- SabreTools.Reports/Formats/Textfile.cs | 4 +-- SabreTools/Features/BaseFeature.cs | 4 +-- SabreTools/Features/Batch.cs | 14 ++++----- SabreTools/Features/Split.cs | 6 ++-- SabreTools/Features/Update.cs | 2 +- SabreTools/Features/Verify.cs | 4 +-- SabreTools/Features/Version.cs | 2 +- SabreTools/Program.cs | 10 +++---- 39 files changed, 186 insertions(+), 186 deletions(-) diff --git a/SabreTools.DatFiles/DatFile.cs b/SabreTools.DatFiles/DatFile.cs index accfca5a..031d120e 100644 --- a/SabreTools.DatFiles/DatFile.cs +++ b/SabreTools.DatFiles/DatFile.cs @@ -47,7 +47,7 @@ namespace SabreTools.DatFiles /// Logging object /// [JsonIgnore, XmlIgnore] - protected Logger logger; + protected Logger _logger; #endregion @@ -59,7 +59,7 @@ namespace SabreTools.DatFiles /// DatFile to get the values from public DatFile(DatFile? datFile) { - logger = new Logger(this); + _logger = new Logger(this); if (datFile != null) { Header = datFile.Header; @@ -656,7 +656,7 @@ namespace SabreTools.DatFiles if (rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) == null && rom.GetStringFieldValue(Models.Metadata.Rom.CRCKey) == "null") { - logger.Verbose($"Empty folder found: {machine.GetStringFieldValue(Models.Metadata.Machine.NameKey)}"); + _logger.Verbose($"Empty folder found: {machine.GetStringFieldValue(Models.Metadata.Machine.NameKey)}"); rom.SetName(rom.GetName() == "null" ? "-" : rom.GetName()); rom.SetFieldValue(Models.Metadata.Rom.SizeKey, Constants.SizeZero.ToString()); @@ -700,7 +700,7 @@ namespace SabreTools.DatFiles if (rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) == null && rom.GetStringFieldValue(Models.Metadata.Rom.CRCKey) == "null") { - logger.Verbose($"Empty folder found: {machineObj.GetStringFieldValue(Models.Metadata.Machine.NameKey)}"); + _logger.Verbose($"Empty folder found: {machineObj.GetStringFieldValue(Models.Metadata.Machine.NameKey)}"); rom.SetName(rom.GetName() == "null" ? "-" : rom.GetName()); rom.SetFieldValue(Models.Metadata.Rom.SizeKey, Constants.SizeZero.ToString()); @@ -828,14 +828,14 @@ namespace SabreTools.DatFiles if (datItem.GetDuplicateStatus(lastItem).HasFlag(DupeType.All)) #endif { - logger.Verbose($"Exact duplicate found for '{datItemName}'"); + _logger.Verbose($"Exact duplicate found for '{datItemName}'"); continue; } // If the current name matches the previous name, rename the current item else if (datItemName == lastItemName) { - logger.Verbose($"Name duplicate found for '{datItemName}'"); + _logger.Verbose($"Name duplicate found for '{datItemName}'"); if (datItem is Disk || datItem is DatItems.Formats.File || datItem is Media || datItem is Rom) { @@ -923,14 +923,14 @@ namespace SabreTools.DatFiles if (datItem.Value.GetDuplicateStatus(lastItem).HasFlag(DupeType.All)) #endif { - logger.Verbose($"Exact duplicate found for '{datItemName}'"); + _logger.Verbose($"Exact duplicate found for '{datItemName}'"); continue; } // If the current name matches the previous name, rename the current item else if (datItemName == lastItemName) { - logger.Verbose($"Name duplicate found for '{datItemName}'"); + _logger.Verbose($"Name duplicate found for '{datItemName}'"); if (datItem.Value is Disk || datItem.Value is DatItems.Formats.File || datItem.Value is Media || datItem.Value is Rom) { @@ -984,7 +984,7 @@ namespace SabreTools.DatFiles // If this is invoked with a null DatItem, we ignore if (datItem == null) { - logger?.Verbose($"Item was skipped because it was null"); + _logger?.Verbose($"Item was skipped because it was null"); return true; } @@ -992,7 +992,7 @@ namespace SabreTools.DatFiles if (datItem.GetBoolFieldValue(DatItem.RemoveKey) == true) { string itemString = JsonConvert.SerializeObject(datItem, Formatting.None); - logger?.Verbose($"Item '{itemString}' was skipped because it was marked for removal"); + _logger?.Verbose($"Item '{itemString}' was skipped because it was marked for removal"); return true; } @@ -1000,7 +1000,7 @@ namespace SabreTools.DatFiles if (datItem is Blank) { string itemString = JsonConvert.SerializeObject(datItem, Formatting.None); - logger?.Verbose($"Item '{itemString}' was skipped because it was of type 'Blank'"); + _logger?.Verbose($"Item '{itemString}' was skipped because it was of type 'Blank'"); return true; } @@ -1012,7 +1012,7 @@ namespace SabreTools.DatFiles if (size == 0 || size == null) { string itemString = JsonConvert.SerializeObject(datItem, Formatting.None); - logger?.Verbose($"Item '{itemString}' was skipped because it had an invalid size"); + _logger?.Verbose($"Item '{itemString}' was skipped because it had an invalid size"); return true; } } @@ -1023,7 +1023,7 @@ namespace SabreTools.DatFiles if (!Array.Exists(GetSupportedTypes(), t => t == itemType)) { string itemString = JsonConvert.SerializeObject(datItem, Formatting.None); - logger?.Verbose($"Item '{itemString}' was skipped because it was not supported in {datFormat}"); + _logger?.Verbose($"Item '{itemString}' was skipped because it was not supported in {datFormat}"); return true; } @@ -1033,9 +1033,9 @@ namespace SabreTools.DatFiles { string itemString = JsonConvert.SerializeObject(datItem, Formatting.None); #if NET20 || NET35 - logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", [.. missingFields])}"); + _logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", [.. missingFields])}"); #else - logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", missingFields)}"); + _logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {datFormat}: {string.Join(", ", missingFields)}"); #endif return true; } diff --git a/SabreTools.DatFiles/DatFileTool.cs b/SabreTools.DatFiles/DatFileTool.cs index d8b410d5..8f717d22 100644 --- a/SabreTools.DatFiles/DatFileTool.cs +++ b/SabreTools.DatFiles/DatFileTool.cs @@ -24,7 +24,7 @@ namespace SabreTools.DatFiles /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -1426,7 +1426,7 @@ namespace SabreTools.DatFiles #endif { var input = inputs[i]; - logger.User($"Adding DAT: {input.CurrentPath}"); + _staticLogger.User($"Adding DAT: {input.CurrentPath}"); datFiles[i] = DatFile.Create(datFile.Header.CloneFiltering()); Parser.ParseInto(datFiles[i], input, i, keep: true); #if NET40_OR_GREATER || NETCOREAPP diff --git a/SabreTools.DatFiles/Formats/ClrMamePro.cs b/SabreTools.DatFiles/Formats/ClrMamePro.cs index 99af5c8f..cb0c1ace 100644 --- a/SabreTools.DatFiles/Formats/ClrMamePro.cs +++ b/SabreTools.DatFiles/Formats/ClrMamePro.cs @@ -45,7 +45,7 @@ namespace SabreTools.DatFiles.Formats catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; - logger.Error(ex, message); + _logger.Error(ex, message); } } @@ -174,24 +174,24 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file var metadata = ConvertMetadata(ignoreblanks); var metadataFile = new Serialization.CrossModel.ClrMamePro().Deserialize(metadata); if (!Serialization.Serializers.ClrMamePro.SerializeFile(metadataFile, outfile, _quotes)) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } diff --git a/SabreTools.DatFiles/Formats/Hashfile.cs b/SabreTools.DatFiles/Formats/Hashfile.cs index 394a7160..9df69f79 100644 --- a/SabreTools.DatFiles/Formats/Hashfile.cs +++ b/SabreTools.DatFiles/Formats/Hashfile.cs @@ -37,7 +37,7 @@ namespace SabreTools.DatFiles.Formats catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; - logger.Error(ex, message); + _logger.Error(ex, message); } } @@ -194,24 +194,24 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file var metadata = ConvertMetadata(ignoreblanks); var hashfile = new Serialization.CrossModel.Hashfile().Deserialize(metadata, _hash); if (!(Serialization.Serializers.Hashfile.SerializeFile(hashfile, outfile, _hash))) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } diff --git a/SabreTools.DatFiles/Formats/Listxml.cs b/SabreTools.DatFiles/Formats/Listxml.cs index 0a702720..6fe9458e 100644 --- a/SabreTools.DatFiles/Formats/Listxml.cs +++ b/SabreTools.DatFiles/Formats/Listxml.cs @@ -209,7 +209,7 @@ namespace SabreTools.DatFiles.Formats catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; - logger.Error(ex, message); + _logger.Error(ex, message); } } diff --git a/SabreTools.DatFiles/Formats/Logiqx.cs b/SabreTools.DatFiles/Formats/Logiqx.cs index 35f23c23..2683a486 100644 --- a/SabreTools.DatFiles/Formats/Logiqx.cs +++ b/SabreTools.DatFiles/Formats/Logiqx.cs @@ -348,7 +348,7 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file var metadata = ConvertMetadata(ignoreblanks); @@ -364,17 +364,17 @@ namespace SabreTools.DatFiles.Formats if (!success) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } diff --git a/SabreTools.DatFiles/Formats/Missfile.cs b/SabreTools.DatFiles/Formats/Missfile.cs index 0d2dd074..429840da 100644 --- a/SabreTools.DatFiles/Formats/Missfile.cs +++ b/SabreTools.DatFiles/Formats/Missfile.cs @@ -39,13 +39,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -82,13 +82,13 @@ namespace SabreTools.DatFiles.Formats } } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); sw.Dispose(); fs.Dispose(); } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } @@ -100,13 +100,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -146,13 +146,13 @@ namespace SabreTools.DatFiles.Formats } } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); sw.Dispose(); fs.Dispose(); } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } diff --git a/SabreTools.DatFiles/Formats/SabreJSON.cs b/SabreTools.DatFiles/Formats/SabreJSON.cs index 9f2daf89..c172987f 100644 --- a/SabreTools.DatFiles/Formats/SabreJSON.cs +++ b/SabreTools.DatFiles/Formats/SabreJSON.cs @@ -74,7 +74,7 @@ namespace SabreTools.DatFiles.Formats } catch (Exception ex) when (!throwOnError) { - logger.Warning($"Exception found while parsing '{filename}': {ex}"); + _logger.Warning($"Exception found while parsing '{filename}': {ex}"); } jtr.Close(); @@ -365,13 +365,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = System.IO.File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -428,13 +428,13 @@ namespace SabreTools.DatFiles.Formats // Write the file footer out WriteFooter(jtw); - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); jtw.Close(); fs.Dispose(); } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } @@ -446,13 +446,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = System.IO.File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -509,13 +509,13 @@ namespace SabreTools.DatFiles.Formats // Write the file footer out WriteFooter(jtw); - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); jtw.Close(); fs.Dispose(); } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } diff --git a/SabreTools.DatFiles/Formats/SabreXML.cs b/SabreTools.DatFiles/Formats/SabreXML.cs index 828ee3c3..d89eb3dd 100644 --- a/SabreTools.DatFiles/Formats/SabreXML.cs +++ b/SabreTools.DatFiles/Formats/SabreXML.cs @@ -80,7 +80,7 @@ namespace SabreTools.DatFiles.Formats } catch (Exception ex) when (!throwOnError) { - logger.Warning(ex, $"Exception found while parsing '{filename}'"); + _logger.Warning(ex, $"Exception found while parsing '{filename}'"); // For XML errors, just skip the affected node xtr?.Read(); @@ -194,13 +194,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -256,7 +256,7 @@ namespace SabreTools.DatFiles.Formats // Write the file footer out WriteFooter(xtw); - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); #if NET452_OR_GREATER xtw.Dispose(); #endif @@ -264,7 +264,7 @@ namespace SabreTools.DatFiles.Formats } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } @@ -276,13 +276,13 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); FileStream fs = File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -338,7 +338,7 @@ namespace SabreTools.DatFiles.Formats // Write the file footer out WriteFooter(xtw); - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); #if NET452_OR_GREATER xtw.Dispose(); #endif @@ -346,7 +346,7 @@ namespace SabreTools.DatFiles.Formats } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } diff --git a/SabreTools.DatFiles/Formats/SeparatedValue.cs b/SabreTools.DatFiles/Formats/SeparatedValue.cs index 509dc41c..dba08db0 100644 --- a/SabreTools.DatFiles/Formats/SeparatedValue.cs +++ b/SabreTools.DatFiles/Formats/SeparatedValue.cs @@ -36,7 +36,7 @@ namespace SabreTools.DatFiles.Formats catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; - logger.Error(ex, message); + _logger.Error(ex, message); } } @@ -94,24 +94,24 @@ namespace SabreTools.DatFiles.Formats { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file var metadata = ConvertMetadata(ignoreblanks); var metadataFile = new Serialization.CrossModel.SeparatedValue().Deserialize(metadata); if (!(Serialization.Serializers.SeparatedValue.SerializeFile(metadataFile, outfile, _delim))) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } diff --git a/SabreTools.DatFiles/ItemDictionary.cs b/SabreTools.DatFiles/ItemDictionary.cs index 7fe708e9..6ea1297c 100644 --- a/SabreTools.DatFiles/ItemDictionary.cs +++ b/SabreTools.DatFiles/ItemDictionary.cs @@ -52,7 +52,7 @@ namespace SabreTools.DatFiles /// /// Logging object /// - private readonly Logger logger; + private readonly Logger _logger; #endregion @@ -108,7 +108,7 @@ namespace SabreTools.DatFiles { bucketedBy = ItemKey.NULL; mergedBy = DedupeType.None; - logger = new Logger(this); + _logger = new Logger(this); } #endregion @@ -196,7 +196,7 @@ namespace SabreTools.DatFiles && string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.MD5Key)) && string.IsNullOrEmpty(disk.GetStringFieldValue(Models.Metadata.Disk.SHA1Key))) { - logger.Verbose($"Incomplete entry for '{disk.GetName()}' will be output as nodump"); + _logger.Verbose($"Incomplete entry for '{disk.GetName()}' will be output as nodump"); disk.SetFieldValue(Models.Metadata.Disk.StatusKey, ItemStatus.Nodump.AsStringValue()); } @@ -210,7 +210,7 @@ namespace SabreTools.DatFiles && string.IsNullOrEmpty(media.GetStringFieldValue(Models.Metadata.Media.SHA256Key)) && string.IsNullOrEmpty(media.GetStringFieldValue(Models.Metadata.Media.SpamSumKey))) { - logger.Verbose($"Incomplete entry for '{media.GetName()}' will be output as nodump"); + _logger.Verbose($"Incomplete entry for '{media.GetName()}' will be output as nodump"); } item = media; @@ -539,20 +539,20 @@ namespace SabreTools.DatFiles // If the sorted type isn't the same, we want to sort the dictionary accordingly if (bucketedBy != bucketBy && bucketBy != ItemKey.NULL) { - logger.User($"Organizing roms by {bucketBy}"); + _logger.User($"Organizing roms by {bucketBy}"); PerformBucketing(bucketBy, lower, norename); } // If the merge type isn't the same, we want to merge the dictionary accordingly if (mergedBy != dedupeType) { - logger.User($"Deduping roms by {dedupeType}"); + _logger.User($"Deduping roms by {dedupeType}"); PerformDeduplication(bucketBy, dedupeType); } // If the merge type is the same, we want to sort the dictionary to be consistent else { - logger.User($"Sorting roms by {bucketBy}"); + _logger.User($"Sorting roms by {bucketBy}"); PerformSorting(); } } @@ -879,7 +879,7 @@ namespace SabreTools.DatFiles } catch (Exception ex) when (!throwOnError) { - logger.Warning(ex.ToString()); + _logger.Warning(ex.ToString()); } } diff --git a/SabreTools.DatFiles/ItemDictionaryDB.cs b/SabreTools.DatFiles/ItemDictionaryDB.cs index 42430977..5403e869 100644 --- a/SabreTools.DatFiles/ItemDictionaryDB.cs +++ b/SabreTools.DatFiles/ItemDictionaryDB.cs @@ -131,7 +131,7 @@ namespace SabreTools.DatFiles /// /// Logging object /// - private readonly Logger logger; + private readonly Logger _logger; #endregion @@ -165,7 +165,7 @@ namespace SabreTools.DatFiles /// public ItemDictionaryDB() { - logger = new Logger(this); + _logger = new Logger(this); } #region Accessors @@ -1237,7 +1237,7 @@ namespace SabreTools.DatFiles } catch (Exception ex) when (!throwOnError) { - logger.Warning(ex.ToString()); + _logger.Warning(ex.ToString()); } } diff --git a/SabreTools.DatFiles/Parser.cs b/SabreTools.DatFiles/Parser.cs index bd49eec3..aadae024 100644 --- a/SabreTools.DatFiles/Parser.cs +++ b/SabreTools.DatFiles/Parser.cs @@ -19,7 +19,7 @@ namespace SabreTools.DatFiles /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -117,7 +117,7 @@ namespace SabreTools.DatFiles } catch (Exception ex) when (!throwOnError) { - logger.Error(ex, $"Error with file '{currentPath}'"); + _staticLogger.Error(ex, $"Error with file '{currentPath}'"); } watch.Stop(); diff --git a/SabreTools.DatFiles/SerializableDatFile.cs b/SabreTools.DatFiles/SerializableDatFile.cs index f477e972..576e5525 100644 --- a/SabreTools.DatFiles/SerializableDatFile.cs +++ b/SabreTools.DatFiles/SerializableDatFile.cs @@ -34,7 +34,7 @@ namespace SabreTools.DatFiles catch (Exception ex) when (!throwOnError) { string message = $"'{filename}' - An error occurred during parsing"; - logger.Error(ex, message); + _logger.Error(ex, message); } } @@ -43,24 +43,24 @@ namespace SabreTools.DatFiles { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file in two steps var internalFormat = ConvertMetadata(ignoreblanks); var specificFormat = Activator.CreateInstance().Deserialize(internalFormat); if (!Activator.CreateInstance().Serialize(specificFormat, outfile)) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } @@ -69,24 +69,24 @@ namespace SabreTools.DatFiles { try { - logger.User($"Writing to '{outfile}'..."); + _logger.User($"Writing to '{outfile}'..."); // Serialize the input file in two steps var internalFormat = ConvertMetadataDB(ignoreblanks); var specificFormat = Activator.CreateInstance().Deserialize(internalFormat); if (!Activator.CreateInstance().Serialize(specificFormat, outfile)) { - logger.Warning($"File '{outfile}' could not be written! See the log for more details."); + _logger.Warning($"File '{outfile}' could not be written! See the log for more details."); return false; } } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } - logger.User($"'{outfile}' written!{Environment.NewLine}"); + _logger.User($"'{outfile}' written!{Environment.NewLine}"); return true; } } diff --git a/SabreTools.DatItems/DatItem.cs b/SabreTools.DatItems/DatItem.cs index ab7c5176..33b60384 100644 --- a/SabreTools.DatItems/DatItem.cs +++ b/SabreTools.DatItems/DatItem.cs @@ -95,7 +95,7 @@ namespace SabreTools.DatItems /// Static logger for static methods /// [JsonIgnore, XmlIgnore] - protected static readonly Logger staticLogger = new(); + protected static readonly Logger _staticLogger = new(); #endregion diff --git a/SabreTools.DatTools/Cleaner.cs b/SabreTools.DatTools/Cleaner.cs index 9a0487c5..b81e87f6 100644 --- a/SabreTools.DatTools/Cleaner.cs +++ b/SabreTools.DatTools/Cleaner.cs @@ -82,7 +82,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private readonly Logger logger = new(); + private readonly Logger _logger = new(); #endregion @@ -157,7 +157,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally diff --git a/SabreTools.DatTools/DatFromDir.cs b/SabreTools.DatTools/DatFromDir.cs index 7b4b6545..7d9aa7c0 100644 --- a/SabreTools.DatTools/DatFromDir.cs +++ b/SabreTools.DatTools/DatFromDir.cs @@ -46,7 +46,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -78,7 +78,7 @@ namespace SabreTools.DatTools // Process the input if (Directory.Exists(basePath)) { - logger.Verbose($"Folder found: {basePath}"); + _staticLogger.Verbose($"Folder found: {basePath}"); // Get a list of all files to process #if NET20 || NET35 @@ -104,13 +104,13 @@ namespace SabreTools.DatTools #endif // Process the files in the main folder or any subfolder - logger.User(totalSize, currentSize); + _staticLogger.User(totalSize, currentSize); foreach (string item in files) { currentSize += new FileInfo(item).Length; CheckFileForHashes(datFile, item, basePath, asFile); - logger.User(totalSize, currentSize, item); + _staticLogger.User(totalSize, currentSize, item); } // Now find all folders that are empty, if we are supposed to @@ -119,14 +119,14 @@ namespace SabreTools.DatTools } else if (System.IO.File.Exists(basePath)) { - logger.Verbose($"File found: {basePath}"); + _staticLogger.Verbose($"File found: {basePath}"); totalSize = new FileInfo(basePath).Length; - logger.User(totalSize, currentSize); + _staticLogger.User(totalSize, currentSize); string? parentPath = Path.GetDirectoryName(Path.GetDirectoryName(basePath)); CheckFileForHashes(datFile, basePath, parentPath, asFile); - logger.User(totalSize, totalSize, basePath); + _staticLogger.User(totalSize, totalSize, basePath); } watch.Stop(); @@ -231,11 +231,11 @@ namespace SabreTools.DatTools // Add the list if it doesn't exist already Rom rom = baseFile.ConvertToRom(); datFile.Items.Add(rom.GetKey(ItemKey.CRC), rom); - logger.Verbose($"File added: {Path.GetFileNameWithoutExtension(item)}"); + _staticLogger.Verbose($"File added: {Path.GetFileNameWithoutExtension(item)}"); } else { - logger.Verbose($"File not added: {Path.GetFileNameWithoutExtension(item)}"); + _staticLogger.Verbose($"File not added: {Path.GetFileNameWithoutExtension(item)}"); return true; } @@ -378,7 +378,7 @@ namespace SabreTools.DatTools gamename = gamename.Trim(Path.DirectorySeparatorChar); romname = romname.Trim(Path.DirectorySeparatorChar); - logger.Verbose($"Adding blank empty folder: {gamename}"); + _staticLogger.Verbose($"Adding blank empty folder: {gamename}"); var blankMachine = new Machine(); blankMachine.SetFieldValue(Models.Metadata.Machine.NameKey, gamename); @@ -404,7 +404,7 @@ namespace SabreTools.DatTools /// TreatAsFile representing CHD and Archive scanning private void ProcessFile(DatFile datFile, string item, string? basePath, TreatAsFile asFile) { - logger.Verbose($"'{Path.GetFileName(item)}' treated like a file"); + _staticLogger.Verbose($"'{Path.GetFileName(item)}' treated like a file"); var header = datFile.Header.GetStringFieldValue(Models.Metadata.Header.HeaderKey); BaseFile? baseFile = FileTypeTool.GetInfo(item, _hashes, header); DatItem? datItem = DatItemTool.CreateDatItem(baseFile, asFile); @@ -443,11 +443,11 @@ namespace SabreTools.DatTools string key = datItem.GetKey(ItemKey.CRC); datFile.Items.Add(key, datItem); - logger.Verbose($"File added: {datItem.GetName() ?? string.Empty}"); + _staticLogger.Verbose($"File added: {datItem.GetName() ?? string.Empty}"); } catch (IOException ex) { - logger.Error(ex); + _staticLogger.Error(ex); return; } } diff --git a/SabreTools.DatTools/ExtraIni.cs b/SabreTools.DatTools/ExtraIni.cs index 08126356..0e8cbc67 100644 --- a/SabreTools.DatTools/ExtraIni.cs +++ b/SabreTools.DatTools/ExtraIni.cs @@ -23,7 +23,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private readonly Logger logger; + private readonly Logger _logger; #endregion @@ -34,7 +34,7 @@ namespace SabreTools.DatTools /// public ExtraIni() { - logger = new Logger(this); + _logger = new Logger(this); } #endregion @@ -58,7 +58,7 @@ namespace SabreTools.DatTools // If we don't even have a possible field and file combination if (!input.Contains(":")) { - logger.Warning($"'{input}` is not a valid INI extras string. Valid INI extras strings are of the form 'key:value'. Please refer to README.1ST or the help feature for more details."); + _logger.Warning($"'{input}` is not a valid INI extras string. Valid INI extras strings are of the form 'key:value'. Please refer to README.1ST or the help feature for more details."); return; } @@ -130,7 +130,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally @@ -192,7 +192,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally diff --git a/SabreTools.DatTools/MergeSplit.cs b/SabreTools.DatTools/MergeSplit.cs index 30268635..5b0f840a 100644 --- a/SabreTools.DatTools/MergeSplit.cs +++ b/SabreTools.DatTools/MergeSplit.cs @@ -22,7 +22,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -82,7 +82,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _staticLogger.Error(ex); return false; } finally @@ -99,7 +99,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateDeviceNonMergedSets(DatFile datFile) { - logger.User("Creating device non-merged sets from the DAT"); + _staticLogger.User("Creating device non-merged sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); @@ -122,7 +122,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateFullyMergedSets(DatFile datFile) { - logger.User("Creating fully merged sets from the DAT"); + _staticLogger.User("Creating fully merged sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); @@ -149,7 +149,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateFullyNonMergedSets(DatFile datFile) { - logger.User("Creating fully non-merged sets from the DAT"); + _staticLogger.User("Creating fully non-merged sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); @@ -178,7 +178,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateMergedSets(DatFile datFile) { - logger.User("Creating merged sets from the DAT"); + _staticLogger.User("Creating merged sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); @@ -205,7 +205,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateNonMergedSets(DatFile datFile) { - logger.User("Creating non-merged sets from the DAT"); + _staticLogger.User("Creating non-merged sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); @@ -232,7 +232,7 @@ namespace SabreTools.DatTools /// Current DatFile object to run operations on internal static void CreateSplitSets(DatFile datFile) { - logger.User("Creating split sets from the DAT"); + _staticLogger.User("Creating split sets from the DAT"); // For sake of ease, the first thing we want to do is bucket by game datFile.Items.BucketBy(ItemKey.Machine, DedupeType.None, norename: true); diff --git a/SabreTools.DatTools/Rebuilder.cs b/SabreTools.DatTools/Rebuilder.cs index dc5205b1..4b460e88 100644 --- a/SabreTools.DatTools/Rebuilder.cs +++ b/SabreTools.DatTools/Rebuilder.cs @@ -26,7 +26,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -55,7 +55,7 @@ namespace SabreTools.DatTools // If the DAT is not populated and inverse is not set, inform the user and quit if (datFile.Items.DatStatistics.TotalCount == 0 && !inverse) { - logger.User("No entries were found to rebuild, exiting..."); + _staticLogger.User("No entries were found to rebuild, exiting..."); return false; } @@ -89,7 +89,7 @@ namespace SabreTools.DatTools // Add to the list if the input is a directory if (Directory.Exists(input)) { - logger.Verbose($"Adding depot: {input}"); + _staticLogger.Verbose($"Adding depot: {input}"); lock (directories) { directories.Add(input); @@ -116,7 +116,7 @@ namespace SabreTools.DatTools if (hash.Length != Constants.SHA1Length) continue; - logger.User($"Checking hash '{hash}'"); + _staticLogger.User($"Checking hash '{hash}'"); // Get the extension path for the hash string? subpath = Utilities.GetDepotPath(hash, datFile.Header.GetFieldValue(DatHeader.InputDepotKey)?.Depth ?? 0); @@ -206,7 +206,7 @@ namespace SabreTools.DatTools // If the DAT is not populated and inverse is not set, inform the user and quit if (datFile.Items.DatStatistics.TotalCount == 0 && !inverse) { - logger.User("No entries were found to rebuild, exiting..."); + _staticLogger.User("No entries were found to rebuild, exiting..."); return false; } @@ -238,7 +238,7 @@ namespace SabreTools.DatTools // If the input is a file if (System.IO.File.Exists(input)) { - logger.User($"Checking file: {input}"); + _staticLogger.User($"Checking file: {input}"); bool rebuilt = RebuildGenericHelper(datFile, input, outDir, quickScan, date, inverse, outputFormat, asFile); // If we are supposed to delete the file, do so @@ -249,14 +249,14 @@ namespace SabreTools.DatTools // If the input is a directory else if (Directory.Exists(input)) { - logger.Verbose($"Checking directory: {input}"); + _staticLogger.Verbose($"Checking directory: {input}"); #if NET20 || NET35 foreach (string file in Directory.GetFiles(input, "*")) #else foreach (string file in Directory.EnumerateFiles(input, "*", SearchOption.AllDirectories)) #endif { - logger.User($"Checking file: {file}"); + _staticLogger.User($"Checking file: {file}"); bool rebuilt = RebuildGenericHelper(datFile, file, outDir, quickScan, date, inverse, outputFormat, asFile); // If we are supposed to delete the file, do so @@ -443,7 +443,7 @@ namespace SabreTools.DatTools fileStream.Seek(0, SeekOrigin.Begin); } - logger.User($"{(inverse ? "No matches" : $"{dupes.Count} Matches")} found for '{Path.GetFileName(datItem.GetName() ?? datItem.GetStringFieldValue(Models.Metadata.DatItem.TypeKey).AsEnumValue().AsStringValue())}', rebuilding accordingly..."); + _staticLogger.User($"{(inverse ? "No matches" : $"{dupes.Count} Matches")} found for '{Path.GetFileName(datItem.GetName() ?? datItem.GetStringFieldValue(Models.Metadata.DatItem.TypeKey).AsEnumValue().AsStringValue())}', rebuilding accordingly..."); rebuilt = true; // Special case for partial packing mode @@ -506,7 +506,7 @@ namespace SabreTools.DatTools if (ShouldRebuild(datFile, headerless, transformStream, false, out dupes)) //if (ShouldRebuildDB(datFile, headerless, transformStream, false, out dupes)) { - logger.User($"Headerless matches found for '{Path.GetFileName(datItem.GetName() ?? datItem.GetStringFieldValue(Models.Metadata.DatItem.TypeKey).AsEnumValue().AsStringValue())}', rebuilding accordingly..."); + _staticLogger.User($"Headerless matches found for '{Path.GetFileName(datItem.GetName() ?? datItem.GetStringFieldValue(Models.Metadata.DatItem.TypeKey).AsEnumValue().AsStringValue())}', rebuilding accordingly..."); rebuilt = true; // Now loop through the list and rebuild accordingly @@ -677,7 +677,7 @@ namespace SabreTools.DatTools BaseFile? tgzRom = tgz.GetTorrentGZFileInfo(); if (isZip == false && tgzRom != null && (outputFormat == OutputFormat.TorrentGzip || outputFormat == OutputFormat.TorrentGzipRomba)) { - logger.User($"Matches found for '{Path.GetFileName(datItem.GetName() ?? string.Empty)}', rebuilding accordingly..."); + _staticLogger.User($"Matches found for '{Path.GetFileName(datItem.GetName() ?? string.Empty)}', rebuilding accordingly..."); // Get the proper output path string sha1 = (datItem as Rom)!.GetStringFieldValue(Models.Metadata.Rom.SHA1Key) ?? string.Empty; @@ -723,7 +723,7 @@ namespace SabreTools.DatTools BaseFile? txzRom = txz.GetTorrentXZFileInfo(); if (isZip == false && txzRom != null && (outputFormat == OutputFormat.TorrentXZ || outputFormat == OutputFormat.TorrentXZRomba)) { - logger.User($"Matches found for '{Path.GetFileName(datItem.GetName() ?? string.Empty)}', rebuilding accordingly..."); + _staticLogger.User($"Matches found for '{Path.GetFileName(datItem.GetName() ?? string.Empty)}', rebuilding accordingly..."); // Get the proper output path string sha1 = (datItem as Rom)!.GetStringFieldValue(Models.Metadata.Rom.SHA1Key) ?? string.Empty; diff --git a/SabreTools.DatTools/Remover.cs b/SabreTools.DatTools/Remover.cs index 1c35cc91..1bef7728 100644 --- a/SabreTools.DatTools/Remover.cs +++ b/SabreTools.DatTools/Remover.cs @@ -34,7 +34,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - protected Logger logger; + protected Logger _logger; #endregion @@ -45,7 +45,7 @@ namespace SabreTools.DatTools /// public Remover() { - logger = new Logger(this); + _logger = new Logger(this); } #endregion @@ -75,7 +75,7 @@ namespace SabreTools.DatTools { bool removerSet = SetRemover(field); if (!removerSet) - logger.Warning($"The value {field} did not match any known field names. Please check the wiki for more details on supported field names."); + _logger.Warning($"The value {field} did not match any known field names. Please check the wiki for more details on supported field names."); } watch.Stop(); diff --git a/SabreTools.DatTools/Setter.cs b/SabreTools.DatTools/Setter.cs index 11c8b780..26986ac1 100644 --- a/SabreTools.DatTools/Setter.cs +++ b/SabreTools.DatTools/Setter.cs @@ -38,7 +38,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private readonly Logger logger = new(); + private readonly Logger _logger = new(); #endregion @@ -72,7 +72,7 @@ namespace SabreTools.DatTools string value = values[i]; if (!SetSetter(field, value)) - logger.Warning($"The value {value} did not match any known field names. Please check the wiki for more details on supported field names."); + _logger.Warning($"The value {value} did not match any known field names. Please check the wiki for more details on supported field names."); } watch.Stop(); @@ -97,7 +97,7 @@ namespace SabreTools.DatTools string value = mapping.Value; if (!SetSetter(field, value)) - logger.Warning($"The value {value} did not match any known field names. Please check the wiki for more details on supported field names."); + _logger.Warning($"The value {value} did not match any known field names. Please check the wiki for more details on supported field names."); } watch.Stop(); diff --git a/SabreTools.DatTools/Splitter.cs b/SabreTools.DatTools/Splitter.cs index 134dabd7..3b687b92 100644 --- a/SabreTools.DatTools/Splitter.cs +++ b/SabreTools.DatTools/Splitter.cs @@ -27,7 +27,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -784,7 +784,7 @@ namespace SabreTools.DatTools var items = datFile.Items[machine]; if (items == null || items.Count == 0) { - logger.Error($"{machine} contains no items and will be skipped"); + _staticLogger.Error($"{machine} contains no items and will be skipped"); continue; } @@ -797,7 +797,7 @@ namespace SabreTools.DatTools // TODO: Should there be more than just a log if a single item is larger than the chunksize? machineSize += rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) ?? 0; if ((rom.GetInt64FieldValue(Models.Metadata.Rom.SizeKey) ?? 0) > chunkSize) - logger.Error($"{rom.GetName() ?? string.Empty} in {machine} is larger than {chunkSize}"); + _staticLogger.Error($"{rom.GetName() ?? string.Empty} in {machine} is larger than {chunkSize}"); } } @@ -805,7 +805,7 @@ namespace SabreTools.DatTools // TODO: Should this eventually try to split the machine here? if (machineSize > chunkSize) { - logger.Error($"{machine} is larger than {chunkSize} and will be skipped"); + _staticLogger.Error($"{machine} is larger than {chunkSize} and will be skipped"); continue; } diff --git a/SabreTools.DatTools/Statistics.cs b/SabreTools.DatTools/Statistics.cs index 8598c745..544fff2d 100644 --- a/SabreTools.DatTools/Statistics.cs +++ b/SabreTools.DatTools/Statistics.cs @@ -25,7 +25,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -145,7 +145,7 @@ namespace SabreTools.DatTools // If there's no output format, set the default if (statDatFormat == StatReportFormat.None) { - logger.Verbose("No report format defined, defaulting to textfile"); + _staticLogger.Verbose("No report format defined, defaulting to textfile"); statDatFormat = StatReportFormat.Textfile; } @@ -179,7 +179,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex, $"Report '{outfile}' could not be written out"); + _staticLogger.Error(ex, $"Report '{outfile}' could not be written out"); } #if NET40_OR_GREATER || NETCOREAPP }); @@ -189,7 +189,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _staticLogger.Error(ex); return false; } finally diff --git a/SabreTools.DatTools/Verification.cs b/SabreTools.DatTools/Verification.cs index ef9cf40a..befa767d 100644 --- a/SabreTools.DatTools/Verification.cs +++ b/SabreTools.DatTools/Verification.cs @@ -22,7 +22,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -45,7 +45,7 @@ namespace SabreTools.DatTools // Add to the list if the input is a directory if (Directory.Exists(input)) { - logger.Verbose($"Adding depot: {input}"); + _staticLogger.Verbose($"Adding depot: {input}"); directories.Add(input); } } @@ -65,7 +65,7 @@ namespace SabreTools.DatTools if (hash.Length != Constants.SHA1Length) continue; - logger.User($"Checking hash '{hash}'"); + _staticLogger.User($"Checking hash '{hash}'"); // Get the extension path for the hash string? subpath = Utilities.GetDepotPath(hash, datFile.Header.GetFieldValue(DatHeader.InputDepotKey)?.Depth ?? 0); @@ -130,7 +130,7 @@ namespace SabreTools.DatTools // Add to the list if the input is a directory if (Directory.Exists(input)) { - logger.Verbose($"Adding depot: {input}"); + _staticLogger.Verbose($"Adding depot: {input}"); directories.Add(input); } } @@ -150,7 +150,7 @@ namespace SabreTools.DatTools if (hash.Length != Constants.SHA1Length) continue; - logger.User($"Checking hash '{hash}'"); + _staticLogger.User($"Checking hash '{hash}'"); // Get the extension path for the hash string? subpath = Utilities.GetDepotPath(hash, datFile.Header.GetFieldValue(DatHeader.InputDepotKey)?.Depth ?? 0); diff --git a/SabreTools.DatTools/Writer.cs b/SabreTools.DatTools/Writer.cs index fd6144eb..ee8c072f 100644 --- a/SabreTools.DatTools/Writer.cs +++ b/SabreTools.DatTools/Writer.cs @@ -21,7 +21,7 @@ namespace SabreTools.DatTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -46,7 +46,7 @@ namespace SabreTools.DatTools // If we have nothing writable, abort if (!HasWritable(datFile)) { - logger.User("There were no items to write out!"); + _staticLogger.User("There were no items to write out!"); return false; } @@ -58,7 +58,7 @@ namespace SabreTools.DatTools // If the DAT has no output format, default to XML if (datFile.Header.GetFieldValue(DatHeader.DatFormatKey) == 0) { - logger.Verbose("No DAT format defined, defaulting to XML"); + _staticLogger.Verbose("No DAT format defined, defaulting to XML"); datFile.Header.SetFieldValue(DatHeader.DatFormatKey, DatFormat.Logiqx); } @@ -70,7 +70,7 @@ namespace SabreTools.DatTools datFile.ItemsDB.BucketBy(ItemKey.Machine, DedupeType.None); // Output the number of items we're going to be writing - logger.User($"A total of {datFile.Items.DatStatistics.TotalCount - datFile.Items.DatStatistics.RemovedCount} items will be written out to '{datFile.Header.GetStringFieldValue(DatHeader.FileNameKey)}'"); + _staticLogger.User($"A total of {datFile.Items.DatStatistics.TotalCount - datFile.Items.DatStatistics.RemovedCount} items will be written out to '{datFile.Header.GetStringFieldValue(DatHeader.FileNameKey)}'"); //logger.User($"A total of {datFile.ItemsDB.DatStatistics.TotalCount - datFile.ItemsDB.DatStatistics.RemovedCount} items will be written out to '{datFile.Header.GetStringFieldValue(DatHeader.FileNameKey)}'"); // Get the outfile names @@ -94,7 +94,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex, $"Datfile '{outfile}' could not be written out"); + _staticLogger.Error(ex, $"Datfile '{outfile}' could not be written out"); } #if NET40_OR_GREATER || NETCOREAPP }); @@ -104,7 +104,7 @@ namespace SabreTools.DatTools } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _staticLogger.Error(ex); return false; } finally diff --git a/SabreTools.FileTypes/FileTypeTool.cs b/SabreTools.FileTypes/FileTypeTool.cs index e58666ff..6778fa4d 100644 --- a/SabreTools.FileTypes/FileTypeTool.cs +++ b/SabreTools.FileTypes/FileTypeTool.cs @@ -19,7 +19,7 @@ namespace SabreTools.FileTypes /// /// Logging object /// - private static readonly Logger _logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -67,7 +67,7 @@ namespace SabreTools.FileTypes } catch (Exception ex) { - _logger.Error(ex); + _staticLogger.Error(ex); return new BaseFile(); } } @@ -110,7 +110,7 @@ namespace SabreTools.FileTypes } catch (Exception ex) { - _logger.Error(ex); + _staticLogger.Error(ex); return new BaseFile(); } } @@ -258,7 +258,7 @@ namespace SabreTools.FileTypes } catch (Exception ex) { - _logger.Error(ex); + _staticLogger.Error(ex); return null; } diff --git a/SabreTools.Help/TopLevel.cs b/SabreTools.Help/TopLevel.cs index 7d1b7670..9dce0a13 100644 --- a/SabreTools.Help/TopLevel.cs +++ b/SabreTools.Help/TopLevel.cs @@ -24,7 +24,7 @@ namespace SabreTools.Help /// /// Logging object /// - private readonly Logger logger; + private readonly Logger _logger; #endregion @@ -35,7 +35,7 @@ namespace SabreTools.Help /// public TopLevel() { - logger = new Logger(this); + _logger = new Logger(this); } #endregion @@ -72,7 +72,7 @@ namespace SabreTools.Help // Everything else isn't a file else { - logger.Error($"Invalid input detected: {args[i]}"); + _logger.Error($"Invalid input detected: {args[i]}"); help.OutputIndividualFeature(Name); LoggerImpl.Close(); return false; diff --git a/SabreTools.Reports/BaseReport.cs b/SabreTools.Reports/BaseReport.cs index 30b3590f..5ed3489b 100644 --- a/SabreTools.Reports/BaseReport.cs +++ b/SabreTools.Reports/BaseReport.cs @@ -15,7 +15,7 @@ namespace SabreTools.Reports /// /// Logging object /// - protected readonly Logger logger = new(); + protected readonly Logger _logger = new(); #endregion diff --git a/SabreTools.Reports/Formats/Html.cs b/SabreTools.Reports/Formats/Html.cs index 35703138..de8bb03a 100644 --- a/SabreTools.Reports/Formats/Html.cs +++ b/SabreTools.Reports/Formats/Html.cs @@ -39,7 +39,7 @@ namespace SabreTools.Reports.Formats FileStream fs = File.Create(outfile ?? string.Empty); if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -88,7 +88,7 @@ namespace SabreTools.Reports.Formats } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally diff --git a/SabreTools.Reports/Formats/SeparatedValue.cs b/SabreTools.Reports/Formats/SeparatedValue.cs index 06b797c8..c8777bfb 100644 --- a/SabreTools.Reports/Formats/SeparatedValue.cs +++ b/SabreTools.Reports/Formats/SeparatedValue.cs @@ -38,7 +38,7 @@ namespace SabreTools.Reports.Formats FileStream fs = File.Create(outfile ?? string.Empty); if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -79,7 +79,7 @@ namespace SabreTools.Reports.Formats } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally diff --git a/SabreTools.Reports/Formats/Textfile.cs b/SabreTools.Reports/Formats/Textfile.cs index a1d348e5..c2854713 100644 --- a/SabreTools.Reports/Formats/Textfile.cs +++ b/SabreTools.Reports/Formats/Textfile.cs @@ -35,7 +35,7 @@ namespace SabreTools.Reports.Formats Stream fs = _writeToConsole ? Console.OpenStandardOutput() : File.Create(outfile ?? string.Empty); if (fs == null) { - logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); + _logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } @@ -69,7 +69,7 @@ namespace SabreTools.Reports.Formats } catch (Exception ex) when (!throwOnError) { - logger.Error(ex); + _logger.Error(ex); return false; } finally diff --git a/SabreTools/Features/BaseFeature.cs b/SabreTools/Features/BaseFeature.cs index bcbfd420..ff46945f 100644 --- a/SabreTools/Features/BaseFeature.cs +++ b/SabreTools/Features/BaseFeature.cs @@ -19,7 +19,7 @@ namespace SabreTools.Features /// /// Logging object /// - protected Logger logger = new(); + protected Logger _logger = new(); #endregion @@ -2176,7 +2176,7 @@ Some special strings that can be used: DatFormat dftemp = GetDatFormat(ot); if (dftemp == 0x00) { - logger.Error($"{ot} is not a recognized DAT format"); + _logger.Error($"{ot} is not a recognized DAT format"); return null; } diff --git a/SabreTools/Features/Batch.cs b/SabreTools/Features/Batch.cs index 14676949..185d1ad2 100644 --- a/SabreTools/Features/Batch.cs +++ b/SabreTools/Features/Batch.cs @@ -74,7 +74,7 @@ Reset the internal state: reset();"; // If the file doesn't exist, warn but continue if (!File.Exists(path)) { - logger.User($"{path} does not exist. Skipping..."); + _logger.User($"{path} does not exist. Skipping..."); return; } @@ -102,8 +102,8 @@ Reset the internal state: reset();"; var command = BatchCommand.Create(line); if (command == null) { - logger.User($"Could not process {path} due to the following line: {line}"); - logger.User($"Please see the help text for more details about possible commands"); + _logger.User($"Could not process {path} due to the following line: {line}"); + _logger.User($"Please see the help text for more details about possible commands"); break; } @@ -111,19 +111,19 @@ Reset the internal state: reset();"; (bool valid, string? error) = command.ValidateArguments(); if (!valid) { - logger.User(error ?? string.Empty); - logger.User($"Usage: {command.Usage()}"); + _logger.User(error ?? string.Empty); + _logger.User($"Usage: {command.Usage()}"); break; } // Now run the command - logger.User($"Attempting to invoke {command.Name} with {(command.Arguments.Length == 0 ? "no arguments" : "the following argument(s): " + string.Join(", ", command.Arguments))}"); + _logger.User($"Attempting to invoke {command.Name} with {(command.Arguments.Length == 0 ? "no arguments" : "the following argument(s): " + string.Join(", ", command.Arguments))}"); command.Process(batchState); } } catch (Exception ex) { - logger.Error(ex, $"There was an exception processing {path}"); + _logger.Error(ex, $"There was an exception processing {path}"); } } diff --git a/SabreTools/Features/Split.cs b/SabreTools/Features/Split.cs index 74e4c775..de7822dd 100644 --- a/SabreTools/Features/Split.cs +++ b/SabreTools/Features/Split.cs @@ -53,7 +53,7 @@ namespace SabreTools.Features SplittingMode splittingMode = GetSplittingMode(features); if (splittingMode == SplittingMode.None) { - logger.Error("No valid splitting mode found!"); + _logger.Error("No valid splitting mode found!"); return false; } @@ -130,7 +130,7 @@ namespace SabreTools.Features if (splittingMode.HasFlag(SplittingMode.Level)) #endif { - logger.Warning("This feature is not implemented: level-split"); + _logger.Warning("This feature is not implemented: level-split"); DatTools.Splitter.SplitByLevel( internalDat, OutputDir!, @@ -164,7 +164,7 @@ namespace SabreTools.Features if (splittingMode.HasFlag(SplittingMode.TotalSize)) #endif { - logger.Warning("This feature is not implemented: level-split"); + _logger.Warning("This feature is not implemented: level-split"); List sizedDats = DatTools.Splitter.SplitByTotalSize(internalDat, GetInt64(features, ChunkSizeInt64Value)); var watch = new InternalStopwatch("Outputting total-size-split DATs"); diff --git a/SabreTools/Features/Update.cs b/SabreTools/Features/Update.cs index 5ca4fcce..293df009 100644 --- a/SabreTools/Features/Update.cs +++ b/SabreTools/Features/Update.cs @@ -169,7 +169,7 @@ namespace SabreTools.Features { // Create a new base DatFile DatFile datFile = DatFile.Create(Header); - logger.User($"Processing '{Path.GetFileName(inputPath.CurrentPath)}'"); + _logger.User($"Processing '{Path.GetFileName(inputPath.CurrentPath)}'"); // Check the current format DatFormat currentFormat = datFile.Header.GetFieldValue(DatHeader.DatFormatKey); diff --git a/SabreTools/Features/Verify.cs b/SabreTools/Features/Verify.cs index a8b7a3ea..e37da9f9 100644 --- a/SabreTools/Features/Verify.cs +++ b/SabreTools/Features/Verify.cs @@ -90,7 +90,7 @@ namespace SabreTools.Features else { // Loop through and add the inputs to check against - logger.User("Processing files:\n"); + _logger.User("Processing files:\n"); foreach (string input in Inputs) { dfd.PopulateFromDir(datdata, input, asFile); @@ -144,7 +144,7 @@ namespace SabreTools.Features else { // Loop through and add the inputs to check against - logger.User("Processing files:\n"); + _logger.User("Processing files:\n"); foreach (string input in Inputs) { dfd.PopulateFromDir(datdata, input, asFile); diff --git a/SabreTools/Features/Version.cs b/SabreTools/Features/Version.cs index 82f89a43..6b7c7a29 100644 --- a/SabreTools/Features/Version.cs +++ b/SabreTools/Features/Version.cs @@ -26,7 +26,7 @@ namespace SabreTools.Features if (!base.ProcessFeatures(features)) return false; - logger.User($"SabreTools version: {Globals.Version}"); + _logger.User($"SabreTools version: {Globals.Version}"); return true; } } diff --git a/SabreTools/Program.cs b/SabreTools/Program.cs index a42f19f4..05d86a74 100644 --- a/SabreTools/Program.cs +++ b/SabreTools/Program.cs @@ -22,7 +22,7 @@ namespace SabreTools /// /// Logging object /// - private static readonly Logger logger = new(); + private static readonly Logger _staticLogger = new(); #endregion @@ -74,12 +74,12 @@ namespace SabreTools // TODO: Re-evaluate feature flags with this change in mind featureName = featureName.TrimStart('-'); if (args[0].StartsWith("-")) - logger.User($"Feature flags no longer require leading '-' characters"); + _staticLogger.User($"Feature flags no longer require leading '-' characters"); // Verify that the flag is valid if (!_help.TopLevelFlag(featureName)) { - logger.User($"'{featureName}' is not valid feature flag"); + _staticLogger.User($"'{featureName}' is not valid feature flag"); _help.OutputIndividualFeature(featureName); LoggerImpl.Close(); return; @@ -154,7 +154,7 @@ namespace SabreTools // If the feature failed, output help if (!success) { - logger.Error("An error occurred during processing!"); + _staticLogger.Error("An error occurred during processing!"); _help.OutputIndividualFeature(featureName); } @@ -226,7 +226,7 @@ namespace SabreTools { if (inputs.Count == 0) { - logger.Error("This feature requires at least one input"); + _staticLogger.Error("This feature requires at least one input"); _help?.OutputIndividualFeature(feature.Name); Environment.Exit(0); }