Merge pull request #13 from FrankvdStam/feature/sonar-issues

Feature/sonar issues

.github/workflows/build.yml

@@ -53,7 +53,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
         shell: powershell
         run: |
-          .\.sonar\scanner\dotnet-sonarscanner begin /k:"FrankvdStam_SoulSplitter_AYT9tJW7QlZ0fhD27xsa" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="${{ secrets.SONAR_HOST_URL }}" /d:sonar.exclusions=src/cli/Program.cs /d:sonar.cs.opencover.reportsPaths=TestResults/*.xml
+          .\.sonar\scanner\dotnet-sonarscanner begin /k:"FrankvdStam_SoulSplitter_AYT9tJW7QlZ0fhD27xsa" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="${{ secrets.SONAR_HOST_URL }}" /d:sonar.cs.opencover.reportsPaths=TestResults/*.xml
           dotnet build src/soulsplitter/soulsplitter.csproj
           dotnet test -p:CollectCoverage=true -p:CoverletOutput=../../TestResults/ -p:MergeWith=../../TestResults/ -p:CoverletOutputFormat=opencover
           .\.sonar\scanner\dotnet-sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}"

src/SoulMemory/ArmoredCore6/ArmoredCore6.cs

@@ -25,9 +25,7 @@ namespace SoulMemory.ArmoredCore6
     public class ArmoredCore6 : IGame
     {
         private readonly IProcessHook _armoredCore6;
-
-        public ArmoredCore6() : this(null) { }
-
+
         public ArmoredCore6(IProcessHook processHook = null)
         {
             _armoredCore6 = processHook ?? new ProcessHook("armoredcore6");

src/SoulMemory/DarkSouls1/DropMod.cs

@@ -78,7 +78,6 @@ public void UpdateAllAchievements()
                 var s = temp; //structs need to be put in a variable in order to be mutable. Meme.
                 if (s.ShouldSwitch && items.Any(j => j.ItemType == s.SwitchItem))
                 {
-                    //Console.WriteLine($"Switching {s.RowId} {s.SwitchItem}");
                     GuaranteeDrop(s.RowId, s.ItemId2);
                     s.ShouldSwitch = false;
                 }
@@ -110,7 +109,7 @@ private void GuaranteeDrop(int rowId, int itemId)
         }
 
 
-        private List<SwitchableDrop> _switchableWeapons = new List<SwitchableDrop>()
+        private readonly List<SwitchableDrop> _switchableWeapons = new List<SwitchableDrop>()
         {
             //Darkroot
             new SwitchableDrop(ItemType.StoneGreatsword          , 23800000, 306000 , 1503000),

src/SoulMemory/DarkSouls1/Ptde.cs

@@ -416,8 +416,7 @@ public void WriteWeaponDescription(uint weaponId, string description)
             //weaponName 0x1d0 - 0x30
             //weaponInfo 0x1cc - 0x58
             //weaponCaption 0x1ac - 0x68
-
-            //var weaponDescriptionsPointer = _msgMan.CreatePointerFromAddress(0x1ac);
+
             var weaponDescriptionsPointer = _msgMan.CreatePointerFromAddress(0x68);
 
             if (!_weaponDescriptionsTable.Any())
@@ -429,7 +428,7 @@ public void WriteWeaponDescription(uint weaponId, string description)
 
             var dataPointer = weaponDescriptionsPointer.CreatePointerFromAddress(0x14);
             var textOffset = dataPointer.ReadInt32(weaponDescription.DataOffset * 4);
-            var str = weaponDescriptionsPointer.ReadUnicodeString(out int length, offset: textOffset);
+            weaponDescriptionsPointer.ReadUnicodeString(out int length, offset: textOffset);
 
             var buffer = Encoding.Unicode.GetBytes(description);
             var bytes = new byte[length];

src/SoulMemory/DarkSouls3/DarkSouls3.cs

@@ -79,9 +79,11 @@ private ResultErr<RefreshError> InitPointers()
         {
             try
             {
-                if (!Version.TryParse(_process.MainModule.FileVersionInfo.ProductVersion, out Version v))
+                var versionString = _process?.MainModule?.FileVersionInfo.ProductVersion ?? "Read failed";
+
+                if (!Version.TryParse(versionString, out Version v))
                 {
-                    return Result.Err(new RefreshError(RefreshErrorReason.UnknownException, $"Unable to determine game version: {_process?.MainModule?.FileVersionInfo?.ProductVersion}"));
+                    return Result.Err(new RefreshError(RefreshErrorReason.UnknownException, $"Unable to determine game version: {versionString}"));
                 }
 
                 //Clear count: 0x78 -> likely subject to the same shift that happens to IGT offset

src/SoulMemory/EldenRing/EldenRing.cs

@@ -43,18 +43,6 @@ public class EldenRing : IGame
         private long _mapIdOffset;
         private long _playerInsOffset;
 
-        public EldenRing() 
-        {
-            _applyIgtFix = true; 
-        }
-
-        public EldenRing(bool applyIgtFix = true)
-        {
-            _applyIgtFix = applyIgtFix;
-        }
-
-        private readonly bool _applyIgtFix;
-
 
         #region Refresh/init/reset ================================================================================================
         public Process GetProcess() => _process;
@@ -144,9 +132,10 @@ private ResultErr<RefreshError> InitPointers()
         {
             try
             {
-                if (!Version.TryParse(_process.MainModule.FileVersionInfo.ProductVersion, out Version v))
+                var versionString = _process?.MainModule?.FileVersionInfo.ProductVersion ?? "Read failed";
+                if (!Version.TryParse(versionString, out Version v))
                 {
-                    return Result.Err(new RefreshError(RefreshErrorReason.UnknownException, $"Unable to determine game version: {_process?.MainModule?.FileVersionInfo?.ProductVersion}"));
+                    return Result.Err(new RefreshError(RefreshErrorReason.UnknownException, $"Unable to determine game version: {versionString}"));
                 }
 
                 InitializeOffsets(v);
@@ -158,7 +147,7 @@ private ResultErr<RefreshError> InitPointers()
                     return result;
                 }
 
-                if (_applyIgtFix && !ApplyIgtFix())
+                if (!ApplyIgtFix())
                 {
                     return Result.Err(new RefreshError(RefreshErrorReason.UnknownException, "MIGT injection failed"));
                 }
@@ -555,10 +544,6 @@ public void WriteInGameTimeMilliseconds(int milliseconds)
             _igt.WriteInt32(milliseconds);
         }
 
-        public void ResetIgt()
-        {
-            _igt.WriteInt32(0);
-        }
         #endregion
 
         #region B3's IGT fix

src/SoulMemory/Memory/Extensions.cs

@@ -27,25 +27,7 @@ public static string ToHexString(this byte[] bytes)
         {
             return BitConverter.ToString(bytes).Replace("-", " ");
         }
-
-        public static string ToHexFileString(this byte[] bytes)
-        {
-            var sb = new StringBuilder();
-            var newline = 0;
-            foreach (var b in bytes)
-            {
-                sb.AppendFormat("{0:x2}", b);
-                newline++;
-
-                if (newline >= 10)
-                {
-                    sb.AppendLine();
-                    newline = 0;
-                }
-            }
-            return sb.ToString();
-        }
-
+
         public static string GetDisplayName(this Enum enumValue)
         {
             var displayName = enumValue

src/SoulMemory/Memory/IMemory.cs

@@ -31,7 +31,7 @@ public interface IMemory
 
     public class ByteArrayMemory : IMemory
     {
-        private byte[] _data;
+        private readonly byte[] _data;
         public ByteArrayMemory(byte[] data)
         {
             _data = data;
@@ -63,37 +63,6 @@ public void WriteBytes(long? offset, byte[] bytes)
         }
     }
 
-    public class ProcessMemory : IMemory
-    {
-        private Process _process;
-        public ProcessMemory(Process process)
-        {
-            _process = process;
-        }
-
-        public byte[] ReadBytes(long? offset, int length)
-        {
-            ResultOk<byte[]> result = null;
-            if (offset != null)
-            {
-                result = _process.ReadProcessMemory(offset.Value, length);
-            }
-
-            if (result != null && result.IsOk)
-            {
-                return result.Unwrap();
-            }
-
-            var buffer = new byte[length];
-            return buffer;
-        }
-
-        public void WriteBytes(long? offset, byte[] bytes)
-        {
-            _process.WriteProcessMemory(offset.Value, bytes);
-        }
-    }
-
     public static class MemoryExtensions
     {
         #region Read

src/SoulMemory/MemoryV2/ByteArrayMemory.cs

@@ -21,7 +21,7 @@ namespace SoulMemory.MemoryV2
 {
     public class ByteArrayMemory : IMemory
     {
-        private byte[] _data;
+        private readonly byte[] _data;
         public ByteArrayMemory(byte[] data)
         {
             _data = data;

src/SoulMemory/MemoryV2/Memory/Pointer.cs

@@ -30,7 +30,7 @@ public class Pointer : IMemory
 
         public Pointer(IMemory memory)
         {
-            if (memory is Pointer p)
+            if (memory is Pointer)
             {
                 throw new ArgumentException("Can't initialize pointer object with another pointer.", nameof(memory));
             }
@@ -41,7 +41,7 @@ public Pointer(IMemory memory)
 
         public Pointer(IMemory memory, params long[] offsets)
         {
-            if (memory is Pointer p)
+            if (memory is Pointer)
             {
                 throw new ArgumentException("Can't initialize pointer object with another pointer.", nameof(memory));
             }

src/SoulMemory/MemoryV2/PointerTreeBuilder/PointerNode.cs

@@ -36,7 +36,7 @@ public class PointerNode
 
         //used for pointers
         public long[] Offsets = new long[] { };
-        public Pointer Pointer;// = new Pointer();
+        public Pointer Pointer;
 
         public List<PointerNode> Pointers = new List<PointerNode>();
 

src/SoulMemory/MemoryV2/Process/ProcessWrapper.cs

@@ -31,12 +31,7 @@ public class ProcessWrapper : IProcessWrapper
 
         public List<ProcessWrapperModule> GetProcessModules()
         {
-            var result = new List<ProcessWrapperModule>();
-            foreach (var pm in _process.Modules)
-            {
-                result.Add(ProcessWrapperModule.FromProcessModule((ProcessModule)pm));
-            }
-            return result;
+            return (from object pm in _process.Modules select ProcessWrapperModule.FromProcessModule((ProcessModule)pm)).ToList();
         }
 
         /// <summary>
@@ -91,7 +86,7 @@ public byte[] ReadBytes(long offset, int length)
             {
                 return new byte[length];
             }
-            return _process?.ReadProcessMemoryNoError(offset, length);
+            return _process.ReadProcessMemoryNoError(offset, length);
         }
 
         public void WriteBytes(long offset, byte[] bytes) => _process?.WriteProcessMemoryNoError(offset, bytes);

src/SoulMemory/Parameters/BaseParam.cs

@@ -28,28 +28,28 @@ namespace SoulMemory.Parameters
 {
     public abstract class BaseParam
     {
-        private List<(PropertyInfo propertyInfo, ParamFieldAttribute paramFieldAttribute)> ParamFieldPropertyCache;
-        private List<(PropertyInfo propertyInfo, ParamBitFieldAttribute paramFieldAttribute)> ParamBitfieldPropertyCache;
+        private readonly List<(PropertyInfo propertyInfo, ParamFieldAttribute paramFieldAttribute)> _paramFieldPropertyCache;
+        private readonly List<(PropertyInfo propertyInfo, ParamBitFieldAttribute paramFieldAttribute)> _paramBitfieldPropertyCache;
 
         protected BaseParam(Pointer basePointer, ByteArrayMemory memory, long offset, ParamTableEntry paramTableEntry)
         {
             BasePointer = basePointer;
             Id = paramTableEntry.Id;
 
-            ParamFieldPropertyCache = GetType()
+            _paramFieldPropertyCache = GetType()
                 .GetProperties()
                 .Where(i => i.IsDefined(typeof(ParamFieldAttribute)))
                 .Select(i => (i, i.GetCustomAttribute<ParamFieldAttribute>()))
                 .OrderBy(i => i.Item2.Offset)
                 .ToList();
 
-            ParamBitfieldPropertyCache = GetType()
+            _paramBitfieldPropertyCache = GetType()
                 .GetProperties()
                 .Where(i => i.IsDefined(typeof(ParamBitFieldAttribute)))
                 .Select(i => (i, i.GetCustomAttribute<ParamBitFieldAttribute>()))
                 .ToList();
 
-            foreach (var field in ParamFieldPropertyCache)
+            foreach (var field in _paramFieldPropertyCache)
             {
                 var fieldOffset = offset + field.paramFieldAttribute.Offset;
                 var paramType = field.paramFieldAttribute.ParamType;
@@ -156,7 +156,7 @@ protected void WriteParamField<T>(ref T field, T value, [CallerMemberName] strin
 
         protected T GetbitfieldValue<T>(T field, [CallerMemberName] string propertyName = null)
         {
-            var bitfield = ParamBitfieldPropertyCache.First(i => i.propertyInfo.Name == propertyName);
+            var bitfield = _paramBitfieldPropertyCache.First(i => i.propertyInfo.Name == propertyName);
             var currentValue = (long)Convert.ChangeType(field, typeof(long));
 
             var bitIndex = 0;
@@ -176,7 +176,7 @@ protected T GetbitfieldValue<T>(T field, [CallerMemberName] string propertyName
 
         protected void SetBitfieldValue<T>(ref T field, T value, [CallerMemberName] string propertyName = null)
         {
-            var bitfield = ParamBitfieldPropertyCache.First(i => i.propertyInfo.Name == propertyName);
+            var bitfield = _paramBitfieldPropertyCache.First(i => i.propertyInfo.Name == propertyName);
             var currentValue = (long)Convert.ChangeType(field, typeof(long));
             var newValue = (long)Convert.ChangeType(value, typeof(long));
 

src/SoulMemory/Parameters/ParamClassGenerator.cs

@@ -213,7 +213,7 @@ private static List<BaseField> ParseFields(List<PreParsedField> preParsedFields)
                     currentBitfield.Bitfields.Add((currentField.Name, currentField.Bits.Value));
 
                     //Check if this is the last bitfield in this sequence
-                    if (nextField == null || nextField?.Bits == null)
+                    if (nextField?.Bits == null)
                     {
                         result.Add(currentBitfield);
                         currentBitfield = null;
@@ -275,7 +275,7 @@ private class BaseField
             public long Offset;
         }
 
-        private class Field : BaseField
+        private sealed class Field : BaseField
         {
             public Field(long offset, string name, ParamType paramType, int? arraySize = null)
             {
@@ -289,7 +289,7 @@ public Field(long offset, string name, ParamType paramType, int? arraySize = nul
             public int? ArraySize;
         }
 
-        private class Bitfield : BaseField
+        private sealed class Bitfield : BaseField
         {
             public Bitfield(long offset, ParamType paramType)
             {

src/SoulMemory/Parameters/ParamReader.cs

@@ -29,7 +29,6 @@ public static class ParamReader
     {
         public static List<TextTableEntry> GetTextTables(Pointer textBasePointer)
         {
-            //var dataOffset = textBasePointer.ReadUInt16(0x14);
             var rowCount = textBasePointer.ReadUInt16(0xc);
 
             var tableBytes = textBasePointer.ReadBytes(12 * rowCount, 0x18);
@@ -81,7 +80,6 @@ public static List<T> ReadParam<T>(Pointer paramBasePointer) where T : BaseParam
 
                 var rowBasePointer = paramBasePointer.Copy();
                 rowBasePointer.Offsets.Clear();
-                //var baseasdf = (IntPtr)paramBasePointer.ReadInt32();
                 rowBasePointer.BaseAddress = paramBasePointer.BaseAddress + dataOffset + i * rowSize;
 
                 parameters.Add(

src/SoulMemory/README.md

@@ -143,7 +143,6 @@ ScreenState GetScreenState();                        //Returns the current "scre
 bool IsBlackscreenActive();                          //Reads a combination of flags in memory to determine of a blackscreen is active
 List<Item> ReadInventory();                          //Reads the player's inventory. A part of the inventory seems stored in event flags (especially key-items) so be warned: some things might not be in this list
 void WriteInGameTimeMilliseconds(int milliseconds);  //Overwrite the game's in game time with a new value (used in blackscreen removal to create the illusion of a paused timer)
-void ResetIgt();                                     //Overwrite the game's in game time with 0 (used to prepare NG+ save files)
 ```
 
 ### Armored Core 6

src/SoulMemory/Sekiro/Sekiro.cs

@@ -106,11 +106,6 @@ private ResultErr<RefreshError> InitPointers()
                 }
 
                 ApplySavefileMods();
-
-                //Task.Run(() =>
-                //{
-                //    BitBlt = this.GetBitBlt(_files, _bitBltValues);
-                //});
 
                 return Result.Ok();
             }

src/SoulMemory/SoulMemory.csproj

@@ -33,7 +33,12 @@
     <WarningLevel>4</WarningLevel>
     <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
   </PropertyGroup>
-  <ItemGroup>
+    <ItemGroup>
+        <SonarQubeSetting Include="sonar.exclusions">
+            <Value>DarkSouls1\Parameters\*.cs</Value>
+        </SonarQubeSetting>
+    </ItemGroup>
+    <ItemGroup>
     <Compile Remove="resources\**" />
     <EmbeddedResource Remove="resources\**" />
     <None Remove="resources\**" />

src/SoulMemory/soulsmods/Soulsmods.cs

@@ -24,7 +24,7 @@
 
 namespace SoulMemory.soulsmods
 {
-    public class Soulsmods
+    public static class Soulsmods
     {
         public static void Inject(Process process)
         {