Merge branch 'ruleset-configs' into mania-playfield-inversions

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);

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);
 

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);
+        }
+    }
+}

osu.Game/Rulesets/UI/RulesetContainer.cs

@@ -13,7 +13,6 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
-using JetBrains.Annotations;
 using osu.Framework.Configuration;
 using osu.Framework.Graphics.Cursor;
 using osu.Framework.Input;
@@ -86,27 +85,21 @@ protected RulesetContainer(Ruleset ruleset)
             Cursor = CreateCursor();
         }
 
-        [BackgroundDependencyLoader(true)]
-        private void load([CanBeNull] OnScreenDisplay onScreenDisplay, [CanBeNull] SettingsStore settings)
+        protected override IReadOnlyDependencyContainer CreateLocalDependencies(IReadOnlyDependencyContainer parent)
         {
-            this.onScreenDisplay = onScreenDisplay;
+            var dependencies = new DependencyContainer(base.CreateLocalDependencies(parent));
 
-            if (settings != null)
-            {
-                rulesetConfig = Ruleset.CreateConfig(settings);
+            onScreenDisplay = dependencies.Get<OnScreenDisplay>();
 
+            rulesetConfig = dependencies.Get<RulesetConfigCache>().GetConfigFor(Ruleset);
             if (rulesetConfig != null)
             {
                 dependencies.Cache(rulesetConfig);
                 onScreenDisplay?.BeginTracking(this, rulesetConfig);
             }
-            }
-        }
 
-        private DependencyContainer dependencies;
-
-        protected override IReadOnlyDependencyContainer CreateLocalDependencies(IReadOnlyDependencyContainer parent)
-            => dependencies = new DependencyContainer(base.CreateLocalDependencies(parent));
+            return dependencies;
+        }
 
         public abstract ScoreProcessor CreateScoreProcessor();