Update to .NET 8 (#11)

* update projects to .net 8.0 * apply many vs refactoring suggestions * more cleanup --------- Co-authored-by: Benjamin Sutas <[email protected]>
OpenLoco · Nov 15, 2023 · 582066b · 582066b
1 parent 0ed6942
commit 582066b
Show file tree

Hide file tree

Showing 39 changed files with 275 additions and 298 deletions.
diff --git a/DatFileRenamer/DatFileRenamer.csproj b/DatFileRenamer/DatFileRenamer.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>

diff --git a/DatFileRenamer/Program.cs b/DatFileRenamer/Program.cs
@@ -20,7 +20,7 @@
 	// read each files S5Header
 	using var fileStream = new FileStream(datFile, FileMode.Open, FileAccess.Read, FileShare.None, 32, FileOptions.SequentialScan | FileOptions.Asynchronous);
 	using var reader = new BinaryReader(fileStream);
-	var data = reader.ReadBytes(0x10);
+	var data = reader.ReadBytes(0x10).AsSpan();
 
 	var flags = BitConverter.ToUInt32(data[0..4]);
 	var datName = System.Text.Encoding.ASCII.GetString(data[4..12]).Trim();

diff --git a/OpenLocoTool.sln b/OpenLocoTool.sln
@@ -12,7 +12,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenLocoToolGui", "OpenLoco
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenLocoToolCommon", "OpenLocoToolCommon\OpenLocoToolCommon.csproj", "{BCD93536-D322-4C14-B193-1F643D03C788}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenLocoToolTests", "OpenLocoToolTests\OpenLocoToolTests.csproj", "{55293DEB-00FA-45AD-814D-CB37383BE0D5}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenLocoToolTests", "OpenLocoToolTests\OpenLocoToolTests.csproj", "{55293DEB-00FA-45AD-814D-CB37383BE0D5}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DatFileRenamer", "DatFileRenamer\DatFileRenamer.csproj", "{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -72,6 +74,18 @@ Global
 		{55293DEB-00FA-45AD-814D-CB37383BE0D5}.Release|x64.Build.0 = Release|Any CPU
 		{55293DEB-00FA-45AD-814D-CB37383BE0D5}.Release|x86.ActiveCfg = Release|Any CPU
 		{55293DEB-00FA-45AD-814D-CB37383BE0D5}.Release|x86.Build.0 = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|x64.Build.0 = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Debug|x86.Build.0 = Debug|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|x64.ActiveCfg = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|x64.Build.0 = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|x86.ActiveCfg = Release|Any CPU
+		{AD079FD2-EC1C-459C-BDE6-8D0C527767AB}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/OpenLocoTool/DatFileParsing/ByteReader.cs b/OpenLocoTool/DatFileParsing/ByteReader.cs
@@ -136,7 +136,7 @@ public static ILocoStruct ReadLocoStruct(ReadOnlySpan<byte> data, Type t)
 				args.Add(ReadT(data, p.PropertyType, offsetAttr.Offset, arrLength));
 			}
 
-			return (ILocoStruct?)Activator.CreateInstance(t, args.ToArray()) ?? throw new InvalidDataException("couldn't parse");
+			return (ILocoStruct?)Activator.CreateInstance(t, [.. args]) ?? throw new InvalidDataException("couldn't parse");
 		}
 
 		public static IList<ILocoStruct> ReadLocoStructArray(ReadOnlySpan<byte> data, Type t, int count, int structSize) // could get struct size from attribute, but easier just to pass in

diff --git a/OpenLocoTool/DatFileParsing/ByteReaderT.cs b/OpenLocoTool/DatFileParsing/ByteReaderT.cs
@@ -23,19 +23,34 @@ public static int32_t Read_int32t(ReadOnlySpan<byte> data, int offset)
 		public static T Read<T>(ReadOnlySpan<byte> data, int offset) where T : struct
 		{
 			if (typeof(T) == typeof(uint8_t))
+			{
 				return (T)(dynamic)Read_uint8t(data, offset);
+			}
+
 			if (typeof(T) == typeof(int8_t))
+			{
 				return (T)(dynamic)Read_int8t(data, offset);
+			}
 
 			if (typeof(T) == typeof(uint16_t))
+			{
 				return (T)(dynamic)Read_uint16t(data, offset);
+			}
+
 			if (typeof(T) == typeof(int16_t))
+			{
 				return (T)(dynamic)Read_int16t(data, offset);
+			}
 
 			if (typeof(T) == typeof(uint32_t))
+			{
 				return (T)(dynamic)Read_uint32t(data, offset);
+			}
+
 			if (typeof(T) == typeof(int32_t))
+			{
 				return (T)(dynamic)Read_int32t(data, offset);
+			}
 
 			throw new NotImplementedException("");
 		}

diff --git a/OpenLocoTool/DatFileParsing/ByteWriter.cs b/OpenLocoTool/DatFileParsing/ByteWriter.cs
@@ -114,12 +114,7 @@ public static ReadOnlySpan<byte> WriteLocoStruct(ILocoStruct obj)
 					arrLength = arrLengthAttr.Length;
 				}
 
-				var propVal = p.GetValue(obj);
-				if (propVal == null)
-				{
-					throw new NullReferenceException();
-				}
-
+				var propVal = p.GetValue(obj) ?? throw new NullReferenceException();
 				WriteT(buf, p.PropertyType, offsetAttr.Offset, propVal);
 			}
 

diff --git a/OpenLocoTool/DatFileParsing/ByteWriterT.cs b/OpenLocoTool/DatFileParsing/ByteWriterT.cs
@@ -23,22 +23,33 @@ public static void Write_int32t(Span<byte> data, int offset, int32_t val)
 		public static void Write<T>(Span<byte> data, int offset, T val) where T : struct
 		{
 			if (typeof(T) == typeof(uint8_t))
+			{
 				Write_uint8t(data, offset, (uint8_t)(dynamic)val);
+			}
 			else if (typeof(T) == typeof(int8_t))
+			{
 				Write_int8t(data, offset, (int8_t)(dynamic)val);
-
+			}
 			else if (typeof(T) == typeof(uint16_t))
+			{
 				Write_uint16t(data, offset, (uint16_t)(dynamic)val);
+			}
 			else if (typeof(T) == typeof(int16_t))
+			{
 				Write_int16t(data, offset, (int16_t)(dynamic)val);
-
+			}
 			else if (typeof(T) == typeof(uint32_t))
+			{
 				Write_uint32t(data, offset, (uint32_t)(dynamic)val);
+			}
 			else if (typeof(T) == typeof(int32_t))
+			{
 				Write_int32t(data, offset, (int32_t)(dynamic)val);
-
+			}
 			else
+			{
 				throw new NotImplementedException($"{typeof(T)}");
+			}
 		}
 
 		public static T[] Write_Array<T>(Span<byte> data, int count, int offset = 0) where T : struct

diff --git a/OpenLocoTool/DatFileParsing/LocoAttributes.cs b/OpenLocoTool/DatFileParsing/LocoAttributes.cs
@@ -1,37 +1,27 @@
 namespace OpenLocoTool.DatFileParsing
 {
 	[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false)]
-	public class LocoArrayLengthAttribute : Attribute
+	public class LocoArrayLengthAttribute(int length) : Attribute
 	{
-		public LocoArrayLengthAttribute(int length) => Length = length;
-		public int Length { get; }
+		public int Length => length;
 	}
 
 	[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false)]
-	public class LocoStructOffsetAttribute : Attribute
+	public class LocoStructOffsetAttribute(int offset) : Attribute
 	{
-		public LocoStructOffsetAttribute(int offset) => Offset = offset;
-
-		public int Offset { get; }
+		public int Offset => offset;
 	}
 
 	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)]
-	public class LocoStructSizeAttribute : Attribute
+	public class LocoStructSizeAttribute(int size) : Attribute
 	{
-		public LocoStructSizeAttribute(int size) => Size = size;
-
-		public int Size { get; }
+		public int Size => size;
 	}
 
 	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false)]
-	public class LocoStringTableAttribute : Attribute
+	public class LocoStringTableAttribute(params string[] names) : Attribute
 	{
-		public LocoStringTableAttribute(params string[] names)
-		{
-			Names = names;
-		}
-
-		public string[] Names { get; }
+		public string[] Names => names;
 
 		public int Count => Names.Length;
 	}
@@ -40,4 +30,9 @@ public LocoStringTableAttribute(params string[] names)
 	[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false)]
 	public class LocoStructVariableLoadAttribute : Attribute
 	{ }
+
+	// basically a 'skip' attribute to allow deferred loading for variable data, and writing of this property will be 0
+	[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property, AllowMultiple = false)]
+	public class LocoStructZeroAttribute : Attribute
+	{ }
 }
diff --git a/OpenLocoTool/DatFileParsing/LocoObject.cs b/OpenLocoTool/DatFileParsing/LocoObject.cs
@@ -81,16 +81,10 @@ public interface ILocoObject
 	}
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
-	public class G1Dat
+	public class G1Dat(G1Header g1Header, List<G1Element32> g1Elements)
 	{
-		public G1Dat(G1Header g1Header, List<G1Element32> g1Elements)
-		{
-			G1Header = g1Header;
-			G1Elements = g1Elements;
-		}
-
-		public G1Header G1Header { get; set; }
-		public List<G1Element32> G1Elements { get; set; }
+		public G1Header G1Header { get; set; } = g1Header;
+		public List<G1Element32> G1Elements { get; set; } = g1Elements;
 	}
 
 	public static class ObjectTypeFixedSize

diff --git a/OpenLocoTool/DatFileParsing/ObjectAnnotator.cs b/OpenLocoTool/DatFileParsing/ObjectAnnotator.cs
@@ -31,9 +31,11 @@ public static IList<Annotation> Annotate(byte[] bytelist, out byte[] fullData)
 			runningCount += ObjectHeader.StructLength;
 
 			// Decode Loco Struct
-			fullData = bytelist[..runningCount]
-				.Concat(SawyerStreamReader.Decode(objectHeader.Encoding, bytelist.AsSpan()[runningCount..(int)(runningCount + objectHeader.DataLength)]))
-				.ToArray();
+			fullData =
+			[
+				.. bytelist[..runningCount],
+				.. SawyerStreamReader.Decode(objectHeader.Encoding, bytelist.AsSpan()[runningCount..(int)(runningCount + objectHeader.DataLength)]),
+			];
 
 			var locoStruct = SawyerStreamReader.GetLocoStruct(s5Header.ObjectType, fullData.AsSpan()[runningCount..]);
 			if (locoStruct == null)
@@ -164,15 +166,14 @@ public static int AnnotateStringTable(byte[] fullData, int runningCount, ILocoSt
 				while (continuing);
 
 				var endIndexOfStringList = index + runningCount;
-				var nullIndex = 0;
 				var elementRoot = new Annotation("Element " + i, root, runningCount, index);
 				annotations.Add(elementRoot);
 
 				do
 				{
 					annotations.Add(new Annotation(((LanguageId)fullData[runningCount]).ToString(), elementRoot, runningCount, 1));
 					runningCount++;
-					nullIndex = Array.IndexOf(fullData[runningCount..], (byte)0);
+					var nullIndex = Array.IndexOf(fullData[runningCount..], (byte)0);
 
 					var stringElement = Encoding.ASCII.GetString(fullData[runningCount..(runningCount + nullIndex)]);
 
@@ -187,7 +188,7 @@ public static int AnnotateStringTable(byte[] fullData, int runningCount, ILocoSt
 			return runningCount;
 		}
 
-		static IList<Annotation> AnnotateProperties(object o, int runningCount = 0, Annotation? root = null)
+		static List<Annotation> AnnotateProperties(object o, int runningCount = 0, Annotation? root = null)
 		{
 			var annotations = new List<Annotation>();