Extracted ISimpleScanComparer interface.

KN4CK3R · KN4CK3R · commit 8b091bb75359 · 2020-07-05T19:23:39.000+02:00
diff --git a/ReClass.NET/MemoryScanner/Comparer/ArrayOfBytesMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/ArrayOfBytesMemoryComparer.cs
@@ -1,10 +1,10 @@
-﻿using System;
+using System;
 using System.Diagnostics;
 using System.Diagnostics.Contracts;
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class ArrayOfBytesMemoryComparer : IScanComparer
+	public class ArrayOfBytesMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType => ScanCompareType.Equal;
 		public int ValueSize => bytePattern?.Length ?? byteArray.Length;
diff --git a/ReClass.NET/MemoryScanner/Comparer/ByteMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/ByteMemoryComparer.cs
@@ -3,7 +3,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class ByteMemoryComparer : IScanComparer
+	public class ByteMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public byte Value1 { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/DoubleMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/DoubleMemoryComparer.cs
@@ -4,7 +4,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class DoubleMemoryComparer : IScanComparer
+	public class DoubleMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public ScanRoundMode RoundType { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/FloatMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/FloatMemoryComparer.cs
@@ -1,10 +1,10 @@
-﻿using System;
+using System;
 using System.Diagnostics;
 using ReClassNET.Extensions;
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class FloatMemoryComparer : IScanComparer
+	public class FloatMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public ScanRoundMode RoundType { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/IScanComparer.cs b/ReClass.NET/MemoryScanner/Comparer/IScanComparer.cs
@@ -1,64 +1,7 @@
-﻿using System;
-using System.Diagnostics.Contracts;
-
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	[ContractClass(typeof(ScanComparerContract))]
 	public interface IScanComparer
 	{
 		ScanCompareType CompareType { get; }
-		int ValueSize { get; }
-
-		/// <summary>
-		/// Compares the data at the provided index to the current <see cref="CompareType"/>.
-		/// </summary>
-		/// <param name="data">The byte array to be compared.</param>
-		/// <param name="index">The index into the byte array.</param>
-		/// <param name="result">[out] The scan result if the <see cref="CompareType"/> matched.</param>
-		/// <returns>True if matched.</returns>
-		bool Compare(byte[] data, int index, out ScanResult result);
-
-		/// <summary>
-		/// Compares the data at the provided index to the current <see cref="CompareType"/>.
-		/// The previous results may be used.
-		/// </summary>
-		/// <param name="data">The byte array to be compared.</param>
-		/// <param name="index">The index into the byte array.</param>
-		/// <param name="previous">Scan result to be compared.</param>
-		/// <param name="result">[out] The scan result if the <see cref="CompareType"/> matched.</param>
-		/// <returns>True if matched.</returns>
-		bool Compare(byte[] data, int index, ScanResult previous, out ScanResult result);
-	}
-
-	[ContractClassFor(typeof(IScanComparer))]
-	internal abstract class ScanComparerContract : IScanComparer
-	{
-		public ScanCompareType CompareType => throw new NotImplementedException();
-
-		public int ValueSize
-		{
-			get
-			{
-				Contract.Ensures(ValueSize > 0);
-
-				throw new NotImplementedException();
-			}
-		}
-		public bool Compare(byte[] data, int index, out ScanResult result)
-		{
-			Contract.Requires(data != null);
-			Contract.Requires(index >= 0);
-
-			throw new NotImplementedException();
-		}
-
-		public bool Compare(byte[] data, int index, ScanResult previous, out ScanResult result)
-		{
-			Contract.Requires(data != null);
-			Contract.Requires(index >= 0);
-			Contract.Requires(previous != null);
-
-			throw new NotImplementedException();
-		}
 	}
 }
diff --git a/ReClass.NET/MemoryScanner/Comparer/ISimpleScanComparer.cs b/ReClass.NET/MemoryScanner/Comparer/ISimpleScanComparer.cs
@@ -0,0 +1,27 @@
+namespace ReClassNET.MemoryScanner.Comparer
+{
+	public interface ISimpleScanComparer : IScanComparer
+	{
+		int ValueSize { get; }
+
+		/// <summary>
+		/// Compares the data at the provided index to the current <see cref="IScanComparer.CompareType"/>.
+		/// </summary>
+		/// <param name="data">The byte array to be compared.</param>
+		/// <param name="index">The index into the byte array.</param>
+		/// <param name="result">[out] The scan result if the <see cref="IScanComparer.CompareType"/> matched.</param>
+		/// <returns>True if matched.</returns>
+		bool Compare(byte[] data, int index, out ScanResult result);
+
+		/// <summary>
+		/// Compares the data at the provided index to the current <see cref="IScanComparer.CompareType"/>.
+		/// The previous results may be used.
+		/// </summary>
+		/// <param name="data">The byte array to be compared.</param>
+		/// <param name="index">The index into the byte array.</param>
+		/// <param name="previous">Scan result to be compared.</param>
+		/// <param name="result">[out] The scan result if the <see cref="IScanComparer.CompareType"/> matched.</param>
+		/// <returns>True if matched.</returns>
+		bool Compare(byte[] data, int index, ScanResult previous, out ScanResult result);
+	}
+}
diff --git a/ReClass.NET/MemoryScanner/Comparer/IntegerMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/IntegerMemoryComparer.cs
@@ -3,7 +3,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class IntegerMemoryComparer : IScanComparer
+	public class IntegerMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public int Value1 { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/LongMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/LongMemoryComparer.cs
@@ -3,7 +3,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class LongMemoryComparer : IScanComparer
+	public class LongMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public long Value1 { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/ShortMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/ShortMemoryComparer.cs
@@ -3,7 +3,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class ShortMemoryComparer : IScanComparer
+	public class ShortMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType { get; }
 		public short Value1 { get; }
diff --git a/ReClass.NET/MemoryScanner/Comparer/StringMemoryComparer.cs b/ReClass.NET/MemoryScanner/Comparer/StringMemoryComparer.cs
@@ -5,7 +5,7 @@
 
 namespace ReClassNET.MemoryScanner.Comparer
 {
-	public class StringMemoryComparer : IScanComparer
+	public class StringMemoryComparer : ISimpleScanComparer
 	{
 		public ScanCompareType CompareType => ScanCompareType.Equal;
 		public bool CaseSensitive { get; }
diff --git a/ReClass.NET/MemoryScanner/Scanner.cs b/ReClass.NET/MemoryScanner/Scanner.cs
@@ -216,7 +216,7 @@ private Task<bool> FirstScan(IScanComparer comparer, IProgress<int> progress, Ca
 
 				var result = Parallel.ForEach(
 					regions, // Sections get grouped by the framework to balance the workers.
-					() => new ScannerContext(Settings, comparer, initialBufferSize), // Create a new context for every worker (thread).
+					() => new ScannerContext(CreateWorker(Settings, comparer), initialBufferSize), // Create a new context for every worker (thread).
 					(s, state, _, context) =>
 					{
 						if (!ct.IsCancellationRequested)
@@ -295,7 +295,7 @@ private Task<bool> NextScan(IScanComparer comparer, IProgress<int> progress, Can
 			{
 				var result = Parallel.ForEach(
 					CurrentStore.GetResultBlocks(),
-					() => new ScannerContext(Settings, comparer, 0),
+					() => new ScannerContext(CreateWorker(Settings, comparer), 0),
 					(b, state, _, context) =>
 					{
 						if (!ct.IsCancellationRequested)
@@ -397,5 +397,15 @@ private static ScanResultBlock CreateResultBlock(IReadOnlyList<ScanResult> resul
 			);
 			return block;
 		}
+
+		private static IScannerWorker CreateWorker(ScanSettings settings, IScanComparer comparer)
+		{
+			if (comparer is ISimpleScanComparer simpleScanComparer)
+			{
+				return new ScannerWorker(settings, simpleScanComparer);
+			}
+
+			throw new Exception();
+		}
 	}
 }
diff --git a/ReClass.NET/MemoryScanner/ScannerContext.cs b/ReClass.NET/MemoryScanner/ScannerContext.cs
@@ -1,24 +1,21 @@
-﻿using System.Diagnostics.Contracts;
-using ReClassNET.MemoryScanner.Comparer;
+using System.Diagnostics.Contracts;
 
 namespace ReClassNET.MemoryScanner
 {
 	internal class ScannerContext
 	{
 		public byte[] Buffer { get; private set; }
-		public ScannerWorker Worker { get; }
+		public IScannerWorker Worker { get; }
 
-		public ScannerContext(ScanSettings settings, IScanComparer comparer, int bufferSize)
+		public ScannerContext(IScannerWorker worker, int bufferSize)
 		{
-			Contract.Requires(settings != null);
-			Contract.Requires(comparer != null);
 			Contract.Requires(bufferSize >= 0);
 			Contract.Ensures(Buffer != null);
 			Contract.Ensures(Worker != null);
 
 			EnsureBufferSize(bufferSize);
 
-			Worker = new ScannerWorker(settings, comparer);
+			Worker = worker;
 		}
 
 		public void EnsureBufferSize(int size)
diff --git a/ReClass.NET/MemoryScanner/ScannerWorker.cs b/ReClass.NET/MemoryScanner/ScannerWorker.cs
@@ -9,9 +9,9 @@ namespace ReClassNET.MemoryScanner
 	internal class ScannerWorker : IScannerWorker
 	{
 		private readonly ScanSettings settings;
-		private readonly IScanComparer comparer;
+		private readonly ISimpleScanComparer comparer;
 
-		public ScannerWorker(ScanSettings settings, IScanComparer comparer)
+		public ScannerWorker(ScanSettings settings, ISimpleScanComparer comparer)
 		{
 			Contract.Requires(settings != null);
 			Contract.Requires(comparer != null);
diff --git a/ReClass.NET/ReClass.NET.csproj b/ReClass.NET/ReClass.NET.csproj
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
@@ -244,10 +244,12 @@
     <Compile Include="MemoryScanner\Comparer\FloatMemoryComparer.cs" />
     <Compile Include="MemoryScanner\Comparer\IScanComparer.cs" />
     <Compile Include="MemoryScanner\Comparer\IntegerMemoryComparer.cs" />
+    <Compile Include="MemoryScanner\Comparer\ISimpleScanComparer.cs" />
     <Compile Include="MemoryScanner\Comparer\LongMemoryComparer.cs" />
     <Compile Include="MemoryScanner\Comparer\ShortMemoryComparer.cs" />
     <Compile Include="MemoryScanner\Comparer\StringMemoryComparer.cs" />
     <Compile Include="MemoryScanner\InputCorrelatedScanner.cs" />
+    <Compile Include="MemoryScanner\IScannerWorker.cs" />
     <Compile Include="MemoryScanner\MemoryRecord.cs" />
     <Compile Include="MemoryScanner\PatternScanner.cs" />
     <Compile Include="MemoryScanner\ScanCompareType.cs" />

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Diagnostics;`
`3`	`3`	`using System.Diagnostics.Contracts;`
`4`	`4`
`5`	`5`	`namespace ReClassNET.MemoryScanner.Comparer`
`6`	`6`	`{`
`7`		`- public class ArrayOfBytesMemoryComparer : IScanComparer`
	`7`	`+ public class ArrayOfBytesMemoryComparer : ISimpleScanComparer`
`8`	`8`	`{`
`9`	`9`	`public ScanCompareType CompareType => ScanCompareType.Equal;`
`10`	`10`	`public int ValueSize => bytePattern?.Length ?? byteArray.Length;`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace ReClassNET.MemoryScanner.Comparer`
`5`	`5`	`{`
`6`		`- public class ByteMemoryComparer : IScanComparer`
	`6`	`+ public class ByteMemoryComparer : ISimpleScanComparer`
`7`	`7`	`{`
`8`	`8`	`public ScanCompareType CompareType { get; }`
`9`	`9`	`public byte Value1 { get; }`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace ReClassNET.MemoryScanner.Comparer`
`6`	`6`	`{`
`7`		`- public class DoubleMemoryComparer : IScanComparer`
	`7`	`+ public class DoubleMemoryComparer : ISimpleScanComparer`
`8`	`8`	`{`
`9`	`9`	`public ScanCompareType CompareType { get; }`
`10`	`10`	`public ScanRoundMode RoundType { get; }`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace ReClassNET.MemoryScanner.Comparer`
`5`	`5`	`{`
`6`		`- public class IntegerMemoryComparer : IScanComparer`
	`6`	`+ public class IntegerMemoryComparer : ISimpleScanComparer`
`7`	`7`	`{`
`8`	`8`	`public ScanCompareType CompareType { get; }`
`9`	`9`	`public int Value1 { get; }`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace ReClassNET.MemoryScanner.Comparer`
`5`	`5`	`{`
`6`		`- public class LongMemoryComparer : IScanComparer`
	`6`	`+ public class LongMemoryComparer : ISimpleScanComparer`
`7`	`7`	`{`
`8`	`8`	`public ScanCompareType CompareType { get; }`
`9`	`9`	`public long Value1 { get; }`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace ReClassNET.MemoryScanner.Comparer`
`5`	`5`	`{`
`6`		`- public class ShortMemoryComparer : IScanComparer`
	`6`	`+ public class ShortMemoryComparer : ISimpleScanComparer`
`7`	`7`	`{`
`8`	`8`	`public ScanCompareType CompareType { get; }`
`9`	`9`	`public short Value1 { get; }`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace ReClassNET.MemoryScanner.Comparer`
`7`	`7`	`{`
`8`		`- public class StringMemoryComparer : IScanComparer`
	`8`	`+ public class StringMemoryComparer : ISimpleScanComparer`
`9`	`9`	`{`
`10`	`10`	`public ScanCompareType CompareType => ScanCompareType.Equal;`
`11`	`11`	`public bool CaseSensitive { get; }`