1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
using System;
using StardewModdingAPI.Toolkit.Utilities;
using StardewValley;
namespace StardewModdingAPI.Framework.Content
{
/// <summary>An asset name that can be loaded through the content pipeline.</summary>
internal class AssetName : IAssetName
{
/*********
** Fields
*********/
/// <summary>A lowercase version of <see cref="Name"/> used for consistent hash codes and equality checks.</summary>
private readonly string ComparableName;
/*********
** Accessors
*********/
/// <inheritdoc />
public string Name { get; }
/// <inheritdoc />
public string BaseName { get; }
/// <inheritdoc />
public string? LocaleCode { get; }
/// <inheritdoc />
public LocalizedContentManager.LanguageCode? LanguageCode { get; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="baseName">The base asset name without the locale code.</param>
/// <param name="localeCode">The locale code specified in the <see cref="Name"/>, if it's a valid code recognized by the game content.</param>
/// <param name="languageCode">The language code matching the <see cref="LocaleCode"/>, if applicable.</param>
public AssetName(string baseName, string? localeCode, LocalizedContentManager.LanguageCode? languageCode)
{
// validate
if (string.IsNullOrWhiteSpace(baseName))
throw new ArgumentException("The asset name can't be null or empty.", nameof(baseName));
if (string.IsNullOrWhiteSpace(localeCode))
localeCode = null;
// set base values
this.BaseName = PathUtilities.NormalizeAssetName(baseName);
this.LocaleCode = localeCode;
this.LanguageCode = languageCode;
// set derived values
this.Name = localeCode != null
? string.Concat(this.BaseName, '.', this.LocaleCode)
: this.BaseName;
this.ComparableName = this.Name.ToLowerInvariant();
}
/// <summary>Parse a raw asset name into an instance.</summary>
/// <param name="rawName">The raw asset name to parse.</param>
/// <param name="parseLocale">Get the language code for a given locale, if it's valid.</param>
/// <exception cref="ArgumentException">The <paramref name="rawName"/> is null or empty.</exception>
public static AssetName Parse(string rawName, Func<string, LocalizedContentManager.LanguageCode?> parseLocale)
{
if (string.IsNullOrWhiteSpace(rawName))
throw new ArgumentException("The asset name can't be null or empty.", nameof(rawName));
string baseName = rawName;
string? localeCode = null;
LocalizedContentManager.LanguageCode? languageCode = null;
int lastPeriodIndex = rawName.LastIndexOf('.');
if (lastPeriodIndex > 0 && rawName.Length > lastPeriodIndex + 1)
{
string possibleLocaleCode = rawName[(lastPeriodIndex + 1)..];
LocalizedContentManager.LanguageCode? possibleLanguageCode = parseLocale(possibleLocaleCode);
if (possibleLanguageCode != null)
{
baseName = rawName[..lastPeriodIndex];
localeCode = possibleLocaleCode;
languageCode = possibleLanguageCode;
}
}
return new AssetName(baseName, localeCode, languageCode);
}
/// <inheritdoc />
public bool IsEquivalentTo(string? assetName, bool useBaseName = false)
{
// empty asset key is never equivalent
if (string.IsNullOrWhiteSpace(assetName))
return false;
assetName = PathUtilities.NormalizeAssetName(assetName);
string compareTo = useBaseName ? this.BaseName : this.Name;
return compareTo.Equals(assetName, StringComparison.OrdinalIgnoreCase);
}
/// <inheritdoc />
public bool IsEquivalentTo(IAssetName? assetName, bool useBaseName = false)
{
if (useBaseName)
return this.BaseName.Equals(assetName?.BaseName, StringComparison.OrdinalIgnoreCase);
if (assetName is AssetName impl)
return this.ComparableName == impl.ComparableName;
return this.Name.Equals(assetName?.Name, StringComparison.OrdinalIgnoreCase);
}
/// <inheritdoc />
public bool StartsWith(string? prefix, bool allowPartialWord = true, bool allowSubfolder = true)
{
// asset keys never start with null
if (prefix is null)
return false;
string rawTrimmed = prefix.Trim();
// asset keys can't have a leading slash, but NormalizeAssetName will trim them
if (rawTrimmed.StartsWith('/') || rawTrimmed.StartsWith('\\'))
return false;
// normalize prefix
{
string normalized = PathUtilities.NormalizeAssetName(prefix);
// keep trailing slash
if (rawTrimmed.EndsWith('/') || rawTrimmed.EndsWith('\\'))
normalized += PathUtilities.PreferredAssetSeparator;
prefix = normalized;
}
// compare
if (prefix.Length == 0)
return true;
return
this.Name.StartsWith(prefix, StringComparison.OrdinalIgnoreCase)
&& (
allowPartialWord
|| this.Name.Length == prefix.Length
|| !char.IsLetterOrDigit(prefix[^1]) // last character in suffix is word separator
|| !char.IsLetterOrDigit(this.Name[prefix.Length]) // or first character after it is
)
&& (
allowSubfolder
|| this.Name.Length == prefix.Length
|| !this.Name[prefix.Length..].Contains(PathUtilities.PreferredAssetSeparator)
);
}
/// <inheritdoc />
public bool IsDirectlyUnderPath(string? assetFolder)
{
if (assetFolder is null)
return false;
return this.StartsWith(assetFolder + "/", allowPartialWord: false, allowSubfolder: false);
}
/// <inheritdoc />
IAssetName IAssetName.GetBaseAssetName()
{
return this.LocaleCode == null
? this
: new AssetName(this.BaseName, null, null);
}
/// <inheritdoc />
public bool Equals(IAssetName? other)
{
return other switch
{
null => false,
AssetName otherImpl => this.ComparableName == otherImpl.ComparableName,
_ => StringComparer.OrdinalIgnoreCase.Equals(this.Name, other.Name)
};
}
/// <inheritdoc />
public override int GetHashCode()
{
return this.ComparableName.GetHashCode();
}
/// <inheritdoc />
public override string ToString()
{
return this.Name;
}
}
}
|
