h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-02-15 18:52:55 +08:00
Code Issues Releases Wiki Activity

Merge pull request #15456 from peppy/beatmap-refactor/beatmap-metadata-nullable-enable

Browse Source 
Enable nullable support on `BeatmapMetadata`
This commit is contained in:
Dan Balasescu 2021-11-04 15:47:18 +09:00 committed by GitHub
commit 222c3e552b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 45 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
osu.Game.Tests/Editing/Checks/CheckAudioQualityTest.cs
View File

@ -35,7 +35,7 @@ namespace osu.Game.Tests.Editing.Checks
public void TestMissing() public void TestMissing()
{ {
// While this is a problem, it is out of scope for this check and is caught by a different one. // While this is a problem, it is out of scope for this check and is caught by a different one.
beatmap.Metadata.AudioFile = null; beatmap.Metadata.AudioFile = string.Empty;
var mock = new Mock<IWorkingBeatmap>(); var mock = new Mock<IWorkingBeatmap>();
mock.SetupGet(w => w.Beatmap).Returns(beatmap); mock.SetupGet(w => w.Beatmap).Returns(beatmap);

2
osu.Game.Tests/Editing/Checks/CheckBackgroundQualityTest.cs
View File

@ -53,7 +53,7 @@ namespace osu.Game.Tests.Editing.Checks
public void TestMissing() public void TestMissing()
{ {
// While this is a problem, it is out of scope for this check and is caught by a different one. // While this is a problem, it is out of scope for this check and is caught by a different one.
beatmap.Metadata.BackgroundFile = null; beatmap.Metadata.BackgroundFile = string.Empty;
var context = getContext(null, System.Array.Empty<byte>()); var context = getContext(null, System.Array.Empty<byte>());
Assert.That(check.Run(context), Is.Empty); Assert.That(check.Run(context), Is.Empty);

2
osu.Game.Tests/Editing/Checks/CheckFilePresenceTest.cs
View File

@ -65,7 +65,7 @@ namespace osu.Game.Tests.Editing.Checks
[Test] [Test]
public void TestBackgroundNotSet() public void TestBackgroundNotSet()
{ {
beatmap.Metadata.BackgroundFile = null; beatmap.Metadata.BackgroundFile = string.Empty;
var context = new BeatmapVerifierContext(beatmap, new TestWorkingBeatmap(beatmap)); var context = new BeatmapVerifierContext(beatmap, new TestWorkingBeatmap(beatmap));
var issues = check.Run(context).ToList(); var issues = check.Run(context).ToList();

2
osu.Game.Tests/NonVisual/Filtering/FilterMatchingTest.cs
View File

@ -189,7 +189,7 @@ namespace osu.Game.Tests.NonVisual.Filtering
public void TestCriteriaMatchingArtistWithNullUnicodeName(string artistName, bool filtered) public void TestCriteriaMatchingArtistWithNullUnicodeName(string artistName, bool filtered)
{ {
var exampleBeatmapInfo = getExampleBeatmap(); var exampleBeatmapInfo = getExampleBeatmap();
exampleBeatmapInfo.Metadata.ArtistUnicode = null; exampleBeatmapInfo.Metadata.ArtistUnicode = string.Empty;
var criteria = new FilterCriteria var criteria = new FilterCriteria
{ {

12
osu.Game.Tests/Visual/Editing/TestSceneMetadataSection.cs
View File

@ -23,10 +23,10 @@ namespace osu.Game.Tests.Visual.Editing
AddStep("set metadata", () => AddStep("set metadata", () =>
{ {
editorBeatmap.Metadata.Artist = "Example Artist"; editorBeatmap.Metadata.Artist = "Example Artist";
editorBeatmap.Metadata.ArtistUnicode = null; editorBeatmap.Metadata.ArtistUnicode = string.Empty;
editorBeatmap.Metadata.Title = "Example Title"; editorBeatmap.Metadata.Title = "Example Title";
editorBeatmap.Metadata.TitleUnicode = null; editorBeatmap.Metadata.TitleUnicode = string.Empty;
}); });
createSection(); createSection();
@ -44,10 +44,10 @@ namespace osu.Game.Tests.Visual.Editing
AddStep("set metadata", () => AddStep("set metadata", () =>
{ {
editorBeatmap.Metadata.ArtistUnicode = "＊なみりん"; editorBeatmap.Metadata.ArtistUnicode = "＊なみりん";
editorBeatmap.Metadata.Artist = null; editorBeatmap.Metadata.Artist = string.Empty;
editorBeatmap.Metadata.TitleUnicode = "コイシテイク・プラネット"; editorBeatmap.Metadata.TitleUnicode = "コイシテイク・プラネット";
editorBeatmap.Metadata.Title = null; editorBeatmap.Metadata.Title = string.Empty;
}); });
createSection(); createSection();
@ -86,10 +86,10 @@ namespace osu.Game.Tests.Visual.Editing
AddStep("set metadata", () => AddStep("set metadata", () =>
{ {
editorBeatmap.Metadata.ArtistUnicode = "＊なみりん"; editorBeatmap.Metadata.ArtistUnicode = "＊なみりん";
editorBeatmap.Metadata.Artist = null; editorBeatmap.Metadata.Artist = string.Empty;
editorBeatmap.Metadata.TitleUnicode = "コイシテイク・プラネット"; editorBeatmap.Metadata.TitleUnicode = "コイシテイク・プラネット";
editorBeatmap.Metadata.Title = null; editorBeatmap.Metadata.Title = string.Empty;
}); });
createSection(); createSection();

4
osu.Game.Tests/Visual/Gameplay/TestSceneReplayRecording.cs
View File

@ -54,7 +54,7 @@ namespace osu.Game.Tests.Visual.Gameplay
ScoreInfo = { BeatmapInfo = gameplayState.Beatmap.BeatmapInfo } ScoreInfo = { BeatmapInfo = gameplayState.Beatmap.BeatmapInfo }
}) })
{ {
ScreenSpaceToGamefield = pos => recordingManager.ToLocalSpace(pos) ScreenSpaceToGamefield = pos => recordingManager?.ToLocalSpace(pos) ?? Vector2.Zero,
}, },
Child = new Container Child = new Container
{ {
@ -84,7 +84,7 @@ namespace osu.Game.Tests.Visual.Gameplay
{ {
ReplayInputHandler = new TestFramedReplayInputHandler(replay) ReplayInputHandler = new TestFramedReplayInputHandler(replay)
{ {
GamefieldToScreenSpace = pos => playbackManager.ToScreenSpace(pos), GamefieldToScreenSpace = pos => playbackManager?.ToScreenSpace(pos) ?? Vector2.Zero,
}, },
Child = new Container Child = new Container
{ {

8
osu.Game/Beatmaps/BeatmapManager.cs
View File

@ -258,10 +258,10 @@ namespace osu.Game.Beatmaps
OnlineBeatmapSetID = model.OnlineID, OnlineBeatmapSetID = model.OnlineID,
Metadata = new BeatmapMetadata Metadata = new BeatmapMetadata
{ {
Title = model.Metadata?.Title, Title = model.Metadata?.Title ?? string.Empty,
Artist = model.Metadata?.Artist, Artist = model.Metadata?.Artist ?? string.Empty,
TitleUnicode = model.Metadata?.TitleUnicode, TitleUnicode = model.Metadata?.TitleUnicode ?? string.Empty,
ArtistUnicode = model.Metadata?.ArtistUnicode, ArtistUnicode = model.Metadata?.ArtistUnicode ?? string.Empty,
Author = new User { Username = model.Metadata?.Author }, Author = new User { Username = model.Metadata?.Author },
} }
}, minimiseDownloadSize); }, minimiseDownloadSize);

28
osu.Game/Beatmaps/BeatmapMetadata.cs
View File

@ -9,6 +9,8 @@ using osu.Framework.Testing;
using osu.Game.Database; using osu.Game.Database;
using osu.Game.Users; using osu.Game.Users;
#nullable enable
namespace osu.Game.Beatmaps namespace osu.Game.Beatmaps
{ {
[ExcludeFromDynamicCompile] [ExcludeFromDynamicCompile]
@ -17,21 +19,21 @@ namespace osu.Game.Beatmaps
{ {
public int ID { get; set; } public int ID { get; set; }
public string Title { get; set; } public string Title { get; set; } = string.Empty;
[JsonProperty("title_unicode")] [JsonProperty("title_unicode")]
public string TitleUnicode { get; set; } public string TitleUnicode { get; set; } = string.Empty;
public string Artist { get; set; } public string Artist { get; set; } = string.Empty;
[JsonProperty("artist_unicode")] [JsonProperty("artist_unicode")]
public string ArtistUnicode { get; set; } public string ArtistUnicode { get; set; } = string.Empty;
[JsonIgnore] [JsonIgnore]
public List<BeatmapInfo> Beatmaps { get; set; } public List<BeatmapInfo> Beatmaps { get; set; } = new List<BeatmapInfo>();
[JsonIgnore] [JsonIgnore]
public List<BeatmapSetInfo> BeatmapSets { get; set; } public List<BeatmapSetInfo> BeatmapSets { get; set; } = new List<BeatmapSetInfo>();
/// <summary> /// <summary>
/// Helper property to deserialize a username to <see cref="User"/>. /// Helper property to deserialize a username to <see cref="User"/>.
@ -55,7 +57,7 @@ namespace osu.Game.Beatmaps
[Column("Author")] [Column("Author")]
public string AuthorString public string AuthorString
{ {
get => Author?.Username; get => Author?.Username ?? string.Empty;
set set
{ {
Author ??= new User(); Author ??= new User();
@ -67,22 +69,22 @@ namespace osu.Game.Beatmaps
/// The author of the beatmaps in this set. /// The author of the beatmaps in this set.
/// </summary> /// </summary>
[JsonIgnore] [JsonIgnore]
public User Author; public User? Author;
public string Source { get; set; } public string Source { get; set; } = string.Empty;
[JsonProperty(@"tags")] [JsonProperty(@"tags")]
public string Tags { get; set; } public string Tags { get; set; } = string.Empty;
/// <summary> /// <summary>
/// The time in milliseconds to begin playing the track for preview purposes. /// The time in milliseconds to begin playing the track for preview purposes.
/// If -1, the track should begin playing at 40% of its length. /// If -1, the track should begin playing at 40% of its length.
/// </summary> /// </summary>
public int PreviewTime { get; set; } public int PreviewTime { get; set; } = -1;
public string AudioFile { get; set; } public string AudioFile { get; set; } = string.Empty;
public string BackgroundFile { get; set; } public string BackgroundFile { get; set; } = string.Empty;
public bool Equals(BeatmapMetadata other) => ((IBeatmapMetadataInfo)this).Equals(other); public bool Equals(BeatmapMetadata other) => ((IBeatmapMetadataInfo)this).Equals(other);

10
osu.Game/Beatmaps/Formats/LegacyBeatmapEncoder.cs
View File

@ -82,7 +82,7 @@ namespace osu.Game.Beatmaps.Formats
{ {
writer.WriteLine("[General]"); writer.WriteLine("[General]");
if (beatmap.Metadata.AudioFile != null) writer.WriteLine(FormattableString.Invariant($"AudioFilename: {Path.GetFileName(beatmap.Metadata.AudioFile)}")); if (!string.IsNullOrEmpty(beatmap.Metadata.AudioFile)) writer.WriteLine(FormattableString.Invariant($"AudioFilename: {Path.GetFileName(beatmap.Metadata.AudioFile)}"));
writer.WriteLine(FormattableString.Invariant($"AudioLeadIn: {beatmap.BeatmapInfo.AudioLeadIn}")); writer.WriteLine(FormattableString.Invariant($"AudioLeadIn: {beatmap.BeatmapInfo.AudioLeadIn}"));
writer.WriteLine(FormattableString.Invariant($"PreviewTime: {beatmap.Metadata.PreviewTime}")); writer.WriteLine(FormattableString.Invariant($"PreviewTime: {beatmap.Metadata.PreviewTime}"));
writer.WriteLine(FormattableString.Invariant($"Countdown: {(int)beatmap.BeatmapInfo.Countdown}")); writer.WriteLine(FormattableString.Invariant($"Countdown: {(int)beatmap.BeatmapInfo.Countdown}"));
@ -126,13 +126,13 @@ namespace osu.Game.Beatmaps.Formats
writer.WriteLine("[Metadata]"); writer.WriteLine("[Metadata]");
writer.WriteLine(FormattableString.Invariant($"Title: {beatmap.Metadata.Title}")); writer.WriteLine(FormattableString.Invariant($"Title: {beatmap.Metadata.Title}"));
if (beatmap.Metadata.TitleUnicode != null) writer.WriteLine(FormattableString.Invariant($"TitleUnicode: {beatmap.Metadata.TitleUnicode}")); if (!string.IsNullOrEmpty(beatmap.Metadata.TitleUnicode)) writer.WriteLine(FormattableString.Invariant($"TitleUnicode: {beatmap.Metadata.TitleUnicode}"));
writer.WriteLine(FormattableString.Invariant($"Artist: {beatmap.Metadata.Artist}")); writer.WriteLine(FormattableString.Invariant($"Artist: {beatmap.Metadata.Artist}"));
if (beatmap.Metadata.ArtistUnicode != null) writer.WriteLine(FormattableString.Invariant($"ArtistUnicode: {beatmap.Metadata.ArtistUnicode}")); if (!string.IsNullOrEmpty(beatmap.Metadata.ArtistUnicode)) writer.WriteLine(FormattableString.Invariant($"ArtistUnicode: {beatmap.Metadata.ArtistUnicode}"));
writer.WriteLine(FormattableString.Invariant($"Creator: {beatmap.Metadata.AuthorString}")); writer.WriteLine(FormattableString.Invariant($"Creator: {beatmap.Metadata.AuthorString}"));
writer.WriteLine(FormattableString.Invariant($"Version: {beatmap.BeatmapInfo.Version}")); writer.WriteLine(FormattableString.Invariant($"Version: {beatmap.BeatmapInfo.Version}"));
if (beatmap.Metadata.Source != null) writer.WriteLine(FormattableString.Invariant($"Source: {beatmap.Metadata.Source}")); if (!string.IsNullOrEmpty(beatmap.Metadata.Source)) writer.WriteLine(FormattableString.Invariant($"Source: {beatmap.Metadata.Source}"));
if (beatmap.Metadata.Tags != null) writer.WriteLine(FormattableString.Invariant($"Tags: {beatmap.Metadata.Tags}")); if (!string.IsNullOrEmpty(beatmap.Metadata.Tags)) writer.WriteLine(FormattableString.Invariant($"Tags: {beatmap.Metadata.Tags}"));
if (beatmap.BeatmapInfo.OnlineBeatmapID != null) writer.WriteLine(FormattableString.Invariant($"BeatmapID: {beatmap.BeatmapInfo.OnlineBeatmapID}")); if (beatmap.BeatmapInfo.OnlineBeatmapID != null) writer.WriteLine(FormattableString.Invariant($"BeatmapID: {beatmap.BeatmapInfo.OnlineBeatmapID}"));
if (beatmap.BeatmapInfo.BeatmapSet?.OnlineBeatmapSetID != null) writer.WriteLine(FormattableString.Invariant($"BeatmapSetID: {beatmap.BeatmapInfo.BeatmapSet.OnlineBeatmapSetID}")); if (beatmap.BeatmapInfo.BeatmapSet?.OnlineBeatmapSetID != null) writer.WriteLine(FormattableString.Invariant($"BeatmapSetID: {beatmap.BeatmapInfo.BeatmapSet.OnlineBeatmapSetID}"));
} }

6
osu.Game/Beatmaps/WorkingBeatmapCache.cs
View File

@ -149,7 +149,7 @@ namespace osu.Game.Beatmaps
protected override Texture GetBackground() protected override Texture GetBackground()
{ {
if (Metadata?.BackgroundFile == null) if (string.IsNullOrEmpty(Metadata?.BackgroundFile))
return null; return null;
try try
@ -165,7 +165,7 @@ namespace osu.Game.Beatmaps
protected override Track GetBeatmapTrack() protected override Track GetBeatmapTrack()
{ {
if (Metadata?.AudioFile == null) if (string.IsNullOrEmpty(Metadata?.AudioFile))
return null; return null;
try try
@ -181,7 +181,7 @@ namespace osu.Game.Beatmaps
protected override Waveform GetWaveform() protected override Waveform GetWaveform()
{ {
if (Metadata?.AudioFile == null) if (string.IsNullOrEmpty(Metadata?.AudioFile))
return null; return null;
try try

2
osu.Game/Rulesets/Edit/Checks/CheckAudioQuality.cs
View File

@ -28,7 +28,7 @@ namespace osu.Game.Rulesets.Edit.Checks
public IEnumerable<Issue> Run(BeatmapVerifierContext context) public IEnumerable<Issue> Run(BeatmapVerifierContext context)
{ {
string audioFile = context.Beatmap.Metadata?.AudioFile; string audioFile = context.Beatmap.Metadata?.AudioFile;
if (audioFile == null) if (string.IsNullOrEmpty(audioFile))
yield break; yield break;
var track = context.WorkingBeatmap.Track; var track = context.WorkingBeatmap.Track;

2
osu.Game/Rulesets/Edit/Checks/CheckFilePresence.cs
View File

@ -25,7 +25,7 @@ namespace osu.Game.Rulesets.Edit.Checks
{ {
string filename = GetFilename(context.Beatmap); string filename = GetFilename(context.Beatmap);
if (filename == null) if (string.IsNullOrEmpty(filename))
{ {
yield return new IssueTemplateNoneSet(this).Create(TypeOfFile); yield return new IssueTemplateNoneSet(this).Create(TypeOfFile);

2
osu.Game/Screens/Select/Carousel/CarouselBeatmapSet.cs
View File

@ -69,7 +69,7 @@ namespace osu.Game.Screens.Select.Carousel
return string.Compare(BeatmapSet.Metadata.Title, otherSet.BeatmapSet.Metadata.Title, StringComparison.OrdinalIgnoreCase); return string.Compare(BeatmapSet.Metadata.Title, otherSet.BeatmapSet.Metadata.Title, StringComparison.OrdinalIgnoreCase);
case SortMode.Author: case SortMode.Author:
return string.Compare(BeatmapSet.Metadata.Author.Username, otherSet.BeatmapSet.Metadata.Author.Username, StringComparison.OrdinalIgnoreCase); return string.Compare(BeatmapSet.Metadata.Author?.Username, otherSet.BeatmapSet.Metadata.Author?.Username, StringComparison.OrdinalIgnoreCase);
case SortMode.Source: case SortMode.Source:
return string.Compare(BeatmapSet.Metadata.Source, otherSet.BeatmapSet.Metadata.Source, StringComparison.OrdinalIgnoreCase); return string.Compare(BeatmapSet.Metadata.Source, otherSet.BeatmapSet.Metadata.Source, StringComparison.OrdinalIgnoreCase);

2
osu.Game/Screens/Select/Carousel/DrawableCarouselBeatmap.cs
View File

@ -142,7 +142,7 @@ namespace osu.Game.Screens.Select.Carousel
}, },
new OsuSpriteText new OsuSpriteText
{ {
Text = $"{(beatmapInfo.Metadata ?? beatmapInfo.BeatmapSet.Metadata).Author.Username}", Text = $"{(beatmapInfo.Metadata ?? beatmapInfo.BeatmapSet.Metadata).Author?.Username ?? string.Empty}",
Font = OsuFont.GetFont(italics: true), Font = OsuFont.GetFont(italics: true),
Anchor = Anchor.BottomLeft, Anchor = Anchor.BottomLeft,
Origin = Anchor.BottomLeft Origin = Anchor.BottomLeft

4
osu.Game/Storyboards/Storyboard.cs
View File

@ -77,8 +77,8 @@ namespace osu.Game.Storyboards
{ {
get get
{ {
string backgroundPath = BeatmapInfo.BeatmapSet?.Metadata?.BackgroundFile?.ToLowerInvariant(); string backgroundPath = BeatmapInfo.BeatmapSet?.Metadata?.BackgroundFile.ToLowerInvariant();
if (backgroundPath == null) if (string.IsNullOrEmpty(backgroundPath))
return false; return false;
return GetLayer("Background").Elements.Any(e => e.Path.ToLowerInvariant() == backgroundPath); return GetLayer("Background").Elements.Any(e => e.Path.ToLowerInvariant() == backgroundPath);