Mark FallbackStack operations as obsolete and introduce overloads with fallback parameter

Author: Saplonily

Celeste.Mod.mm/Patches/Monocle/Atlas.cs

@@ -15,6 +15,8 @@
 
 namespace Monocle {
     class patch_Atlas : Atlas {
+        private const string MessageFallbackStackObsolete = "Fallback stack is obsolete, use overloads with fallback parameter instead.";
+        private const string MessageGetFallbackObsolete = "Fallback stack is obsolete, use GetDefaultFallback if you are getting the default one.";
 
         // We're effectively in Atlas, but still need to "expose" private fields to our mod.
         private Dictionary<string, MTexture> textures;
@@ -338,13 +340,20 @@ public void ResetCaches() {
                 orderedTexturesCache = new Dictionary<string, List<MTexture>>();
         }
 
-        public MTexture GetFallback() {
+        private MTexture GetFallbackInternal() {
             if (FallbackStack.IsValueCreated) {
                 Stack<MTexture> stack = FallbackStack.Value;
                 if (stack.Count > 0)
                     return stack.Peek();
             }
+            return GetDefaultFallback();
+        }
+
+        [Obsolete(MessageGetFallbackObsolete)]
+        public MTexture GetFallback()
+            => GetFallbackInternal();
 
+        public MTexture GetDefaultFallback() {
             // we may encounter concurrent issue here but it's safe
             // since the worst result is making multiple lookups
             if (DefaultFallback != null || textures.TryGetValue("__fallback", out DefaultFallback))
@@ -353,10 +362,12 @@ public MTexture GetFallback() {
             return null;
         }
 
+        [Obsolete(MessageFallbackStackObsolete)]
         public void PushFallback(MTexture fallback) {
             FallbackStack.Value.Push(fallback);
         }
 
+        [Obsolete(MessageFallbackStackObsolete)]
         public MTexture PopFallback() {
             return FallbackStack.Value.Pop();
         }
@@ -436,12 +447,14 @@ public bool HasAtlasSubtexturesAt(string key, int index) {
         // log missing subtextures when getting an animation (for example, decals)
         public extern List<MTexture> orig_GetAtlasSubtextures(string key);
         public new List<MTexture> GetAtlasSubtextures(string key) {
-            PushFallback(null);
+            return GetAtlasSubtextures(key, GetFallbackInternal());
+        }
+
+        public List<MTexture> GetAtlasSubtextures(string key, MTexture fallback) {
             List<MTexture> result = orig_GetAtlasSubtextures(key);
-            PopFallback();
+
             if (result == null || result.Count == 0) {
                 Logger.Warn("Atlas", $"Requested atlas subtextures but none were found: {RelativeDataPath}{key}");
-                MTexture fallback = GetFallback();
                 if (fallback != null)
                     return new List<MTexture>() { fallback };
             }
@@ -453,17 +466,21 @@ public bool HasAtlasSubtexturesAt(string key, int index) {
 
         [MonoModReplace]
         public new MTexture GetAtlasSubtexturesAt(string key, int index) {
+            MTexture fallback = GetFallbackInternal();
+            return GetAtlasSubtexturesAt(key, index, fallback);
+        }
+
+        public MTexture GetAtlasSubtexturesAt(string key, int index, MTexture fallback) {
             if (orderedTexturesCache.TryGetValue(key, out List<MTexture> list)) {
                 if (index < 0 || index >= list.Count) {
                     Logger.Warn("Atlas", $"Requested atlas subtexture that falls out of range: {RelativeDataPath}{key} {index}");
-                    return GetFallback();
+                    return fallback;
                 }
                 return list[index];
             }
 
             MTexture result = GetAtlasSubtextureFromAtlasAt(key, index);
             if (result == null) {
-                MTexture fallback = GetFallback();
                 if (fallback != null) {
                     // SpriteData and other places use GetAtlasSubtextureAt to check if textures exist.
                     // Logging this verbosely when no fallback exists doesn't make sense in those cases.
@@ -474,21 +491,26 @@ public bool HasAtlasSubtexturesAt(string key, int index) {
             return result;
         }
 
-        // log missing texture when getting one by ID (for example, tilesets)
         public new MTexture this[string id] {
             [MonoModReplace]
             get {
-                if (!textures.TryGetValue(id, out MTexture result)) {
-                    Logger.Warn("Atlas", $"Requested texture that does not exist: {RelativeDataPath}{id}");
-                    return GetFallback();
-                }
-                return result;
+                MTexture fallback = GetFallbackInternal();
+                return GetWithFallback(id, fallback);
             }
 
             // we don't want to modify the setter, but want it to exist in the patch class so that we can call it from within our patches.
             [MonoModIgnore]
             set { }
         }
+
+        // log missing texture when getting one by ID (for example, tilesets)
+        public MTexture GetWithFallback(string id, MTexture fallback) {
+            if (!textures.TryGetValue(id, out MTexture result)) {
+                Logger.Warn("Atlas", $"Requested texture that does not exist: {RelativeDataPath}{id}");
+                return fallback;
+            }
+            return result;
+        }
     }
     public static class AtlasExt {
 

Celeste.Mod.mm/Patches/Monocle/SpriteData.cs

@@ -11,13 +11,17 @@ public patch_SpriteData(Atlas atlas)
             // no-op. MonoMod ignores this - we only need this to make the compiler shut up.
         }
 
-        private extern bool orig_HasFrames(patch_Atlas atlas, string path, int[] frames = null);
+        [MonoModReplace]
         private bool HasFrames(patch_Atlas atlas, string path, int[] frames = null) {
-            atlas.PushFallback(null);
-            bool rv = orig_HasFrames(atlas, path, frames);
-            atlas.PopFallback();
-            return rv;
+            if (frames == null || frames.Length == 0) {
+                return atlas.GetAtlasSubtexturesAt(path, 0, null) != null;
+            }
+            for (int i = 0; i < frames.Length; i++) {
+                if (atlas.GetAtlasSubtexturesAt(path, frames[i], null) == null) {
+                    return false;
+                }
+            }
+            return true;
         }
-
     }
 }