fixed an extremely tricky bug involving a variable assignment that changes BOTH the element in the prevOptions and currentOptions (use a breakpoint and carefully look between FileSwapper.cs line 258 and 263); the solution was to implement proper deep copying

Author: sharpjd

GPUPrefSwitcher/AppEntry.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Windows.Forms;
@@ -8,7 +9,7 @@ namespace GPUPrefSwitcher
     /// <summary>
     /// Represents an App Entry in the Registry along with the user's preferences.
     /// </summary>
-    public struct AppEntry
+    public struct AppEntry : ICloneable
     {
         public required string AppPath { get; init; }
 
@@ -44,6 +45,7 @@ readonly get
         public required bool SeenInRegistry { get; init; }
         public override readonly bool Equals(object obj)
         {
+            
             return obj is AppEntry entry &&
                    AppPath == entry.AppPath &&
                    AppName == entry.AppName &&
@@ -55,35 +57,69 @@ public override readonly bool Equals(object obj)
                    GPUPrefPluggedIn == entry.GPUPrefPluggedIn &&
                    RunOnBatteryPath == entry.RunOnBatteryPath &&
                    RunPluggedInPath == entry.RunPluggedInPath &&
-                   PendingAddToRegistry == entry.PendingAddToRegistry;
+                   PendingAddToRegistry == entry.PendingAddToRegistry &&
+                   SeenInRegistry == entry.SeenInRegistry &&
+                   SwapperStates.SequenceEqual(entry.SwapperStates);
+            
+
+            /*
+            bool yes = obj is AppEntry entry &&
+                   AppPath == entry.AppPath &&
+                   AppName == entry.AppName &&
+                   //appName == entry.appName && //breaks for some reason; null comparison with empty string... let's just exclude this since we're not using it for now
+                   EnableSwitcher == entry.EnableSwitcher &&
+                   EnableFileSwapper == entry.EnableFileSwapper &&
+                   FileSwapperPaths.SequenceEqual(entry.FileSwapperPaths) &&
+                   GPUPrefOnBattery == entry.GPUPrefOnBattery &&
+                   GPUPrefPluggedIn == entry.GPUPrefPluggedIn &&
+                   RunOnBatteryPath == entry.RunOnBatteryPath &&
+                   RunPluggedInPath == entry.RunPluggedInPath &&
+                   PendingAddToRegistry == entry.PendingAddToRegistry &&
+                   SeenInRegistry == entry.SeenInRegistry &&
+                   SwapperStates.SequenceEqual(entry.SwapperStates);
+
+            Logger.inst.Log($"Are the same: {yes}: {this} versus {(AppEntry)obj}");
+
+            return yes;
+            */
         }
 
         //Equals() is much faster
         public override readonly int GetHashCode()
         {
+
             int hashCode = -985154422;
             hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(AppPath);
-            //hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(appName); //see above comment for appName
+            //hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(appName); 
             hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(AppName);
             hashCode = hashCode * -1521134295 + EnableSwitcher.GetHashCode();
             hashCode = hashCode * -1521134295 + EnableFileSwapper.GetHashCode();
-            hashCode = hashCode * -1521134295 + GetStringArrHash(FileSwapperPaths);
-            hashCode = hashCode * -1521134295 + GetStringArrHash(FileSwapperPaths);
+            hashCode = hashCode * -1521134295 + GetArrHash(FileSwapperPaths);
+            hashCode = hashCode * -1521134295 + GetArrHash(FileSwapperPaths);
             hashCode = hashCode * -1521134295 + GPUPrefOnBattery.GetHashCode();
             hashCode = hashCode * -1521134295 + GPUPrefPluggedIn.GetHashCode();
             hashCode = hashCode * -1521134295 + RunOnBatteryPath.GetHashCode();
             hashCode = hashCode * -1521134295 + RunPluggedInPath.GetHashCode();
             hashCode = hashCode * -1521134295 + PendingAddToRegistry.GetHashCode();
+            hashCode = hashCode * -1521134295 + SeenInRegistry.GetHashCode();
+            hashCode = hashCode * -1521134295 + GetArrHash(from s in SwapperStates select s.ToString()); //a bit hacky but it should work
+
             //TODO: need for AppName
             return hashCode;
         }
 
-        public static int GetStringArrHash(string[] strings)
+        public static int GetArrHash(IEnumerable<object> objs)
         {
             int hash = -335392656;
-            for (int i = 0; i < strings.Length; i++)
+            /*
+            for (int i = 0; i < objs.Length; i++)
+            {
+                hash = hash * -130699793 + objs[i].GetHashCode();
+            }
+            */
+            foreach(object obj in objs)
             {
-                hash = hash * -130699793 + strings[i].GetHashCode();
+                hash = hash * -130699793 + obj.GetHashCode();
             }
             return hash;
         }
@@ -93,6 +129,7 @@ public override string ToString()
             StringBuilder sb = new();
             sb.AppendLine($"AppEntry (enabled: {EnableSwitcher}; appname: {AppName}): {AppPath}");
             sb.AppendLine($"On Battery: {GPUPrefOnBattery}; Plugged in: On Battery: {GPUPrefPluggedIn}");
+            sb.AppendLine($"Pending add: {PendingAddToRegistry}");
             sb.AppendLine($"File swapper (enabled: {EnableFileSwapper}):");
             for (int i = 0; i < FileSwapperPaths.Length; i++)
             {
@@ -101,6 +138,25 @@ public override string ToString()
             return sb.ToString();
         }
 
+        public object Clone()
+        {
+            return new AppEntry()
+            {
+                AppPath = AppPath,
+                AppName = AppName,
+                EnableSwitcher = EnableSwitcher,
+                EnableFileSwapper = EnableFileSwapper,
+                FileSwapperPaths = (from s in FileSwapperPaths select s).ToArray(),
+                GPUPrefOnBattery = GPUPrefOnBattery,
+                GPUPrefPluggedIn = GPUPrefPluggedIn,
+                RunOnBatteryPath = RunOnBatteryPath,
+                RunPluggedInPath = RunPluggedInPath,
+                PendingAddToRegistry = PendingAddToRegistry,
+                SeenInRegistry = SeenInRegistry,
+                SwapperStates = (from s in SwapperStates select s).ToArray(),
+            };
+        }
+
         public static bool operator ==(AppEntry left, AppEntry right)
         {
             return left.Equals(right);

GPUPrefSwitcher/AppEntrySaveHandler.cs

@@ -15,6 +15,21 @@ public class AppEntrySaveHandler
         /// !!! This should always contain deep copies !!!
         /// </summary>
         private List<AppEntry> prevAppEntries;
+        /*
+        private List<AppEntry> prevAppEntries
+        {
+            get
+            {
+                return prevAppEntries_;
+            }
+            set
+            {
+                Logger.inst.Log("Set PrevAppEntries");
+                prevAppEntries_ = value;
+            }
+        }
+        private List<AppEntry> prevAppEntries_;
+        */
 
         public List<AppEntry> CurrentAppEntries
         {
@@ -29,17 +44,33 @@ public void RevertAppEntriesToPrevious()
         {
             try
             {
+                semaphoreSlim.Wait();
                 currentAppEntries = DeepCopyAppEntries(prevAppEntries);
             } finally
             {
-                semaphoreSlim.Wait();
+                semaphoreSlim.Release();
             }
         }
         private static List<AppEntry> DeepCopyAppEntries(List<AppEntry> appEntries)
         {
-            AppEntry[] appEntryCopies = appEntries.ToArray();
+            /*
+            //AppEntry[] appEntryCopies = appEntries.ToArray();
+
+            var appEntryCopies = new AppEntry[appEntries.Count()];
+            for(int i = 0; i < appEntryCopies.Length; i++)
+            {
+                appEntryCopies[i] = appEntries[i]; //struct copy 
+            }
+
             List<AppEntry> newList = new();
             newList.AddRange(appEntryCopies);
+            */
+            List<AppEntry> newList = new();
+            foreach(AppEntry a in appEntries)
+            {
+                newList.Add((AppEntry)a.Clone());
+            }
+
             return newList;
         }
 
@@ -49,10 +80,22 @@ private static List<AppEntry> DeepCopyAppEntries(List<AppEntry> appEntries)
 
         public AppEntrySaveHandler()
         {
-            PreferencesXML = new PreferencesXML();
-            prevAppEntries = PreferencesXML.GetAppEntries();
-            currentAppEntries = PreferencesXML.GetAppEntries();
-            semaphoreSlim = new SemaphoreSlim(1);
+            try
+            {
+                semaphoreSlim = new SemaphoreSlim(1);
+
+                semaphoreSlim.Wait();
+
+                PreferencesXML = new PreferencesXML();
+                prevAppEntries = PreferencesXML.GetAppEntries();
+                //currentAppEntries = PreferencesXML.GetAppEntries();
+                currentAppEntries = DeepCopyAppEntries(prevAppEntries);
+
+            } finally { semaphoreSlim.Release(); }
+            
+
+            Logger.inst.Log(currentAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+            Logger.inst.Log(prevAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
         }
 
         public void ChangeAppEntryByPath(string path, AppEntry updatedAppEntry)
@@ -61,7 +104,10 @@ public void ChangeAppEntryByPath(string path, AppEntry updatedAppEntry)
             {
                 semaphoreSlim.Wait();
 
+                Logger.inst.Log($"prev: {CurrentAppEntries[CurrentAppEntries.IndexOf(CurrentAppEntries.Single(x => x.AppPath == path))]}");
+
                 int index = CurrentAppEntries.IndexOf(CurrentAppEntries.Single(x => x.AppPath == path));
+                
 
                 /* //for-loop alternative, but the above should throw an error with an obvious enough meaning
                 int index = -1;
@@ -79,8 +125,11 @@ public void ChangeAppEntryByPath(string path, AppEntry updatedAppEntry)
                 */
 
                 CurrentAppEntries[index] = updatedAppEntry;
+
+                Logger.inst.Log($"new: {CurrentAppEntries[CurrentAppEntries.IndexOf(CurrentAppEntries.Single(x => x.AppPath == path))]}");
             } finally
             {
+                Logger.inst.Log("ChangeAppEntryByPath released a semaphore.");
                 semaphoreSlim.Release();
             }
         }
@@ -104,6 +153,8 @@ public void SaveAppEntryChanges()
             {
                 semaphoreSlim.Wait();
 
+                //Logger.inst.Log(currentAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+                //Logger.inst.Log(prevAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
                 List<AppEntry> differences = new();
                 differences.AddRange(currentAppEntries.Where(entry => NotSameOrInPrevAppEntries(entry)));
 
@@ -141,10 +192,21 @@ public void SaveAppEntryChanges()
 
                 prevAppEntries = DeepCopyAppEntries(currentAppEntries); //update the saved entries
 
-                Logger.inst.Log("Concluded saving");
+                //Logger.inst.Log(currentAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+                //Logger.inst.Log(prevAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+
+                Logger.inst.Log($"Concluded saving. Differences: {differences.Count} Added: {needToAdd.Count} Removed: {needToRemoveFromXML.Count}");
 
                 bool NotSameOrInPrevAppEntries(AppEntry appEntry)
                 {
+                    /*
+                    if (appEntry.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe")
+                    {
+                        Logger.inst.Log(prevAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+                        Logger.inst.Log(CurrentAppEntries.Single(x => x.AppPath == "F:\\SteamLibrary\\steamapps\\common\\Apex Legends\\r5apex.exe").ToString());
+                        Logger.inst.Log($"{appEntry} not in prev app entries: {!prevAppEntries.Contains(appEntry)}");
+                    }
+                    */
                     return !prevAppEntries.Contains(appEntry); //Contains uses Equals() which is implemented in AppEntry
                 }
             } finally

GPUPrefSwitcher/Switcher.cs

@@ -43,15 +43,18 @@ public static class Switcher
         /// </summary>
         internal static void Start()
         {
+            appOptions = new AppOptions();
+            Logger.inst.EnableRealtimeStandardLogWrites = appOptions.CurrentOptions.EnableRealtimeLogging;
+            Logger.inst.Log($"Initialized {nameof(AppOptions)}.");
+
             switcherData = SwitcherData.Initialize();
             Logger.inst.Log($"Initialized {nameof(SwitcherData)}.");
 
             appEntrySaveHandler = new AppEntrySaveHandler(); //exceptions get thrown from this too if there are problems with the XML (e.g. syntax)
-            Logger.inst.Log($"Initialized {nameof(PreferencesXML)}.");
+            Logger.inst.Log($"Initialized {nameof(AppEntrySaveHandler)}.");
 
             //SystemEvents.PowerModeChanged += HandlePowerChangeEvent; **NOT the right event, this is for resume/suspend
-            appOptions = new AppOptions();
-            Logger.inst.Log($"Initialized {nameof(AppOptions)}.");
+            
 
             prevPowerLineStatus = switcherData.CurrentSwitcherData.PrevPowerStatus_enum;
             spoofPowerStateEnabled = appOptions.CurrentOptions.SpoofPowerStateEnabled;
@@ -64,7 +67,6 @@ internal static void Start()
             switcherData.SaveToXML();
 
             updateInterval = appOptions.CurrentOptions.UpdateInterval;
-            Logger.inst.EnableRealtimeStandardLogWrites = appOptions.CurrentOptions.EnableRealtimeLogging;
 
             File.Delete(CRASHED_FILE_PATH);//"successful" initialization yippee