Core: Code cleanup, diffable-cs improvements

SamboyCoding · Jul 23, 2024 · a227bef · a227bef
1 parent c720a52
commit a227bef
Show file tree

Hide file tree

Showing 12 changed files with 111 additions and 98 deletions.
diff --git a/Cpp2IL.Core.Tests/AccessibilityUtilsTests.cs → ...ore.Tests/AccessibilityExtensionsTests.cs b/Cpp2IL.Core.Tests/AccessibilityUtilsTests.cs → ...ore.Tests/AccessibilityExtensionsTests.cs
@@ -1,10 +1,10 @@
 using System.Linq;
+using Cpp2IL.Core.Extensions;
 using Cpp2IL.Core.Model.Contexts;
-using Cpp2IL.Core.Utils;
 
 namespace Cpp2IL.Core.Tests;
 
-public class AccessibilityUtilsTests
+public class AccessibilityExtensionsTests
 {
     [Test]
     public void AccessibilityTests()

diff --git a/Cpp2IL.Core/Cpp2IlApi.cs b/Cpp2IL.Core/Cpp2IlApi.cs
@@ -1,11 +1,8 @@
 using System;
-using System.Collections.Generic;
-using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
+using System.Runtime.CompilerServices;
 using AssetRipper.Primitives;
 using Cpp2IL.Core.Exceptions;
 using Cpp2IL.Core.Logging;
@@ -14,6 +11,8 @@
 using LibCpp2IL;
 using LibCpp2IL.Logging;
 
+[assembly: InternalsVisibleTo("Cpp2IL.Core.Tests")]
+
 namespace Cpp2IL.Core
 {
     public static class Cpp2IlApi

diff --git a/Cpp2IL.Core/Utils/AccessibilityUtils.cs → ...ore/Extensions/AccessibilityExtensions.cs b/Cpp2IL.Core/Utils/AccessibilityUtils.cs → ...ore/Extensions/AccessibilityExtensions.cs
@@ -5,9 +5,9 @@
 using Cpp2IL.Core.Model.Contexts;
 using LibCpp2IL.Metadata;
 
-namespace Cpp2IL.Core.Utils;
+namespace Cpp2IL.Core.Extensions;
 
-public static class AccessibilityUtils
+internal static class AccessibilityExtensions
 {
     public static bool IsAccessibleTo(this TypeAnalysisContext referenceType, TypeAnalysisContext referencingType)
     {

diff --git a/Cpp2IL.Core/Extensions/EnumerableExtensions.cs b/Cpp2IL.Core/Extensions/EnumerableExtensions.cs
@@ -0,0 +1,69 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Cpp2IL.Core.Extensions;
+
+internal static class EnumerableExtensions
+{
+    public static IEnumerable<T> MaybeAppend<T>(this IEnumerable<T> enumerable, T? item) where T : struct
+    {
+        if (item is not null)
+        {
+            return enumerable.Append(item.Value);
+        }
+
+        return enumerable;
+    }
+
+    public static MemoryEnumerable<T> AsEnumerable<T>(this Memory<T> memory) => new(memory);
+
+    public static MemoryEnumerator<T> GetEnumerator<T>(this Memory<T> memory) => new(memory);
+
+    public class MemoryEnumerable<T> : IEnumerable<T>
+    {
+        private readonly Memory<T> _memory;
+
+        public MemoryEnumerable(Memory<T> memory)
+        {
+            _memory = memory;
+        }
+
+        public IEnumerator<T> GetEnumerator() => new MemoryEnumerator<T>(_memory);
+
+        IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
+    }
+
+    public class MemoryEnumerator<T> : IEnumerator<T>
+    {
+        private readonly Memory<T> _memory;
+
+        private int _index = -1;
+
+        public MemoryEnumerator(Memory<T> memory)
+        {
+            _memory = memory;
+        }
+
+        public bool MoveNext()
+        {
+            _index++;
+            return _index < _memory.Length;
+        }
+
+        public void Reset()
+        {
+            _index = -1;
+        }
+
+        public T Current => _memory.Span[_index];
+
+        object? IEnumerator.Current => Current;
+
+        public void Dispose()
+        {
+            // Nothing to dispose
+        }
+    }
+}
diff --git a/Cpp2IL.Core/Extensions/MiscExtensions.cs b/Cpp2IL.Core/Extensions/MiscExtensions.cs
@@ -1,6 +1,6 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Text;
 using Cpp2IL.Core.ISIL;
@@ -167,5 +167,17 @@ public static unsafe uint ReadUInt(this Span<byte> span, int start)
             fixed (byte* ptr = &span[start])
                 return *(uint*)ptr;
         }
+
+        public static bool BitsAreEqual(this BitArray first, BitArray second)
+        {
+            if (first.Count != second.Count)
+                return false;
+
+            bool areDifferent = false;
+            for (int i = 0; i < first.Count && !areDifferent; i++)
+                areDifferent =  first.Get(i) != second.Get(i);
+
+            return !areDifferent;
+        }
     }
 }
diff --git a/Cpp2IL.Core/Extensions/StringExtensions.cs b/Cpp2IL.Core/Extensions/StringExtensions.cs
@@ -0,0 +1,13 @@
+namespace Cpp2IL.Core.Extensions;
+
+public static class StringExtensions
+{
+    public static string EscapeString(this string str)
+        => str
+            .Replace("\\", @"\\")
+            .Replace("\"", "\\\"")
+            .Replace("\n", "\\n")
+            .Replace("\r", "\\r")
+            .Replace("\t", "\\t")
+            .Replace("\0", "\\0");
+}
diff --git a/Cpp2IL.Core/Model/CustomAttributes/CustomAttributePrimitiveParameter.cs b/Cpp2IL.Core/Model/CustomAttributes/CustomAttributePrimitiveParameter.cs
@@ -96,7 +96,7 @@ public override void ReadFromV29Blob(BinaryReader reader, ApplicationAnalysisCon
     public override string ToString()
     {
         if(PrimitiveValue is string s)
-            return $"\"{s}\"";
+            return $"\"{s.EscapeString()}\"";
 
         return PrimitiveValue?.ToString(CultureInfo.InvariantCulture) ?? "null";
     }

diff --git a/Cpp2IL.Core/OldGraphs/InstructionGraph.cs b/Cpp2IL.Core/OldGraphs/InstructionGraph.cs
@@ -4,8 +4,8 @@
 using System.Collections.ObjectModel;
 using System.Linq;
 using System.Text;
+using Cpp2IL.Core.Extensions;
 using Cpp2IL.Core.Il2CppApiFunctions;
-using Cpp2IL.Core.Utils;
 using Iced.Intel;
 
 namespace Cpp2IL.Core.Graphs;
@@ -509,4 +509,4 @@ public string Print(bool instructions = false)
     public List<IControlFlowNode> INodes => Nodes.Cast<IControlFlowNode>().ToList();
 
     public int Count => nodeSet.Count;
-}
+}
diff --git a/Cpp2IL.Core/OutputFormats/DiffableCsOutputFormat.cs b/Cpp2IL.Core/OutputFormats/DiffableCsOutputFormat.cs
@@ -190,12 +190,12 @@ private static void AppendField(StringBuilder sb, FieldAnalysisContext field, in
         sb.Append("; //Field offset: 0x");
         sb.Append(field.Offset.ToString("X"));
 
-        if ((field.Attributes & FieldAttributes.HasFieldRVA) != 0)
+        if ((field.Attributes & FieldAttributes.HasFieldRVA) != 0 && field.BackingData != null)
         {
-            sb.Append(" || Has Field RVA: 0x");
-            var (dataIndex, _) = LibCpp2IlMain.TheMetadata!.GetFieldDefaultValue(field.BackingData!.Field.FieldIndex);
-            var pointer = LibCpp2IlMain.TheMetadata!.GetDefaultValueFromIndex(dataIndex);
-            sb.Append(pointer.ToString("X8"));
+            sb.Append(" || Has Field RVA (address hidden for diffability)");
+            // var (dataIndex, _) = LibCpp2IlMain.TheMetadata!.GetFieldDefaultValue(field.BackingData.Field.FieldIndex);
+            // var pointer = LibCpp2IlMain.TheMetadata!.GetDefaultValueFromIndex(dataIndex);
+            // sb.Append(pointer.ToString("X8"));
 
             var actualValue = field.BackingData.Field.StaticArrayInitialValue;
             if (actualValue is { Length: > 0 })

diff --git a/Cpp2IL.Core/ProcessingLayers/CallAnalysisProcessingLayer.cs b/Cpp2IL.Core/ProcessingLayers/CallAnalysisProcessingLayer.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Reflection;
 using Cpp2IL.Core.Api;
+using Cpp2IL.Core.Extensions;
 using Cpp2IL.Core.ISIL;
 using Cpp2IL.Core.Model.Contexts;
 using Cpp2IL.Core.Utils;

diff --git a/Cpp2IL.Core/Utils/EnumerableExtensions.cs b/Cpp2IL.Core/Utils/EnumerableExtensions.cs
diff --git a/Cpp2IL.Core/Utils/MiscUtils.cs b/Cpp2IL.Core/Utils/MiscUtils.cs
@@ -225,18 +225,6 @@ public static ulong GetAddressOfNextFunctionStart(ulong current)
             return ret;
         }
 
-        public static bool BitsAreEqual(this BitArray first, BitArray second)
-        {
-            if (first.Count != second.Count)
-                return false;
-
-            bool areDifferent = false;
-            for (int i = 0; i < first.Count && !areDifferent; i++)
-                areDifferent =  first.Get(i) != second.Get(i);
-
-            return !areDifferent;
-        }
-
         public static void ExecuteSerial<T>(IEnumerable<T> enumerable, Action<T> what)
         {
             foreach (var item in enumerable)
@@ -317,55 +305,5 @@ public static string CleanPathElement(string input)
 
             return InvalidPathElements.Contains(input) ? $"__invalidwin32name_{input}__" : input;
         }
-
-        public static MemoryEnumerator<T> GetEnumerator<T>(this Memory<T> memory) => new(memory);
-
-        public static MemoryEnumerable<T> AsEnumerable<T>(this Memory<T> memory) => new(memory);
-
-        public class MemoryEnumerable<T> : IEnumerable<T>
-        {
-            private readonly Memory<T> _memory;
-
-            public MemoryEnumerable(Memory<T> memory)
-            {
-                _memory = memory;
-            }
-
-            public IEnumerator<T> GetEnumerator() => new MemoryEnumerator<T>(_memory);
-
-            IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
-        }
-
-        public class MemoryEnumerator<T> : IEnumerator<T>
-        {
-            private readonly Memory<T> _memory;
-
-            private int _index = -1;
-
-            public MemoryEnumerator(Memory<T> memory)
-            {
-                _memory = memory;
-            }
-
-            public bool MoveNext()
-            {
-                _index++;
-                return _index < _memory.Length;
-            }
-
-            public void Reset()
-            {
-                _index = -1;
-            }
-
-            public T Current => _memory.Span[_index];
-
-            object? IEnumerator.Current => Current;
-
-            public void Dispose()
-            {
-                // Nothing to dispose
-            }
-        }
     }
 }