Fix memory leaks (#55)

* remove a lot of useless observables, cleanup code and comments

* remove static object manager since it isn't necessary any more

* remove commented out code

* rearrange some classes

Author: LeftofZen

AvaGui/Models/FileSystemItemGroup.cs

@@ -1,93 +1,9 @@
-using Avalonia.Data.Converters;
 using OpenLoco.ObjectEditor.Data;
 using OpenLoco.ObjectEditor.Objects;
-using System;
-using System.Collections.Generic;
 using System.Collections.ObjectModel;
-using System.Globalization;
 
 namespace AvaGui.Models
 {
-	public class ObjectTypeToMaterialIconConverter : IValueConverter
-	{
-		public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
-		{
-			if (Enum.TryParse<ObjectType>(value as string, out var objType) && ObjectMapping.TryGetValue(objType, out var objectIcon))
-			{
-				return objectIcon;
-			}
-
-			if (Enum.TryParse<VehicleType>(value as string, out var vehType) && VehicleMapping.TryGetValue(vehType, out var vehicleIcon))
-			{
-				return vehicleIcon;
-			}
-
-			if (value is SourceGame sourceType && SourceGameMapping.TryGetValue(sourceType, out var sourceIcon))
-			{
-				return sourceIcon;
-			}
-
-			return null;
-		}
-
-		public object? ConvertBack(object? value, Type targetType, object? parameter, CultureInfo culture)
-			=> throw new NotImplementedException();
-
-		public static Dictionary<ObjectType, string> ObjectMapping = new Dictionary<ObjectType, string>()
-		{
-			{ ObjectType.InterfaceSkin, "Monitor" },
-			{ ObjectType.Sound, "Speaker" },
-			{ ObjectType.Currency, "Cash" },
-			{ ObjectType.Steam, "Smoke" },
-			{ ObjectType.CliffEdge, "Landslide" },
-			{ ObjectType.Water, "Waves" },
-			{ ObjectType.Land, "Terrain" },
-			{ ObjectType.TownNames, "NoteText" },
-			{ ObjectType.Cargo, "ShippingPallet" },
-			{ ObjectType.Wall, "Wall" },
-			{ ObjectType.TrainSignal, "TrafficLight" },
-			{ ObjectType.LevelCrossing, "RailroadLight" },
-			{ ObjectType.StreetLight, "CeilingLight" },
-			{ ObjectType.Tunnel, "Tunnel" },
-			{ ObjectType.Bridge, "Bridge" },
-			{ ObjectType.TrainStation, "Domain" },
-			{ ObjectType.TrackExtra, "FenceElectric" },
-			{ ObjectType.Track, "Fence" },
-			{ ObjectType.RoadStation, "Monitor" },
-			{ ObjectType.RoadExtra, "RoadVariant" },
-			{ ObjectType.Road, "Road" },
-			{ ObjectType.Airport, "Airport" },
-			{ ObjectType.Dock, "Ferry" },
-			{ ObjectType.Vehicle, "PlaneTrain" },
-			{ ObjectType.Tree, "PineTreeVariant" },
-			{ ObjectType.Snow, "Snowflake" },
-			{ ObjectType.Climate, "WeatherPartlyCloudy" },
-			{ ObjectType.HillShapes, "Map" },
-			{ ObjectType.Building, "OfficeBuilding" },
-			{ ObjectType.Scaffolding, "Crane" },
-			{ ObjectType.Industry, "Factory" },
-			{ ObjectType.Region, "Earth" },
-			{ ObjectType.Competitor, "AccountTie" },
-			{ ObjectType.ScenarioText, "ScriptText" },
-		};
-
-		public static Dictionary<VehicleType, string> VehicleMapping = new Dictionary<VehicleType, string>()
-		{
-			{ VehicleType.Train, "Train" },
-			{ VehicleType.Bus, "Bus" },
-			{ VehicleType.Truck, "Truck" },
-			{ VehicleType.Tram, "Tram" },
-			{ VehicleType.Aircraft, "Airplane" },
-			{ VehicleType.Ship, "Sailboat" },
-		};
-
-		public static Dictionary<SourceGame, string> SourceGameMapping = new Dictionary<SourceGame, string>()
-		{
-			{ SourceGame.Custom, "AccountEdit" },
-			{ SourceGame.DataFile, "File" },
-			{ SourceGame.Vanilla, "AccountTieHat" },
-		};
-	}
 
 	public abstract record FileSystemItemBase(string Path, string Name, ObservableCollection<FileSystemItemBase>? SubNodes = null)
 	{

AvaGui/Models/IndexObjectHeader.cs

@@ -4,5 +4,5 @@
 
 namespace AvaGui.Models
 {
-	public record IndexObjectHeader(string Name, ObjectType ObjectType, SourceGame SourceGame, UInt32 Checksum, VehicleType? VehicleType);
+	public record IndexObjectHeader(string Name, ObjectType ObjectType, SourceGame SourceGame, uint32_t Checksum, VehicleType? VehicleType);
 }

AvaGui/Models/ObjectEditorModel.cs

@@ -20,13 +20,7 @@
 
 namespace AvaGui.Models
 {
-	public class VersionCheckBody
-	{
-		[JsonPropertyName("tag_name")]
-		public string TagName { get; set; }
-	}
-
-	public class ObjectEditorModel : ReactiveObject // todo: only viewmodels should be reactive
+	public class ObjectEditorModel
 	{
 		public EditorSettings Settings { get; private set; }
 
@@ -36,8 +30,6 @@ public class ObjectEditorModel : ReactiveObject // todo: only viewmodels should
 
 		public HeaderIndex HeaderIndex { get; private set; } = [];
 
-		public ObjectCache ObjectCache { get; private set; } = [];
-
 		public PaletteMap PaletteMap { get; set; }
 
 		public G1Dat? G1 { get; set; }
@@ -134,73 +126,57 @@ public void SaveSettings()
 			File.WriteAllText(SettingsFilePath, text);
 		}
 
-		public bool TryGetObject(string path, out UiLocoFile? uiLocoFile, bool reload = false)
+		public bool TryLoadObject(string filename, out UiLocoFile? uiLocoFile)
 		{
-			if (ObjectCache.TryGetValue(path, out var obj) && !reload)
+			if (string.IsNullOrEmpty(filename))
 			{
-				uiLocoFile = obj;
-				return true;
+				uiLocoFile = null;
+				return false;
 			}
-			else if (File.Exists(path))
+
+			(var fileInfo, var locoObject) = SawyerStreamReader.LoadFullObjectFromFile(filename, logger: Logger);
+
+			if (locoObject == null)
 			{
-				var loadResult = LoadSingleObjectFile(path, HeaderIndex, ObjectCache, out var _);
-				if (loadResult)
-				{
-					uiLocoFile = ObjectCache[path];
-					return true;
-				}
+				Logger?.Error($"Unable to load {filename}. FileInfo={fileInfo}");
+				uiLocoFile = null;
+				return false;
 			}
 
-			uiLocoFile = null;
-			return false;
+			uiLocoFile = new UiLocoFile() { DatFileInfo = fileInfo, LocoObject = locoObject };
+			return true;
 		}
 
 		// this method loads every single object entirely. it takes a long time to run
 		void CreateIndex(string[] allFiles, IProgress<float>? progress)
 		{
+			Logger?.Info($"Creating index on {allFiles.Length} files");
+
 			ConcurrentDictionary<string, IndexObjectHeader> ccHeaderIndex = new(); // key is full path/filename
-			ConcurrentDictionary<string, UiLocoFile> ccObjectCache = new(); // key is full path/filename
 
 			var count = 0;
-
 			ConcurrentDictionary<string, TimeSpan> timePerFile = new();
 
-			Logger?.Info($"Creating index on {allFiles.Length} files");
 			var sw = new Stopwatch();
 			sw.Start();
 
-			_ = Parallel.ForEach(allFiles, new ParallelOptions() { MaxDegreeOfParallelism = 16 }, (file) =>
-			//foreach (var file in allFiles)
-			{
-				try
-				{
-					var startTime = sw.Elapsed;
-					_ = LoadSingleObjectFile(file, ccHeaderIndex, ccObjectCache, out var fileInfo);
-					var elapsed = sw.Elapsed - startTime;
-
-					if (fileInfo != null)
-					{
-						_ = timePerFile.TryAdd(fileInfo.S5Header.Name, elapsed);
-					}
-				}
-				catch (Exception ex)
-				{
-					Logger?.Error($"Failed to load \"{file}\"", ex);
+			var fileCount = allFiles.Length;
+			var parallelise = false;
 
-					//var obj = SawyerStreamReader.LoadS5HeaderFromFile(file);
-					//var indexObjectHeader = new IndexObjectHeader(obj.Name, obj.ObjectType, obj.SourceGame, obj.Checksum, null);
-					//_ = ccHeaderIndex.TryAdd(file, indexObjectHeader);
-				}
-				finally
+			if (parallelise)
+			{
+				_ = Parallel.ForEach(allFiles, new ParallelOptions() { MaxDegreeOfParallelism = 16 }, (filename)
+					=> count = LoadAndIndexFile(count, filename));
+			}
+			else
+			{
+				foreach (var filename in allFiles)
 				{
-					_ = Interlocked.Increment(ref count);
-					progress?.Report(count / (float)allFiles.Length);
+					count = LoadAndIndexFile(count, filename);
 				}
-				//}
-			});
+			}
 
 			HeaderIndex = ccHeaderIndex.OrderBy(kvp => kvp.Key).ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
-			ObjectCache = ccObjectCache.OrderBy(kvp => kvp.Key).ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
 
 			sw.Stop();
 			Logger?.Info("Finished creating index");
@@ -219,39 +195,33 @@ void CreateIndex(string[] allFiles, IProgress<float>? progress)
 
 			var median = timePerFile.OrderBy(x => x.Value).Skip(timePerFile.Count / 2).Take(1).Single();
 			Logger?.Debug($"Median time={median.Value}ms");
-		}
 
-		private bool LoadSingleObjectFile(string file, IDictionary<string, IndexObjectHeader> ccHeaderIndex, IDictionary<string, UiLocoFile> ccObjectCache, out DatFileInfo? fileInfo)
-		{
-			(fileInfo, var locoObject) = SawyerStreamReader.LoadFullObjectFromFile(file, logger: Logger);
-
-			if (locoObject == null)
-			{
-				Logger?.Error($"Unable to load {file}. FileInfo={fileInfo}");
-				return false;
-			}
-
-			var newUiLocoFile = new UiLocoFile { DatFileInfo = fileInfo, LocoObject = locoObject };
-			if (!ccObjectCache.TryAdd(file, newUiLocoFile))
+			int LoadAndIndexFile(int count, string filename)
 			{
-				// replace the old file
-				ccObjectCache[file] = newUiLocoFile;
-			}
+				var startTime = sw.Elapsed;
+				var loadResult = TryLoadObject(filename, out var uiLocoFile);
+				var elapsed = sw.Elapsed - startTime;
 
-			VehicleType? veh = null;
-			if (locoObject.Object is VehicleObject vo)
-			{
-				veh = vo.Type;
-			}
+				if (loadResult && uiLocoFile != null)
+				{
+					_ = ccHeaderIndex.TryAdd(filename, new IndexObjectHeader(
+						uiLocoFile.DatFileInfo.S5Header.Name,
+						uiLocoFile.DatFileInfo.S5Header.ObjectType,
+						uiLocoFile.DatFileInfo.S5Header.SourceGame,
+						uiLocoFile.DatFileInfo.S5Header.Checksum,
+						uiLocoFile.LocoObject.Object is VehicleObject veh ? veh.Type : null));
+
+					_ = timePerFile.TryAdd(uiLocoFile.DatFileInfo.S5Header.Name, elapsed);
+				}
+				else
+				{
+					Logger?.Error($"Failed to load \"{filename}\"");
+				}
 
-			var indexObjectHeader = new IndexObjectHeader(fileInfo.S5Header.Name, fileInfo.S5Header.ObjectType, fileInfo.S5Header.SourceGame, fileInfo.S5Header.Checksum, veh);
-			if (!ccHeaderIndex.TryAdd(file, indexObjectHeader))
-			{
-				// replace the old file
-				ccHeaderIndex[file] = indexObjectHeader;
+				_ = Interlocked.Increment(ref count);
+				progress?.Report((float)count / fileCount);
+				return count;
 			}
-
-			return true;
 		}
 
 		public void SaveFile(string path, UiLocoFile obj)
@@ -384,25 +354,5 @@ static void SerialiseHeaderIndexToFile(string filename, HeaderIndex headerIndex,
 
 			return JsonSerializer.Deserialize<HeaderIndex>(json, GetOptions()) ?? [];
 		}
-
-		public UiLocoFile? LoadAndCacheObject(string filename)
-		{
-			if (string.IsNullOrEmpty(filename) || !filename.EndsWith(".dat", StringComparison.InvariantCultureIgnoreCase) || !File.Exists(filename))
-			{
-				return null;
-			}
-
-			if (ObjectCache.TryGetValue(filename, out var value))
-			{
-				return value;
-			}
-			else
-			{
-				var obj = SawyerStreamReader.LoadFullObjectFromFile(filename, logger: Logger);
-				var uiObj = new UiLocoFile { DatFileInfo = obj.DatFileInfo, LocoObject = obj.LocoObject };
-				_ = ObjectCache.TryAdd(filename, uiObj);
-				return uiObj;
-			}
-		}
 	}
 }