Feature: Plural and singular translation without complex implementation #15323
Labels
Comments
Sample of personal useStringExtensions.cs// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.
using System.Text.RegularExpressions;
namespace ProjectName.Extensions;
public static partial class StringExtensions
{
// Default resource manager
private static readonly ResourceManager _resourceManager = new("ProjectName.Strings.Resources", typeof(Program).Assembly);
// Default pattern for plural strings
private const string _regexPattern = @"\{\s*(?'index'\d+)\s*,\s*plural\s*,\s*=\s*(?'num'\d+)\s*\{\s*(?'std'[^{]+)\s*\}\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*\}";
// Default string to replace with amount
private const string _replaceString = "#";
// Default regex object for pattern
[GeneratedRegex(_regexPattern, RegexOptions.IgnoreCase | RegexOptions.IgnorePatternWhitespace)]
private static partial Regex ResourceRegex();
private static readonly Regex _regex = ResourceRegex();
/// <summary>
/// Tests if a resource with the specified key exists in the resource manager with the specified culture.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <param name="culture">The culture to use when looking for the resource.</param>
/// <param name="value">The value of the resource, if it exists.</param>
/// <returns>True if the resource exists, false otherwise.</returns>
private static bool ExistsLocalizedResource(this string resKey, CultureInfo culture, out string value)
{
try
{
var keyValue = _resourceManager.GetResourceSet(culture, true, true)?.GetString(resKey);
if (keyValue != null)
{
value = keyValue;
return true;
}
}
catch { }
value = string.Empty;
return false;
}
/// <summary>
/// Gets the plural category for the specified number.
/// </summary>
/// <param name="amount">The number for which to get the plural category.</param>
/// <returns>The plural category for the specified number.</returns>
private static string GetPluralCategory(int amount)
{
if (amount == 1)
{
return "one";
}
else if (amount % 10 >= 2 && amount % 10 <= 4 && (amount % 100 < 10 || amount % 100 >= 20))
{
return "few";
}
else if ((amount % 10 == 0 || (amount % 10 >= 5 && amount % 10 <= 9) || (amount % 100 >= 11 && amount % 100 <= 19)))
{
return "many";
}
else
{
return "other";
}
}
/// <summary>
/// Tests if a resource with the specified key exists in the resource manager with the current UI culture.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <returns>True if the resource exists, false otherwise.</returns>
public static bool ExistsLocalizedResource(this string resKey) => ExistsLocalizedResource(resKey, CultureInfo.CurrentUICulture, out var _);
/// <summary>
/// Gets the localized string for the specified resource key from the resource manager with the specified culture.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <param name="culture">The culture to use when looking for the resource.</param>
/// <returns>The localized string for the resource, or the resource key if the resource could not be found.</returns>
public static string GetLocalizedResource(this string resKey, CultureInfo culture) => ExistsLocalizedResource(resKey, culture, out string value) ? value : resKey;
/// <summary>
/// Gets the localized string for the specified resource key from the resource manager with the current UI culture.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <returns>The localized string for the resource, or the resource key if the resource could not be found.</returns>
public static string GetLocalizedResource(this string resKey) => GetLocalizedResource(resKey, CultureInfo.CurrentUICulture);
/// <summary>
/// Gets the plural localized resource for the specified resource key and culture, using the specified amounts.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <param name="culture">The culture to use when looking for the resource.</param>
/// <param name="amounts">The amounts to use for pluralization.</param>
/// <returns>The pluralized localized resource for the specified key and culture.</returns>
public static string GetPluralLocalizedResource(this string resKey, CultureInfo culture, params int[] amounts)
{
var res = GetLocalizedResource(resKey, culture);
var matches = _regex.Matches(res);
if (matches.Count == 0)
{
return res;
}
foreach (var match in matches.Cast<Match>())
{
var index = int.Parse(match.Groups["index"].Value);
var num = int.Parse(match.Groups["num"].Value);
if (amounts[index] == num)
{
var std = match.Groups["std"].Value;
res = res.ReplaceFirst(match.Groups[0].Value, std.ReplaceFirst(_replaceString, amounts[index].ToString()));
continue;
}
for (int i = 1; i < match.Groups.Count; i += 2)
{
var groupName = match.Groups[i].Value;
var groupText = match.Groups[i + 1].Value;
if (groupName == GetPluralCategory(amounts[index]) || groupName == "other")
{
res = res.ReplaceFirst(match.Groups[0].Value, groupText.ReplaceFirst(_replaceString, amounts[index].ToString()).TrimEnd());
break;
}
}
}
return res;
}
/// <summary>
/// Gets the plural localized resource for the specified resource key and culture, using the specified amounts with the current UI culture.
/// </summary>
/// <param name="resKey">The key of the resource to look for.</param>
/// <param name="amounts">The amounts to use for pluralization.</param>
/// <returns>The pluralized localized resource for the specified key and culture.</returns>
public static string GetPluralLocalizedResource(this string resKey, params int[] amounts) => GetPluralLocalizedResource(resKey, CultureInfo.CurrentUICulture, amounts);
/// <summary>
/// Replaces the first occurrence of a specified string with another specified string in a given string.
/// </summary>
/// <param name="str">The given string.</param>
/// <param name="oldValue">The string to be replaced.</param>
/// <param name="newValue">The new string to replace the old string.</param>
/// <returns>A string that is identical to the given string except that the first occurrence of oldValue is replaced with newValue.</returns>
public static string ReplaceFirst(this string str, string oldValue, string newValue)
{
int position = str.IndexOf(oldValue);
if (position < 0)
{
return str;
}
str = string.Concat(str.AsSpan(0, position), newValue, str.AsSpan(position + oldValue.Length));
return str;
}
}Example using in code// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.
// Test New Version
CultureInfo.CurrentUICulture = new("en-US");
string[] testStrings = ["CreateShortcutDescription", "UnpinFolderFromSidebarDescription"];
foreach (string testString in testStrings)
{
Console.WriteLine($"KEY: {testString}");
Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
Console.WriteLine($"\nResult:\n");
for (int i = 1; i <= 10; i++)
{
Console.WriteLine($"NUM:{i}\t->\t{testString.GetPluralLocalizedResource(i)}");
}
Console.WriteLine();
}
string[] testStrings2 = ["ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts", "CopyItemsDialogSubtitleMultiple"];
foreach (string testString in testStrings2)
{
Console.WriteLine($"KEY: {testString}");
Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
Console.WriteLine($"\nResult:\n");
for (int i = 0; i <= 10; i++)
{
Console.WriteLine($"NUM:{i}\t->\t{testString.GetPluralLocalizedResource(i,0)}");
}
Console.WriteLine();
}
Console.ReadKey(); |
Testing on real data
SamplesSample A
Sample B
Sample C
Sample D
|
|
@Jay-o-Way do you have any input? |
|
Hm, looks sweet! But not really my expertise... Would be nice as a nuget package? 😉
|
is/are can also:
Test regex101 online work |
MessageFormat
Install NuGetDemo code// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.
// Test With MessageFormat
using Jeffijoe.MessageFormat;
CultureInfo.CurrentUICulture = new("en-US");
var mf = new MessageFormatter(useCache: true, locale: CultureInfo.CurrentUICulture.Name);
string[] testStrings = ["CreateShortcutDescription", "UnpinFolderFromSidebarDescription"];
foreach (string testString in testStrings)
{
Console.WriteLine($"KEY: {testString}");
Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
Console.WriteLine($"\nResult:\n");
for (int i = 1; i <= 10; i++)
{
Console.WriteLine($"NUM:{i}\t->\t{mf.FormatMessage(testString.GetLocalizedResource(), new Dictionary<string, object?> { { "0", i } })}");
}
Console.WriteLine();
}
string[] testStrings2 = ["ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts", "CopyItemsDialogSubtitleMultiple", "FilesReady"];
foreach (string testString in testStrings2)
{
Console.WriteLine($"KEY: {testString}");
Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
Console.WriteLine($"\nResult:\n");
for (int i = 0; i <= 10; i++)
{
Console.WriteLine($"NUM:{i}\t->\t{mf.FormatMessage(testString.GetLocalizedResource(), new Dictionary<string, object?> { { "0", i },{ "1", 0} })}");
}
Console.WriteLine();
}
Console.ReadKey();Results |
|
This has low priority comparing to other urgent issues but definitely worth trying and if someone gonna make a PR for this we are happy to help. |
Personally, I try to find a compromise between speed, compatibility and simplicity. Personally, I am creating my own new project and trying to implement this feature. |
|
The main question about this implementation is if it will cause confusion. This is something we need translators to provide input on as they are the ones putting the time and effort into localizing Files. |
|
We can also start with a couple strings as a test and see how it goes. |
|
@XTorLukas do you want to open a PR using this method for a couple strings so we can get a feel for it? |
|
@yaira2 why not, let's see if the translators know their stuff |
|
I don't think we need string extension for this as Crowdin seems to support ICU message syntax. The issue that should be fixed here is to have this syntax in en-US resources. Btw, it looks like XCode has a brilliant feature for this type of thing called Grammatical Agreement: you can put |
|
@0x5bfa we already agreed to try this approach but if you have a simpler solution, please share the details here so we can track in one place. |
|
@XTorLukas already posted it as a first solution to this, as a second solution to this they suggested to have an extension class. This issue is too crowded to list up. |
|
@0x5bfa can you open a PR for one of them and we can see how it goes (the Status Bar is a good one to start with)? I'd like to keep this issue open as a backup plan. |
I recommend using the MessageFormat solution, I'm trying it out, and it's versatile and can handle text formats like '{0}' or '{num}' |
|
@0x5bfa is already busy with other tasks so if you can help that would be great! |
|
@yaira2 But I don't know the syntax of your code yet, so if a foundation is established, I could start helping. |
|
Each area is different but I think we can start with the Status Bar. |
|
I wrote a prototype of a possible implementation and tested this part for my region where more than two possible values are used: <data name="ItemSelected.Text" xml:space="preserve">
<value>položka vybrána</value>
</data>
<data name="ItemsSelected.Text" xml:space="preserve">
<value>položky vybrány</value>
</data>Change to only one pluralKey with prefix <data name="pItemsSelected.Text" xml:space="preserve">
<value>{0, plural, one {# položka vybrána} few {# položky vybrány} other {# položek vybráno}}</value>
</data>Results: Maybe I'll create a PR for my solution |
|
Looks good to me |
|
Looks absolutely great. We can reduce a number of string resources. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What feature or improvement do you think would benefit Files?
I've got an idea to enhance the efficiency of implementing translation for both plural and singular words in Files.
There's also the option to incorporate prefixes and postfixes.
Sample of examples
Examples of display and use in crowdin
Test RegExr online work
Crowdin ICU message implementation (doc)
The text was updated successfully, but these errors were encountered: