Merge pull request #13218 from peppy/osu-game-base-cleanup

Tidy up OsuGameBase

osu.Game/Input/OsuUserInputManager.cs

@@ -0,0 +1,38 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using osu.Framework.Input;
+using osuTK.Input;
+
+namespace osu.Game.Input
+{
+    public class OsuUserInputManager : UserInputManager
+    {
+        internal OsuUserInputManager()
+        {
+        }
+
+        protected override MouseButtonEventManager CreateButtonEventManagerFor(MouseButton button)
+        {
+            switch (button)
+            {
+                case MouseButton.Right:
+                    return new RightMouseManager(button);
+            }
+
+            return base.CreateButtonEventManagerFor(button);
+        }
+
+        private class RightMouseManager : MouseButtonEventManager
+        {
+            public RightMouseManager(MouseButton button)
+                : base(button)
+            {
+            }
+
+            public override bool EnableDrag => true; // allow right-mouse dragging for absolute scroll in scroll containers.
+            public override bool EnableClick => false;
+            public override bool ChangeFocusOnClick => false;
+        }
+    }
+}

osu.Game/OsuGameBase.cs

@@ -6,7 +6,6 @@ using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
-using System.Threading.Tasks;
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
 using osu.Framework.Bindables;
@@ -41,7 +40,6 @@ using osu.Game.Rulesets.Mods;
 using osu.Game.Scoring;
 using osu.Game.Skinning;
 using osu.Game.Utils;
-using osuTK.Input;
 using RuntimeInfo = osu.Framework.RuntimeInfo;
 
 namespace osu.Game
@@ -51,78 +49,19 @@ namespace osu.Game
     /// Unlike <see cref="OsuGame"/>, this class will not load any kind of UI, allowing it to be used
     /// for provide dependencies to test cases without interfering with them.
     /// </summary>
-    public class OsuGameBase : Framework.Game, ICanAcceptFiles
+    public partial class OsuGameBase : Framework.Game, ICanAcceptFiles
     {
-        public const string CLIENT_STREAM_NAME = "lazer";
+        public const string CLIENT_STREAM_NAME = @"lazer";
 
         public const int SAMPLE_CONCURRENCY = 6;
 
+        /// <summary>
+        /// The maximum volume at which audio tracks should playback. This can be set lower than 1 to create some head-room for sound effects.
+        /// </summary>
+        internal const double GLOBAL_TRACK_VOLUME_ADJUST = 0.5;
+
         public bool UseDevelopmentServer { get; }
 
-        protected OsuConfigManager LocalConfig;
-
-        protected SessionStatics SessionStatics { get; private set; }
-
-        protected BeatmapManager BeatmapManager;
-
-        protected ScoreManager ScoreManager;
-
-        protected BeatmapDifficultyCache DifficultyCache;
-
-        protected UserLookupCache UserCache;
-
-        protected SkinManager SkinManager;
-
-        protected RulesetStore RulesetStore;
-
-        protected FileStore FileStore;
-
-        protected KeyBindingStore KeyBindingStore;
-
-        protected SettingsStore SettingsStore;
-
-        protected RulesetConfigCache RulesetConfigCache;
-
-        protected IAPIProvider API;
-
-        private SpectatorClient spectatorClient;
-        private MultiplayerClient multiplayerClient;
-
-        protected MenuCursorContainer MenuCursorContainer;
-
-        protected MusicController MusicController;
-
-        private Container content;
-
-        protected override Container<Drawable> Content => content;
-
-        protected Storage Storage { get; set; }
-
-        [Cached]
-        [Cached(typeof(IBindable<RulesetInfo>))]
-        protected readonly Bindable<RulesetInfo> Ruleset = new Bindable<RulesetInfo>();
-
-        /// <summary>
-        /// The current mod selection for the local user.
-        /// </summary>
-        /// <remarks>
-        /// If a mod select overlay is present, mod instances set to this value are not guaranteed to remain as the provided instance and will be overwritten by a copy.
-        /// In such a case, changes to settings of a mod will *not* propagate after a mod is added to this collection.
-        /// As such, all settings should be finalised before adding a mod to this collection.
-        /// </remarks>
-        [Cached]
-        [Cached(typeof(IBindable<IReadOnlyList<Mod>>))]
-        protected readonly Bindable<IReadOnlyList<Mod>> SelectedMods = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>());
-
-        /// <summary>
-        /// Mods available for the current <see cref="Ruleset"/>.
-        /// </summary>
-        public readonly Bindable<Dictionary<ModType, IReadOnlyList<Mod>>> AvailableMods = new Bindable<Dictionary<ModType, IReadOnlyList<Mod>>>();
-
-        protected Bindable<WorkingBeatmap> Beatmap { get; private set; } // cached via load() method
-
-        private Bindable<bool> fpsDisplayVisible;
-
         public virtual Version AssemblyVersion => Assembly.GetEntryAssembly()?.GetName().Version ?? new Version();
 
         /// <summary>
@@ -144,30 +83,83 @@ namespace osu.Game
             }
         }
 
+        protected OsuConfigManager LocalConfig { get; private set; }
+
+        protected SessionStatics SessionStatics { get; private set; }
+
+        protected BeatmapManager BeatmapManager { get; private set; }
+
+        protected ScoreManager ScoreManager { get; private set; }
+
+        protected SkinManager SkinManager { get; private set; }
+
+        protected RulesetStore RulesetStore { get; private set; }
+
+        protected KeyBindingStore KeyBindingStore { get; private set; }
+
+        protected MenuCursorContainer MenuCursorContainer { get; private set; }
+
+        protected MusicController MusicController { get; private set; }
+
+        protected IAPIProvider API { get; set; }
+
+        protected Storage Storage { get; set; }
+
+        protected Bindable<WorkingBeatmap> Beatmap { get; private set; } // cached via load() method
+
+        [Cached]
+        [Cached(typeof(IBindable<RulesetInfo>))]
+        protected readonly Bindable<RulesetInfo> Ruleset = new Bindable<RulesetInfo>();
+
+        /// <summary>
+        /// The current mod selection for the local user.
+        /// </summary>
+        /// <remarks>
+        /// If a mod select overlay is present, mod instances set to this value are not guaranteed to remain as the provided instance and will be overwritten by a copy.
+        /// In such a case, changes to settings of a mod will *not* propagate after a mod is added to this collection.
+        /// As such, all settings should be finalised before adding a mod to this collection.
+        /// </remarks>
+        [Cached]
+        [Cached(typeof(IBindable<IReadOnlyList<Mod>>))]
+        protected readonly Bindable<IReadOnlyList<Mod>> SelectedMods = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>());
+
+        /// <summary>
+        /// Mods available for the current <see cref="Ruleset"/>.
+        /// </summary>
+        public readonly Bindable<Dictionary<ModType, IReadOnlyList<Mod>>> AvailableMods = new Bindable<Dictionary<ModType, IReadOnlyList<Mod>>>();
+
+        private BeatmapDifficultyCache difficultyCache;
+
+        private UserLookupCache userCache;
+
+        private FileStore fileStore;
+
+        private SettingsStore settingsStore;
+
+        private RulesetConfigCache rulesetConfigCache;
+
+        private SpectatorClient spectatorClient;
+
+        private MultiplayerClient multiplayerClient;
+
+        private DatabaseContextFactory contextFactory;
+
+        protected override Container<Drawable> Content => content;
+
+        private Container content;
+
+        private DependencyContainer dependencies;
+
+        private Bindable<bool> fpsDisplayVisible;
+
+        private readonly BindableNumber<double> globalTrackVolumeAdjust = new BindableNumber<double>(GLOBAL_TRACK_VOLUME_ADJUST);
+
         public OsuGameBase()
         {
             UseDevelopmentServer = DebugUtils.IsDebugBuild;
             Name = @"osu!lazer";
         }
 
-        private DependencyContainer dependencies;
-
-        protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent) =>
-            dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
-
-        private DatabaseContextFactory contextFactory;
-
-        protected override UserInputManager CreateUserInputManager() => new OsuUserInputManager();
-
-        protected virtual BatteryInfo CreateBatteryInfo() => null;
-
-        /// <summary>
-        /// The maximum volume at which audio tracks should playback. This can be set lower than 1 to create some head-room for sound effects.
-        /// </summary>
-        internal const double GLOBAL_TRACK_VOLUME_ADJUST = 0.5;
-
-        private readonly BindableNumber<double> globalTrackVolumeAdjust = new BindableNumber<double>(GLOBAL_TRACK_VOLUME_ADJUST);
-
         [BackgroundDependencyLoader]
         private void load()
         {
@@ -246,10 +238,10 @@ namespace osu.Game
             var defaultBeatmap = new DummyWorkingBeatmap(Audio, Textures);
 
             dependencies.Cache(RulesetStore = new RulesetStore(contextFactory, Storage));
-            dependencies.Cache(FileStore = new FileStore(contextFactory, Storage));
+            dependencies.Cache(fileStore = new FileStore(contextFactory, Storage));
 
             // ordering is important here to ensure foreign keys rules are not broken in ModelStore.Cleanup()
-            dependencies.Cache(ScoreManager = new ScoreManager(RulesetStore, () => BeatmapManager, Storage, API, contextFactory, Host, () => DifficultyCache, LocalConfig));
+            dependencies.Cache(ScoreManager = new ScoreManager(RulesetStore, () => BeatmapManager, Storage, API, contextFactory, Host, () => difficultyCache, LocalConfig));
             dependencies.Cache(BeatmapManager = new BeatmapManager(Storage, contextFactory, RulesetStore, API, Audio, Host, defaultBeatmap, true));
 
             // this should likely be moved to ArchiveModelManager when another case appers where it is necessary
@@ -273,19 +265,19 @@ namespace osu.Game
                     ScoreManager.Undelete(getBeatmapScores(item), true);
             });
 
-            dependencies.Cache(DifficultyCache = new BeatmapDifficultyCache());
+            dependencies.Cache(difficultyCache = new BeatmapDifficultyCache());
-            AddInternal(DifficultyCache);
+            AddInternal(difficultyCache);
 
-            dependencies.Cache(UserCache = new UserLookupCache());
+            dependencies.Cache(userCache = new UserLookupCache());
-            AddInternal(UserCache);
+            AddInternal(userCache);
 
             var scorePerformanceManager = new ScorePerformanceCache();
             dependencies.Cache(scorePerformanceManager);
             AddInternal(scorePerformanceManager);
 
             dependencies.Cache(KeyBindingStore = new KeyBindingStore(contextFactory, RulesetStore));
-            dependencies.Cache(SettingsStore = new SettingsStore(contextFactory));
+            dependencies.Cache(settingsStore = new SettingsStore(contextFactory));
-            dependencies.Cache(RulesetConfigCache = new RulesetConfigCache(SettingsStore));
+            dependencies.Cache(rulesetConfigCache = new RulesetConfigCache(settingsStore));
 
             var powerStatus = CreateBatteryInfo();
             if (powerStatus != null)
@@ -308,7 +300,7 @@ namespace osu.Game
             dependencies.CacheAs<IBindable<WorkingBeatmap>>(Beatmap);
             dependencies.CacheAs(Beatmap);
 
-            FileStore.Cleanup();
+            fileStore.Cleanup();
 
             // add api components to hierarchy.
             if (API is APIAccess apiAccess)
@@ -316,7 +308,7 @@ namespace osu.Game
             AddInternal(spectatorClient);
             AddInternal(multiplayerClient);
 
-            AddInternal(RulesetConfigCache);
+            AddInternal(rulesetConfigCache);
 
             GlobalActionContainer globalBindings;
 
@@ -344,24 +336,6 @@ namespace osu.Game
             Ruleset.BindValueChanged(onRulesetChanged);
         }
 
-        private void onRulesetChanged(ValueChangedEvent<RulesetInfo> r)
-        {
-            var dict = new Dictionary<ModType, IReadOnlyList<Mod>>();
-
-            if (r.NewValue?.Available == true)
-            {
-                foreach (ModType type in Enum.GetValues(typeof(ModType)))
-                    dict[type] = r.NewValue.CreateInstance().GetModsFor(type).ToList();
-            }
-
-            if (!SelectedMods.Disabled)
-                SelectedMods.Value = Array.Empty<Mod>();
-
-            AvailableMods.Value = dict;
-        }
-
-        protected virtual Container CreateScalingContainer() => new DrawSizePreservingFillContainer();
-
         protected override void LoadComplete()
         {
             base.LoadComplete();
@@ -375,28 +349,8 @@ namespace osu.Game
             FrameStatistics.ValueChanged += e => fpsDisplayVisible.Value = e.NewValue != FrameStatisticsMode.None;
         }
 
-        private void runMigrations()
+        protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent) =>
-        {
+            dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
-            try
-            {
-                using (var db = contextFactory.GetForWrite(false))
-                    db.Context.Migrate();
-            }
-            catch (Exception e)
-            {
-                Logger.Error(e.InnerException ?? e, "Migration failed! We'll be starting with a fresh database.", LoggingTarget.Database);
-
-                // if we failed, let's delete the database and start fresh.
-                // todo: we probably want a better (non-destructive) migrations/recovery process at a later point than this.
-                contextFactory.ResetDatabase();
-
-                Logger.Log("Database purged successfully.", LoggingTarget.Database);
-
-                // only run once more, then hard bail.
-                using (var db = contextFactory.GetForWrite(false))
-                    db.Context.Migrate();
-            }
-        }
 
         public override void SetHost(GameHost host)
         {
@@ -422,51 +376,59 @@ namespace osu.Game
                 Scheduler.AddDelayed(GracefullyExit, 2000);
         }
 
+        public void Migrate(string path)
+        {
+            contextFactory.FlushConnections();
+            (Storage as OsuStorage)?.Migrate(Host.GetStorage(path));
+        }
+
+        protected override UserInputManager CreateUserInputManager() => new OsuUserInputManager();
+
+        protected virtual BatteryInfo CreateBatteryInfo() => null;
+
+        protected virtual Container CreateScalingContainer() => new DrawSizePreservingFillContainer();
+
         protected override Storage CreateStorage(GameHost host, Storage defaultStorage) => new OsuStorage(host, defaultStorage);
 
-        private readonly List<ICanAcceptFiles> fileImporters = new List<ICanAcceptFiles>();
+        private void onRulesetChanged(ValueChangedEvent<RulesetInfo> r)
-
-        /// <summary>
-        /// Register a global handler for file imports. Most recently registered will have precedence.
-        /// </summary>
-        /// <param name="handler">The handler to register.</param>
-        public void RegisterImportHandler(ICanAcceptFiles handler) => fileImporters.Insert(0, handler);
-
-        /// <summary>
-        /// Unregister a global handler for file imports.
-        /// </summary>
-        /// <param name="handler">The previously registered handler.</param>
-        public void UnregisterImportHandler(ICanAcceptFiles handler) => fileImporters.Remove(handler);
-
-        public async Task Import(params string[] paths)
         {
-            if (paths.Length == 0)
+            var dict = new Dictionary<ModType, IReadOnlyList<Mod>>();
-                return;
 
-            var filesPerExtension = paths.GroupBy(p => Path.GetExtension(p).ToLowerInvariant());
+            if (r.NewValue?.Available == true)
-
-            foreach (var groups in filesPerExtension)
             {
-                foreach (var importer in fileImporters)
+                foreach (ModType type in Enum.GetValues(typeof(ModType)))
-                {
+                    dict[type] = r.NewValue.CreateInstance().GetModsFor(type).ToList();
-                    if (importer.HandledExtensions.Contains(groups.Key))
+            }
-                        await importer.Import(groups.ToArray()).ConfigureAwait(false);
+
-                }
+            if (!SelectedMods.Disabled)
+                SelectedMods.Value = Array.Empty<Mod>();
+
+            AvailableMods.Value = dict;
+        }
+
+        private void runMigrations()
+        {
+            try
+            {
+                using (var db = contextFactory.GetForWrite(false))
+                    db.Context.Migrate();
+            }
+            catch (Exception e)
+            {
+                Logger.Error(e.InnerException ?? e, "Migration failed! We'll be starting with a fresh database.", LoggingTarget.Database);
+
+                // if we failed, let's delete the database and start fresh.
+                // todo: we probably want a better (non-destructive) migrations/recovery process at a later point than this.
+                contextFactory.ResetDatabase();
+
+                Logger.Log("Database purged successfully.", LoggingTarget.Database);
+
+                // only run once more, then hard bail.
+                using (var db = contextFactory.GetForWrite(false))
+                    db.Context.Migrate();
             }
         }
 
-        public virtual async Task Import(params ImportTask[] tasks)
-        {
-            var tasksPerExtension = tasks.GroupBy(t => Path.GetExtension(t.Path).ToLowerInvariant());
-            await Task.WhenAll(tasksPerExtension.Select(taskGroup =>
-            {
-                var importer = fileImporters.FirstOrDefault(i => i.HandledExtensions.Contains(taskGroup.Key));
-                return importer?.Import(taskGroup.ToArray()) ?? Task.CompletedTask;
-            })).ConfigureAwait(false);
-        }
-
-        public IEnumerable<string> HandledExtensions => fileImporters.SelectMany(i => i.HandledExtensions);
-
         protected override void Dispose(bool isDisposing)
         {
             base.Dispose(isDisposing);
@@ -477,37 +439,5 @@ namespace osu.Game
 
             contextFactory.FlushConnections();
         }
-
-        private class OsuUserInputManager : UserInputManager
-        {
-            protected override MouseButtonEventManager CreateButtonEventManagerFor(MouseButton button)
-            {
-                switch (button)
-                {
-                    case MouseButton.Right:
-                        return new RightMouseManager(button);
-                }
-
-                return base.CreateButtonEventManagerFor(button);
-            }
-
-            private class RightMouseManager : MouseButtonEventManager
-            {
-                public RightMouseManager(MouseButton button)
-                    : base(button)
-                {
-                }
-
-                public override bool EnableDrag => true; // allow right-mouse dragging for absolute scroll in scroll containers.
-                public override bool EnableClick => false;
-                public override bool ChangeFocusOnClick => false;
-            }
-        }
-
-        public void Migrate(string path)
-        {
-            contextFactory.FlushConnections();
-            (Storage as OsuStorage)?.Migrate(Host.GetStorage(path));
-        }
     }
 }

osu.Game/OsuGameBase_Importing.cs

@@ -0,0 +1,57 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using osu.Game.Database;
+
+namespace osu.Game
+{
+    public partial class OsuGameBase
+    {
+        private readonly List<ICanAcceptFiles> fileImporters = new List<ICanAcceptFiles>();
+
+        /// <summary>
+        /// Register a global handler for file imports. Most recently registered will have precedence.
+        /// </summary>
+        /// <param name="handler">The handler to register.</param>
+        public void RegisterImportHandler(ICanAcceptFiles handler) => fileImporters.Insert(0, handler);
+
+        /// <summary>
+        /// Unregister a global handler for file imports.
+        /// </summary>
+        /// <param name="handler">The previously registered handler.</param>
+        public void UnregisterImportHandler(ICanAcceptFiles handler) => fileImporters.Remove(handler);
+
+        public async Task Import(params string[] paths)
+        {
+            if (paths.Length == 0)
+                return;
+
+            var filesPerExtension = paths.GroupBy(p => Path.GetExtension(p).ToLowerInvariant());
+
+            foreach (var groups in filesPerExtension)
+            {
+                foreach (var importer in fileImporters)
+                {
+                    if (importer.HandledExtensions.Contains(groups.Key))
+                        await importer.Import(groups.ToArray()).ConfigureAwait(false);
+                }
+            }
+        }
+
+        public virtual async Task Import(params ImportTask[] tasks)
+        {
+            var tasksPerExtension = tasks.GroupBy(t => Path.GetExtension(t.Path).ToLowerInvariant());
+            await Task.WhenAll(tasksPerExtension.Select(taskGroup =>
+            {
+                var importer = fileImporters.FirstOrDefault(i => i.HandledExtensions.Contains(taskGroup.Key));
+                return importer?.Import(taskGroup.ToArray()) ?? Task.CompletedTask;
+            })).ConfigureAwait(false);
+        }
+
+        public IEnumerable<string> HandledExtensions => fileImporters.SelectMany(i => i.HandledExtensions);
+    }
+}