From 14b75309944a02d0ad8ff7622603ec0d4dbdb235 Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Mon, 11 Jun 2018 15:07:42 +0900
Subject: [PATCH] Use a global ruleset config cache

---
 osu.Game/OsuGameBase.cs                       |  3 ++
 .../Settings/RulesetSettingsSubsection.cs     |  3 +-
 osu.Game/Rulesets/RulesetConfigCache.cs       | 43 +++++++++++++++++++
 osu.Game/Rulesets/UI/RulesetContainer.cs      | 13 ++----
 4 files changed, 51 insertions(+), 11 deletions(-)
 create mode 100644 osu.Game/Rulesets/RulesetConfigCache.cs

diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
index b968d7d4d0..a5779a2293 100644
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@@ -56,6 +56,8 @@ public class OsuGameBase : Framework.Game, ICanAcceptFiles
 
         protected SettingsStore SettingsStore;
 
+        protected RulesetConfigCache RulesetConfigCache;
+
         protected MenuCursorContainer MenuCursorContainer;
 
         private Container content;
@@ -123,6 +125,7 @@ private void load()
             dependencies.Cache(ScoreStore = new ScoreStore(Host.Storage, contextFactory, Host, BeatmapManager, RulesetStore));
             dependencies.Cache(KeyBindingStore = new KeyBindingStore(contextFactory, RulesetStore));
             dependencies.Cache(SettingsStore = new SettingsStore(contextFactory));
+            dependencies.Cache(RulesetConfigCache = new RulesetConfigCache(SettingsStore));
             dependencies.Cache(new OsuColour());
 
             fileImporters.Add(BeatmapManager);
diff --git a/osu.Game/Overlays/Settings/RulesetSettingsSubsection.cs b/osu.Game/Overlays/Settings/RulesetSettingsSubsection.cs
index 8f8c18d1f0..05104018cd 100644
--- a/osu.Game/Overlays/Settings/RulesetSettingsSubsection.cs
+++ b/osu.Game/Overlays/Settings/RulesetSettingsSubsection.cs
@@ -2,7 +2,6 @@
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
 
 using osu.Framework.Allocation;
-using osu.Game.Configuration;
 using osu.Game.Rulesets;
 
 namespace osu.Game.Overlays.Settings
@@ -26,7 +25,7 @@ protected override IReadOnlyDependencyContainer CreateLocalDependencies(IReadOnl
         {
             dependencies = new DependencyContainer(base.CreateLocalDependencies(parent));
 
-            var config = ruleset.CreateConfig(dependencies.Get<SettingsStore>());
+            var config = dependencies.Get<RulesetConfigCache>().GetConfigFor(ruleset);
             if (config != null)
                 dependencies.Cache(config);
 
diff --git a/osu.Game/Rulesets/RulesetConfigCache.cs b/osu.Game/Rulesets/RulesetConfigCache.cs
new file mode 100644
index 0000000000..52c40465f3
--- /dev/null
+++ b/osu.Game/Rulesets/RulesetConfigCache.cs
@@ -0,0 +1,43 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using System;
+using System.Collections.Generic;
+using osu.Framework.Graphics;
+using osu.Game.Configuration;
+using osu.Game.Rulesets.Configuration;
+
+namespace osu.Game.Rulesets
+{
+    /// <summary>
+    /// A cache that provides a single <see cref="IRulesetConfigManager"/> per-ruleset
+    /// This is done to support referring to and updating ruleset configs from multiple locations in the absence of inter-config bindings.
+    /// </summary>
+    public class RulesetConfigCache : Component
+    {
+        private readonly Dictionary<int, IRulesetConfigManager> configCache = new Dictionary<int, IRulesetConfigManager>();
+        private readonly SettingsStore settingsStore;
+
+        public RulesetConfigCache(SettingsStore settingsStore)
+        {
+            this.settingsStore = settingsStore;
+        }
+
+        /// <summary>
+        /// Retrieves the <see cref="IRulesetConfigManager"/> for a <see cref="Ruleset"/>.
+        /// </summary>
+        /// <param name="ruleset">The <see cref="Ruleset"/> to retrieve the <see cref="IRulesetConfigManager"/> for.</param>
+        /// <returns>The <see cref="IRulesetConfigManager"/> defined by <paramref name="ruleset"/>, null if <paramref name="ruleset"/> doesn't define one.</returns>
+        /// <exception cref="InvalidOperationException">If <paramref name="ruleset"/> doesn't have a valid <see cref="RulesetInfo.ID"/>.</exception>
+        public IRulesetConfigManager GetConfigFor(Ruleset ruleset)
+        {
+            if (ruleset.RulesetInfo.ID == null)
+                throw new InvalidOperationException("The provided ruleset doesn't have a valid id.");
+
+            if (configCache.TryGetValue(ruleset.RulesetInfo.ID.Value, out var existing))
+                return existing;
+
+            return configCache[ruleset.RulesetInfo.ID.Value] = ruleset.CreateConfig(settingsStore);
+        }
+    }
+}
diff --git a/osu.Game/Rulesets/UI/RulesetContainer.cs b/osu.Game/Rulesets/UI/RulesetContainer.cs
index a7005f1d5e..15383946e8 100644
--- a/osu.Game/Rulesets/UI/RulesetContainer.cs
+++ b/osu.Game/Rulesets/UI/RulesetContainer.cs
@@ -91,16 +91,11 @@ protected override IReadOnlyDependencyContainer CreateLocalDependencies(IReadOnl
 
             onScreenDisplay = dependencies.Get<OnScreenDisplay>();
 
-            var settings = dependencies.Get<SettingsStore>();
-            if (settings != null)
+            rulesetConfig = dependencies.Get<RulesetConfigCache>().GetConfigFor(Ruleset);
+            if (rulesetConfig != null)
             {
-                rulesetConfig = Ruleset.CreateConfig(settings);
-
-                if (rulesetConfig != null)
-                {
-                    dependencies.Cache(rulesetConfig);
-                    onScreenDisplay?.BeginTracking(this, rulesetConfig);
-                }
+                dependencies.Cache(rulesetConfig);
+                onScreenDisplay?.BeginTracking(this, rulesetConfig);
             }
 
             return dependencies;