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
|
using System;
using System.Collections.Generic;
using StardewValley;
namespace StardewModdingAPI.Framework
{
/// <summary>Provides translations stored in the mod's <c>i18n</c> folder, with one file per locale (like <c>en.json</c>) containing a flat key => value structure. Translations are fetched with locale fallback, so missing translations are filled in from broader locales (like <c>pt-BR.json</c> < <c>pt.json</c> < <c>default.json</c>).</summary>
internal class TranslationHelper : ITranslationHelper
{
/*********
** Properties
*********/
/// <summary>The name of the relevant mod for error messages.</summary>
private readonly string ModName;
/// <summary>The translations for each locale.</summary>
private readonly IDictionary<string, IDictionary<string, string>> All = new Dictionary<string, IDictionary<string, string>>(StringComparer.InvariantCultureIgnoreCase);
/// <summary>The translations for the current locale, with locale fallback taken into account.</summary>
private IDictionary<string, string> ForLocale;
/*********
** Accessors
*********/
/// <summary>The current locale.</summary>
public string Locale { get; private set; }
/// <summary>The game's current language code.</summary>
public LocalizedContentManager.LanguageCode LocaleEnum { get; private set; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="modName">The name of the relevant mod for error messages.</param>
/// <param name="locale">The initial locale.</param>
/// <param name="languageCode">The game's current language code.</param>
/// <param name="translations">The translations for each locale.</param>
public TranslationHelper(string modName, string locale, LocalizedContentManager.LanguageCode languageCode, IDictionary<string, IDictionary<string, string>> translations)
{
// save data
this.ModName = modName;
foreach (var pair in translations)
this.All[pair.Key] = new Dictionary<string, string>(pair.Value, StringComparer.InvariantCultureIgnoreCase);
// set locale
this.SetLocale(locale, languageCode);
}
/// <summary>Get all translations for the current locale.</summary>
public IDictionary<string, string> GetTranslations()
{
return new Dictionary<string, string>(this.ForLocale, StringComparer.InvariantCultureIgnoreCase);
}
/// <summary>Get a translation for the current locale.</summary>
/// <param name="key">The translation key.</param>
public Translation Translate(string key)
{
this.ForLocale.TryGetValue(key, out string text);
return new Translation(this.ModName, this.Locale, key, text);
}
/// <summary>Set the current locale and precache translations.</summary>
/// <param name="locale">The current locale.</param>
/// <param name="localeEnum">The game's current language code.</param>
internal void SetLocale(string locale, LocalizedContentManager.LanguageCode localeEnum)
{
this.Locale = locale.ToLower().Trim();
this.LocaleEnum = localeEnum;
this.ForLocale = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
foreach (string next in this.GetRelevantLocales(this.Locale))
{
// skip if locale not defined
if (!this.All.TryGetValue(next, out IDictionary<string, string> translations))
continue;
// add missing translations
foreach (var pair in translations)
{
if (!this.ForLocale.ContainsKey(pair.Key))
this.ForLocale.Add(pair);
}
}
}
/*********
** Private methods
*********/
/// <summary>Get the locales which can provide translations for the given locale, in precedence order.</summary>
/// <param name="locale">The locale for which to find valid locales.</param>
private IEnumerable<string> GetRelevantLocales(string locale)
{
// given locale
yield return locale;
// broader locales (like pt-BR => pt)
while (true)
{
int dashIndex = locale.LastIndexOf('-');
if (dashIndex <= 0)
break;
locale = locale.Substring(0, dashIndex);
yield return locale;
}
// default
if (locale != "default")
yield return "default";
}
}
}
|
