started major refactor

artyredd · artyredd · commit d4c92a3b34d5 · 2022-03-16T06:12:54.000-04:00
diff --git a/MiniMapLibrary/Config/Interfaces/IConfig.cs b/MiniMapLibrary/Config/Interfaces/IConfig.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace MiniMapLibrary.Interfaces
+namespace MiniMapLibrary.Config
 {
     public interface IConfig
     {
diff --git a/MiniMapLibrary/Config/Interfaces/IConfigEntry.cs b/MiniMapLibrary/Config/Interfaces/IConfigEntry.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace MiniMapLibrary.Interfaces
+namespace MiniMapLibrary.Config
 {
     public interface IConfigEntry<T>
     {
diff --git a/MiniMapLibrary/Config/Interfaces/ISettingConfigGroup.cs b/MiniMapLibrary/Config/Interfaces/ISettingConfigGroup.cs
@@ -1,10 +1,9 @@
-﻿using MiniMapLibrary.Interfaces;
-using System;
+﻿using System;
 using System.Collections.Generic;
 using System.Text;
 using UnityEngine;
 
-namespace MiniMapMod.wrappers
+namespace MiniMapLibrary.Config
 {
     public interface ISettingConfigGroup
     {
diff --git a/MiniMapLibrary/Config/SettingConfigGroup.cs b/MiniMapLibrary/Config/SettingConfigGroup.cs
@@ -1,11 +1,11 @@
 ﻿using MiniMapLibrary;
-using MiniMapLibrary.Interfaces;
+using MiniMapLibrary.Config;
 using System;
 using System.Collections.Generic;
 using System.Text;
 using UnityEngine;
 
-namespace MiniMapMod.wrappers
+namespace MiniMapLibrary.Config
 {
     public class SettingConfigGroup : ISettingConfigGroup
     {
diff --git a/MiniMapLibrary/Config/wrappers/StubConfigEntry.cs b/MiniMapLibrary/Config/wrappers/StubConfigEntry.cs
@@ -1,9 +1,8 @@
-﻿using MiniMapLibrary.Interfaces;
-using System;
+﻿using System;
 using System.Collections.Generic;
 using System.Text;
 
-namespace MiniMapLibrary
+namespace MiniMapLibrary.Config
 {
     public class StubConfigEntry<T> : IConfigEntry<T>
     {
diff --git a/MiniMapLibrary/Interactible/InteractibleSetting.cs b/MiniMapLibrary/Interactible/InteractibleSetting.cs
@@ -1,5 +1,4 @@
-﻿using MiniMapLibrary.Interfaces;
-using MiniMapMod.wrappers;
+﻿using MiniMapLibrary.Config;
 using System;
 using System.Collections.Generic;
 using System.Text;
diff --git a/MiniMapLibrary/Interfaces/ILogger.cs b/MiniMapLibrary/Interfaces/ILogger.cs
@@ -0,0 +1,17 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary
+{
+    public interface ILogger
+    {
+        void LogDebug(object data);
+        void LogError(object data);
+        void LogFatal(object data);
+        void LogInfo(object data);
+        void LogMessage(object data);
+        void LogWarning(object data);
+        void LogException(Exception head, string message = "");
+    }
+}
diff --git a/MiniMapLibrary/Interfaces/ISpriteManager.cs b/MiniMapLibrary/Interfaces/ISpriteManager.cs
diff --git a/MiniMapLibrary/MiniMapLibrary.csproj b/MiniMapLibrary/MiniMapLibrary.csproj
@@ -8,4 +8,16 @@
 		<PackageReference Include="Unity3D" Version="1.7.0" />
 	</ItemGroup>
 
+	<ItemGroup>
+	  <Reference Include="UnityEngine">
+	    <HintPath>..\MiniMapMod\libs\UnityEngine.dll</HintPath>
+	  </Reference>
+		<Reference Include="UnityEngine">
+			<HintPath>..\MiniMapMod\libs\UnityEngine.CoreModule.dll</HintPath>
+		</Reference>
+		<Reference Include="UnityEngine.UI">
+		  <HintPath>..\MiniMapMod\libs\UnityEngine.UI.dll</HintPath>
+		</Reference>
+	</ItemGroup>
+
 </Project>
diff --git a/MiniMapLibrary/Scanner/DefaultSorter.cs b/MiniMapLibrary/Scanner/DefaultSorter.cs
@@ -0,0 +1,22 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+#nullable enable
+namespace MiniMapLibrary.Scanner
+{
+    public class DefaultSorter<T> : ISorter<T>
+    {
+        public InteractableKind Kind { get; set; }
+
+        private readonly Func<T, bool>? selector;
+
+        public DefaultSorter(InteractableKind kind, Func<T, bool>? selector = null)
+        {
+            Kind = kind;
+            this.selector = selector;
+        }
+
+        public bool IsKind(T value) => selector?.Invoke(value) ?? false;
+    }
+}
diff --git a/MiniMapLibrary/Scanner/Interfaces/IInteractibleSorter.cs b/MiniMapLibrary/Scanner/Interfaces/IInteractibleSorter.cs
@@ -0,0 +1,17 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary.Scanner
+{
+    public interface IInteractibleSorter<T>
+    {
+        /// <summary>
+        /// Attempts to find the applicable <see cref="InteractableKind"/> that the provided instance
+        /// of <see cref="T"/> should be considered
+        /// </summary>
+        /// <param name="objectToBeSorted"></param>
+        /// <returns></returns>
+        bool TrySort(T objectToBeSorted, out InteractableKind kind);
+    }
+}
diff --git a/MiniMapLibrary/Scanner/Interfaces/IScanner.cs b/MiniMapLibrary/Scanner/Interfaces/IScanner.cs
@@ -0,0 +1,15 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary.Scanner
+{
+    public interface IScanner<T>
+    {
+        /// <summary>
+        /// Scans the scene and returns all instances of the type
+        /// </summary>
+        /// <returns></returns>
+        IEnumerable<T> Scan();
+    }
+}
diff --git a/MiniMapLibrary/Scanner/Interfaces/ISorter.cs b/MiniMapLibrary/Scanner/Interfaces/ISorter.cs
@@ -0,0 +1,18 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary.Scanner
+{
+    public interface ISorter<T>
+    {
+        InteractableKind Kind { get; }
+
+        /// <summary>
+        /// Checks to see if the value should be of Kind
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns>true when the provided <paramref name="value"/> should be <see cref="Kind"/></returns>
+        bool IsKind(T value);
+    }
+}
diff --git a/MiniMapLibrary/Scanner/Interfaces/ITrackedObject.cs b/MiniMapLibrary/Scanner/Interfaces/ITrackedObject.cs
@@ -1,7 +1,7 @@
 ﻿using MiniMapLibrary;
 using UnityEngine;
 
-namespace MiniMapMod
+namespace MiniMapLibrary.Scanner
 {
     public interface ITrackedObject
     {
diff --git a/MiniMapLibrary/Scanner/MonoBehaviorScanner.cs b/MiniMapLibrary/Scanner/MonoBehaviorScanner.cs
@@ -0,0 +1,39 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using UnityEngine;
+
+#nullable enable
+namespace MiniMapLibrary.Scanner
+{
+    public class MonoBehaviorScanner<T> : IScanner<T> where T : MonoBehaviour
+    {
+        private readonly ILogger logger;
+
+        public MonoBehaviorScanner(ILogger logger)
+        {
+            this.logger = logger;
+
+            this.logger.LogDebug($"Created {nameof(MonoBehaviorScanner<T>)}<{typeof(T).FullName}>");
+        }
+
+        public IEnumerable<T> Scan()
+        {
+            IEnumerable<T>? found = GameObject.FindObjectsOfType(typeof(T))?.Select(x => (T)x);
+
+            if (found is null)
+            {
+                logger.LogDebug($"Failed to find any objects with type {typeof(T).FullName}s");
+            }
+            else 
+            {
+                logger.LogDebug($"Found {found.Count()} objects with type {typeof(T).FullName}s");
+            }
+
+            // never return a null list, caller should always assume a list will
+            // be provided regardless if nothing is found
+            return found ?? new List<T>();
+        }
+    }
+}
diff --git a/MiniMapLibrary/Scanner/MonoBehaviourSorter.cs b/MiniMapLibrary/Scanner/MonoBehaviourSorter.cs
@@ -0,0 +1,33 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary.Scanner
+{
+    public class MonoBehaviourSorter<T> : IInteractibleSorter<T>
+    {
+        private readonly ISorter<T>[] sorters;
+
+        public MonoBehaviourSorter(ISorter<T>[] sorters)
+        {
+            this.sorters = sorters;
+        }
+
+        public bool TrySort(T value, out InteractableKind kind)
+        {
+            kind = InteractableKind.none;
+
+            // for eah nicer looking but slghtly slower
+            foreach (ISorter<T> sorter in sorters)
+            {
+                if (sorter.IsKind(value))
+                {
+                    kind = sorter.Kind;
+                    return true;
+                }
+            }
+
+            return false;
+        }
+    }
+}
diff --git a/MiniMapLibrary/Scanner/ScanType.cs b/MiniMapLibrary/Scanner/ScanType.cs
@@ -0,0 +1,13 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MiniMapLibrary.Scanner
+{
+    public enum ScanType
+    { 
+        none,
+        MonoBehavior,
+        Tag
+    }
+}
diff --git a/MiniMapLibrary/Scanner/TagScanner.cs b/MiniMapLibrary/Scanner/TagScanner.cs
@@ -0,0 +1,39 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using UnityEngine;
+
+#nullable enable
+namespace MiniMapLibrary.Scanner
+{
+    public class TagScanner : IScanner<GameObject>
+    {
+        private readonly string targetTag;
+        private readonly ILogger logger;
+
+        public TagScanner(InteractableKind kind, bool dynamic, string tag, ILogger logger, Func<GameObject, bool>? selector = null, Func<GameObject, bool>? activeChecker = null)
+        {
+            this.targetTag = tag;
+            this.logger = logger;
+
+            logger.LogDebug($"Created {nameof(TagScanner)} for tag {tag}");
+        }
+
+        public IEnumerable<GameObject> Scan()
+        {
+            IEnumerable<GameObject>? found = GameObject.FindGameObjectsWithTag(targetTag);
+
+            if (found is null)
+            {
+                logger.LogDebug($"Failed to find any objects with tag {targetTag}");
+            }
+            else
+            {
+                logger.LogDebug($"Found {found.Count()} objects with tag {targetTag}");
+            }
+
+            return found ?? new List<GameObject>();
+        }
+    }
+}
diff --git a/MiniMapLibrary/Scanner/TrackedObject.cs b/MiniMapLibrary/Scanner/TrackedObject.cs
@@ -4,8 +4,9 @@
 using System.Text;
 using UnityEngine;
 using UnityEngine.UI;
+using MiniMapLibrary.Scanner;
 
-namespace MiniMapMod
+namespace MiniMapLibrary.Scanner
 {
     public class TrackedObject<T> : ITrackedObject
     {
@@ -49,7 +50,9 @@ public void Destroy()
             }
             catch (Exception)
             {
-
+                // intentionally eat the exception while trying to destroy the gameobject
+                // if other mods or the scene destroys the UI we dont want to throw exceptions
+                // this is expected
             }
         }
 
@@ -63,6 +66,9 @@ public void CheckActive()
                 }
                 catch (Exception)
                 {
+                    // intentionally eat the exception while trying to destroy the gameobject
+                    // if other mods or the scene destroys the UI we dont want to throw exceptions
+                    // this is expected
                     Active = false;
                 }
 
diff --git a/MiniMapLibrary/Settings.cs b/MiniMapLibrary/Settings.cs
@@ -1,5 +1,4 @@
-﻿using MiniMapLibrary.Interfaces;
-using MiniMapMod.wrappers;
+﻿using MiniMapLibrary.Config;
 using System;
 using System.Collections.Generic;
 using System.Linq;
diff --git a/MiniMapLibrary/Sprites/SpriteManager.cs b/MiniMapLibrary/Sprites/SpriteManager.cs
diff --git a/MiniMapMod/Adapters/ConfigAdapter.cs b/MiniMapMod/Adapters/ConfigAdapter.cs
@@ -1,7 +1,7 @@
 ﻿using System;
 using System.Collections.Generic;
 using System.Text;
-using MiniMapLibrary.Interfaces;
+using MiniMapLibrary.Config;
 using BepInEx.Configuration;
 using BepInEx;
 
diff --git a/MiniMapMod/Adapters/ConfigEntryAdapter.cs b/MiniMapMod/Adapters/ConfigEntryAdapter.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Text;
 using BepInEx.Configuration;
-using MiniMapLibrary.Interfaces;
+using MiniMapLibrary.Config;
 
 namespace MiniMapMod.Adapters
 {
diff --git a/MiniMapMod/Log.cs b/MiniMapMod/Log.cs
diff --git a/MiniMapMod/MiniMapMod.csproj b/MiniMapMod/MiniMapMod.csproj
diff --git a/MiniMapMod/MiniMapPlugin.cs b/MiniMapMod/MiniMapPlugin.cs
diff --git a/MiniMapMod/MinimapExtensions.cs b/MiniMapMod/MinimapExtensions.cs

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Text;`
`4`	`4`
`5`		`-namespace MiniMapLibrary.Interfaces`
	`5`	`+namespace MiniMapLibrary.Config`
`6`	`6`	`{`
`7`	`7`	`public interface IConfig`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,9 @@`
`1`		`-using MiniMapLibrary.Interfaces;`
`2`		`-using System;`
	`1`	`+using System;`
`3`	`2`	`using System.Collections.Generic;`
`4`	`3`	`using System.Text;`
`5`	`4`	`using UnityEngine;`
`6`	`5`
`7`		`-namespace MiniMapMod.wrappers`
	`6`	`+namespace MiniMapLibrary.Config`
`8`	`7`	`{`
`9`	`8`	`public interface ISettingConfigGroup`
`10`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`using MiniMapLibrary;`
`2`		`-using MiniMapLibrary.Interfaces;`
	`2`	`+using MiniMapLibrary.Config;`
`3`	`3`	`using System;`
`4`	`4`	`using System.Collections.Generic;`
`5`	`5`	`using System.Text;`
`6`	`6`	`using UnityEngine;`
`7`	`7`
`8`		`-namespace MiniMapMod.wrappers`
	`8`	`+namespace MiniMapLibrary.Config`
`9`	`9`	`{`
`10`	`10`	`public class SettingConfigGroup : ISettingConfigGroup`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`		`-using MiniMapLibrary.Interfaces;`
`2`		`-using System;`
	`1`	`+using System;`
`3`	`2`	`using System.Collections.Generic;`
`4`	`3`	`using System.Text;`
`5`	`4`
`6`		`-namespace MiniMapLibrary`
	`5`	`+namespace MiniMapLibrary.Config`
`7`	`6`	`{`
`8`	`7`	`public class StubConfigEntry<T> : IConfigEntry<T>`
`9`	`8`	`{`