Small refactor

RePKG.Application/Exceptions/EnumNotValidException.cs

@@ -2,6 +2,10 @@
 
 namespace RePKG.Application.Exceptions
 {
+    /// <summary>
+    /// Thrown when enum raw value doesn't match any label
+    /// </summary>
+    /// <typeparam name="T">The enum</typeparam>
     public class EnumNotValidException<T> : Exception where T : Enum
     {
         public EnumNotValidException(T @enum) : base($"Invalid value '{@enum}' for enum '{typeof(T)}'")

RePKG.Application/Exceptions/UnknownMagicException.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace RePKG.Application.Exceptions
+{
+    /// <summary>
+    /// Thrown on magic values that have not been tested before
+    /// </summary>
+    public class UnknownMagicException : Exception
+    {
+        public UnknownMagicException(string source, string magic) : base(
+            $"Unknown magic: '{magic}' in '{source}'")
+        {
+        }
+
+        public UnknownMagicException(string source, string property, string magic) : base(
+            $"Unknown magic: '{magic}' in '{source}:{property}'")
+        {
+        }
+    }
+}

RePKG.Application/Exceptions/UnsafeTexException.cs

@@ -2,8 +2,10 @@
 
 namespace RePKG.Application.Exceptions
 {
-    // Thrown on unorganic values
-    // For example when entry count is way higher than usual
+    /// <summary>
+    /// Thrown on unorganic values.
+    /// For example when entry count is way higher than usual
+    /// </summary>
     public class UnsafeTexException : Exception
     {
         public UnsafeTexException(string reason) : base($"Unsafe TEX detected, reason: {reason}")

RePKG.Application/Extensions.cs

@@ -10,7 +10,8 @@ internal static class Extensions
         public static string ReadNString(this BinaryReader reader, int maxLength = -1)
         {
             if (reader == null) throw new ArgumentNullException(nameof(reader));
-            var builder = new StringBuilder(16);
+
+            var builder = new StringBuilder(maxLength <= 0 ? 16 : maxLength);
             var c = reader.ReadChar();
 
             while (c != '\0' && (maxLength == -1 || builder.Length < maxLength))

RePKG.Application/Package/PackageReader.cs

@@ -34,7 +34,7 @@ public Core.Package.Package ReadFromStream(Stream stream)
             }
         }
 
-        private void ReadEntries(List<PackageEntry> list, BinaryReader reader)
+        private static void ReadEntries(List<PackageEntry> list, BinaryReader reader)
         {
             var entryCount = reader.ReadInt32();
 
@@ -52,7 +52,7 @@ private void ReadEntries(List<PackageEntry> list, BinaryReader reader)
             }
         }
 
-        private void PopulateEntriesWithData(int dataStart, List<PackageEntry> entries, BinaryReader reader)
+        private static void PopulateEntriesWithData(int dataStart, List<PackageEntry> entries, BinaryReader reader)
         {
             foreach (var entry in entries)
             {

RePKG.Core/Texture/DXT.cs → RePKG.Application/Texture/Helpers/DXT.cs

@@ -20,23 +20,13 @@
 
 // most of the algorithms and data used in this Class-file has been ported from LibSquish!
 // http://code.google.com/p/libsquish/
-// ReSharper disable InconsistentNaming
 
-using System;
+using RePKG.Core.Texture;
 
-namespace RePKG.Core.Texture
+namespace RePKG.Application.Texture.Helpers
 {
     public static class DXT
     {
-        [Flags]
-        public enum DXTFlags
-        {
-            DXT1 = 1,
-            DXT3 = 1 << 1,
-            DXT5 = 1 << 2,
-            // Additional Enums not implemented :o
-        }
-
         private static void Decompress(byte[] rgba, byte[] block, int blockIndex, DXTFlags flags)
         {
             // get the block locations

RePKG.Application/Texture/TexFrameInfoContainerReader.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using RePKG.Application.Exceptions;
 using RePKG.Core.Texture;
@@ -8,6 +9,8 @@ public class TexFrameInfoContainerReader : ITexFrameInfoContainerReader
     {
         public TexFrameInfoContainer ReadFrom(BinaryReader reader)
         {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+
             var container = new TexFrameInfoContainer
             {
                 Magic = reader.ReadNString(maxLength: 16)
@@ -29,7 +32,7 @@ public TexFrameInfoContainer ReadFrom(BinaryReader reader)
                     break;
 
                 default:
-                    throw new UnknownTexFrameInfoContainerMagicException(container.Magic);
+                    throw new UnknownMagicException(nameof(TexFrameInfoContainerReader), container.Magic);
             }
 
             for (var i = 0; i < frameCount; i++)

RePKG.Application/Texture/TexHeaderReader.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using RePKG.Core.Texture;
 
@@ -7,6 +8,8 @@ public class TexHeaderReader : ITexHeaderReader
     {
         public TexHeader ReadFrom(BinaryReader reader)
         {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+
             var header = new TexHeader
             {
                 Format = (TexFormat) reader.ReadInt32(),

RePKG.Application/Texture/TexImageContainerReader.cs

@@ -16,6 +16,9 @@ public TexImageContainerReader(ITexImageReader texImageReader)
 
         public TexImageContainer ReadFrom(BinaryReader reader, TexFormat texFormat)
         {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+            texFormat.AssertValid();
+
             var container = new TexImageContainer
             {
                 Magic = reader.ReadNString(maxLength: 16)
@@ -38,7 +41,7 @@ public TexImageContainer ReadFrom(BinaryReader reader, TexFormat texFormat)
                     break;
 
                 default:
-                    throw new UnknownTexImageContainerMagicException(container.Magic);
+                    throw new UnknownMagicException(nameof(TexImageContainerReader), container.Magic);
             }
 
             container.ImageContainerVersion = (TexImageContainerVersion) Convert.ToInt32(container.Magic.Substring(4));

RePKG.Application/Texture/TexImageReader.cs

@@ -21,6 +21,10 @@ public TexImage ReadFrom(
             TexImageContainer container,
             TexFormat texFormat)
         {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+            if (container == null) throw new ArgumentNullException(nameof(container));
+            texFormat.AssertValid();
+
             var mipmapCount = reader.ReadInt32();
 
             if (mipmapCount > Constants.MaximumMipmapCount)

RePKG.Application/Texture/TexJsonInfoGenerator.cs

@@ -1,3 +1,4 @@
+using System;
 using Newtonsoft.Json;
 using RePKG.Core.Texture;
 
@@ -7,6 +8,8 @@ public class TexJsonInfoGenerator : ITexJsonInfoGenerator
     {
         public string GenerateInfo(Tex tex)
         {
+            if (tex == null) throw new ArgumentNullException(nameof(tex));
+
             return JsonConvert.SerializeObject(new
             {
                 bleedtransparentcolors = true,

RePKG.Application/Texture/TexMipmapDecompressor.cs

@@ -1,4 +1,6 @@
+using System;
 using K4os.Compression.LZ4;
+using RePKG.Application.Texture.Helpers;
 using RePKG.Core.Texture;
 
 namespace RePKG.Application.Texture
@@ -7,6 +9,8 @@ public class TexMipmapDecompressor : ITexMipmapDecompressor
     {
         public void DecompressMipmap(TexMipmap mipmap)
         {
+            if (mipmap == null) throw new ArgumentNullException(nameof(mipmap));
+
             if (mipmap.IsLZ4Compressed)
             {
                 mipmap.Bytes = Lz4Decompress(mipmap.Bytes, mipmap.DecompressedBytesCount);
@@ -19,15 +23,15 @@ public void DecompressMipmap(TexMipmap mipmap)
             switch (mipmap.Format)
             {
                 case MipmapFormat.CompressedDXT5:
-                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXT.DXTFlags.DXT5);
+                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXTFlags.DXT5);
                     mipmap.Format = MipmapFormat.RGBA8888;
                     break;
                 case MipmapFormat.CompressedDXT3:
-                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXT.DXTFlags.DXT3);
+                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXTFlags.DXT3);
                     mipmap.Format = MipmapFormat.RGBA8888;
                     break;
                 case MipmapFormat.CompressedDXT1:
-                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXT.DXTFlags.DXT1);
+                    mipmap.Bytes = DXT.DecompressImage(mipmap.Width, mipmap.Height, mipmap.Bytes, DXTFlags.DXT1);
                     mipmap.Format = MipmapFormat.RGBA8888;
                     break;
             }

RePKG.Application/Texture/TexReader.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using RePKG.Application.Exceptions;
 using RePKG.Core.Texture;
@@ -22,15 +23,17 @@ public TexReader(
 
         public Tex ReadFrom(BinaryReader reader)
         {
+            if (reader == null) throw new ArgumentNullException(nameof(reader));
+
             var tex = new Tex {Magic1 = reader.ReadNString(maxLength: 16)};
 
             if (tex.Magic1 != "TEXV0005")
-                throw new UnknownTexHeaderMagicException(nameof(tex.Magic1), tex.Magic1);
+                throw new UnknownMagicException(nameof(TexReader), nameof(tex.Magic1), tex.Magic1);
 
             tex.Magic2 = reader.ReadNString(maxLength: 16);
 
             if (tex.Magic2 != "TEXI0001")
-                throw new UnknownTexHeaderMagicException(nameof(tex.Magic2), tex.Magic2);
+                throw new UnknownMagicException(nameof(TexReader), nameof(tex.Magic2), tex.Magic2);
 
             tex.Header = _texHeaderReader.ReadFrom(reader);
             tex.ImagesContainer = _texImageContainerReader.ReadFrom(reader, tex.Header.Format);

RePKG.Application/Texture/TexToImageConverter.cs

@@ -14,6 +14,8 @@ public class TexToImageConverter
     {
         public ImageResult ConvertToImage(Tex tex)
         {
+            if (tex == null) throw new ArgumentNullException(nameof(tex));
+
             if (tex.IsGif)
                 return ConvertToGif(tex);
 
@@ -52,6 +54,8 @@ public ImageResult ConvertToImage(Tex tex)
 
         public MipmapFormat GetConvertedFormat(Tex tex)
         {
+            if (tex == null) throw new ArgumentNullException(nameof(tex));
+
             if (tex.IsGif)
                 return MipmapFormat.ImageGIF;
 

RePKG.Application/Texture/Writer/TexFrameInfoContainerWriter.cs

@@ -26,7 +26,7 @@ public void WriteTo(BinaryWriter writer, TexFrameInfoContainer frameInfoContaine
                     break;
 
                 default:
-                    throw new UnknownTexFrameInfoContainerMagicException(frameInfoContainer.Magic);
+                    throw new UnknownMagicException(nameof(TexFrameInfoContainerWriter), frameInfoContainer.Magic);
             }
         }
 

RePKG.Application/Texture/Writer/TexImageContainerWriter.cs

@@ -36,7 +36,7 @@ public void WriteTo(BinaryWriter writer, TexImageContainer imageContainer)
                     break;
 
                 default:
-                    throw new UnknownTexImageContainerMagicException(imageContainer.Magic);
+                    throw new UnknownMagicException(nameof(TexImageContainerWriter), imageContainer.Magic);
             }
         }
 

RePKG.Application/Texture/Writer/TexWriter.cs

@@ -27,10 +27,10 @@ public void WriteTo(BinaryWriter writer, Tex tex)
             if (tex == null) throw new ArgumentNullException(nameof(tex));
 
             if (tex.Magic1 != "TEXV0005")
-                throw new UnknownTexHeaderMagicException(nameof(tex.Magic1), tex.Magic1);
+                throw new UnknownMagicException(nameof(TexWriter), nameof(tex.Magic1), tex.Magic1);
 
             if (tex.Magic2 != "TEXI0001")
-                throw new UnknownTexHeaderMagicException(nameof(tex.Magic2), tex.Magic2);
+                throw new UnknownMagicException(nameof(TexWriter), nameof(tex.Magic2), tex.Magic2);
 
             writer.WriteNString(tex.Magic1);
             writer.WriteNString(tex.Magic2);

RePKG.Core/RePKG.Core.csproj.DotSettings

@@ -1,4 +1,5 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=texture_005Cenums/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=texture_005Chelpers/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=texture_005Cinterfaces/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=texture_005Cinterfaces_005Cwriter/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

RePKG.Core/Texture/Enums/DXTFlags.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace RePKG.Core.Texture
+{
+    [Flags]
+    public enum DXTFlags
+    {
+        DXT1 = 1,
+        DXT3 = 1 << 1,
+        DXT5 = 1 << 2,
+    }
+}

RePKG.Core/Texture/Tex.cs

@@ -11,7 +11,7 @@ public class Tex
         public TexFrameInfoContainer FrameInfoContainer { get; set; }
 
         public bool IsGif => HasFlag(TexFlags.IsGif);
-        public TexImage FirstImage => ImagesContainer?.Images?.FirstOrDefault();
+        public TexImage FirstImage => ImagesContainer?.Images.FirstOrDefault();
 
         public bool HasFlag(TexFlags flag)
         {

RePKG.Core/Texture/TexImage.cs

@@ -7,6 +7,6 @@ public class TexImage
     {
         public List<TexMipmap> Mipmaps { get; } = new List<TexMipmap>();
 
-        public TexMipmap FirstMipmap => Mipmaps?.FirstOrDefault();
+        public TexMipmap FirstMipmap => Mipmaps.FirstOrDefault();
     }
 }