Fix #731: Support language representation as LCID used by PFC projects (#734)

Author: tom-englert

src/ResXManager.Infrastructure/CultureHelper.cs

@@ -2,13 +2,23 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Linq;
 
 using TomsToolbox.Essentials;
 
 public static class CultureHelper
 {
+    [return: NotNullIfNotNull("languageName")]
+    public static CultureInfo? CreateCultureInfo(string? languageName)
+    {
+        if (languageName is null)
+            return null;
+
+        return int.TryParse(languageName, out var lcid) ? new CultureInfo(lcid) : new CultureInfo(languageName);
+    }
+
     public static bool IsValidCultureName(string? languageName)
     {
         try
@@ -21,7 +31,7 @@ public static bool IsValidCultureName(string? languageName)
                 return true;
 
             // #376: support Custom dialect resource
-            var culture = new CultureInfo(languageName);
+            var culture = CreateCultureInfo(languageName);
             while (!culture.IsNeutralCulture)
             {
                 culture = culture.Parent;
@@ -79,4 +89,4 @@ private static CultureInfo[] GetSpecificCultures()
         }
     }
 
-}
+}

src/ResXManager.Infrastructure/CultureKey.cs

@@ -3,6 +3,24 @@
 using System;
 using System.Globalization;
 
+public enum CultureRepresentation
+{
+    /// <summary>
+    /// BCP 47 language tag (e.g. "en-US") 
+    /// </summary>
+    Name,
+    /// <summary>
+    /// Windows Language Code Identifier (Lcid)
+    /// </summary>
+    Lcid
+}
+
+public sealed class CultureDefinition(CultureKey cultureKey, CultureRepresentation cultureRepresentation)
+{
+    public CultureKey CultureKey { get; } = cultureKey;
+    public CultureRepresentation CultureRepresentation { get; } = cultureRepresentation;
+}
+
 /// <summary>
 /// A class encapsulating a <see cref="CultureInfo"/>, usable as a key to a dictionary to allow also indexing a <c>null</c> <see cref="CultureInfo"/>.
 /// </summary>
@@ -29,9 +47,9 @@ public override string ToString()
         return ToString(string.Empty);
     }
 
-    public string ToString(string neutralCultureKey)
+    public string ToString(string neutralCultureName)
     {
-        return Culture != null ? "." + Culture.Name : neutralCultureKey;
+        return Culture != null ? "." + Culture.Name : neutralCultureName;
     }
 
     #region IComparable/IEquatable implementation
@@ -178,4 +196,4 @@ public static CultureKey Parse(object? item)
             _ => throw new InvalidOperationException("Unable to cast object to culture key: " + item)
         };
     }
-}
+}

src/ResXManager.Infrastructure/ExtensionMethods.cs

@@ -12,6 +12,14 @@
 
 public static class ExtensionMethods
 {
+    public static string? NullIfEmpty(this string? value)
+    {
+        if (string.IsNullOrEmpty(value))
+            return null;
+
+        return value;
+    }
+
     /// <summary>
     /// Converts the culture key name to the corresponding culture. The key name is the ieft language tag with an optional '.' prefix.
     /// </summary>
@@ -24,15 +32,12 @@ public static class ExtensionMethods
     {
         try
         {
-            cultureKeyName = cultureKeyName?.TrimStart('.');
-
-            return cultureKeyName.IsNullOrEmpty() ? null : CultureInfo.GetCultureInfo(cultureKeyName);
+            return CultureHelper.CreateCultureInfo(cultureKeyName?.TrimStart('.').NullIfEmpty());
         }
-        catch (ArgumentException)
+        catch 
         {
+            throw new InvalidOperationException("Error parsing language: " + cultureKeyName);
         }
-
-        throw new InvalidOperationException("Error parsing language: " + cultureKeyName);
     }
 
     /// <summary>
@@ -46,12 +51,11 @@ public static class ExtensionMethods
     {
         try
         {
-            cultureKeyName = cultureKeyName?.TrimStart('.');
-
-            return new CultureKey(cultureKeyName.IsNullOrEmpty() ? null : CultureInfo.GetCultureInfo(cultureKeyName));
+            return ToCulture(cultureKeyName);
         }
-        catch (ArgumentException)
+        catch
         {
+            // invalid culture, ignore...
         }
 
         return null;
@@ -106,4 +110,4 @@ public static IEnumerable<FileInfo> EnumerateSourceFiles(this DirectoryInfo dire
             }
         }
     }
-}
+}

src/ResXManager.Model/ProjectFileExtensions.cs

@@ -6,7 +6,6 @@
 using System.Linq;
 
 using ResXManager.Infrastructure;
-using TomsToolbox.Essentials;
 
 public static class ProjectFileExtensions
 {
@@ -52,7 +51,7 @@ public static bool IsResourceFile(this ProjectFile projectFile)
         return IsResourceFile(filePath, extension);
     }
 
-    public static CultureKey GetCultureKey(this ProjectFile projectFile, CultureInfo neutralResourcesLanguage)
+    public static CultureDefinition GetCultureDefinition(this ProjectFile projectFile, CultureInfo neutralResourcesLanguage)
     {
         var extension = projectFile.Extension;
         var filePath = projectFile.FilePath;
@@ -62,13 +61,21 @@ public static CultureKey GetCultureKey(this ProjectFile projectFile, CultureInfo
             var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(filePath);
             var cultureName = Path.GetExtension(fileNameWithoutExtension).TrimStart('.');
 
-            if (cultureName.IsNullOrEmpty())
-                return CultureKey.Neutral;
-
             if (!CultureHelper.IsValidCultureName(cultureName))
-                return CultureKey.Neutral;
+                return new(CultureKey.Neutral, CultureRepresentation.Name);
+
+            var cultureKey = new CultureKey(cultureName);
+
+            if (!int.TryParse(cultureName, NumberStyles.Integer, CultureInfo.InvariantCulture, out var lcid))
+                return new(cultureKey, CultureRepresentation.Name);
+
+            if (Equals(neutralResourcesLanguage, CultureInfo.GetCultureInfo(lcid)))
+            {
+                return new(CultureKey.Neutral, CultureRepresentation.Lcid);
+            }
+
+            return new(cultureKey, CultureRepresentation.Lcid);
 
-            return new CultureKey(cultureName);
         }
 
         if (Resw.Equals(extension, StringComparison.OrdinalIgnoreCase))
@@ -80,7 +87,9 @@ public static CultureKey GetCultureKey(this ProjectFile projectFile, CultureInfo
 
             var culture = cultureName.ToCulture();
 
-            return Equals(neutralResourcesLanguage, culture) ? CultureKey.Neutral : new CultureKey(culture);
+            var cultureKey = Equals(neutralResourcesLanguage, culture) ? CultureKey.Neutral : new CultureKey(culture);
+
+            return new(cultureKey, CultureRepresentation.Name);
         }
 
         throw new InvalidOperationException("Unsupported file format: " + extension);
@@ -101,14 +110,30 @@ public static string GetBaseName(this ProjectFile projectFile)
         return CultureHelper.IsValidCultureName(languageName) ? Path.GetFileNameWithoutExtension(name) : name;
     }
 
-    public static string GetLanguageFileName(this ProjectFile projectFile, CultureInfo culture)
+    public static string GetLanguageFileName(this ResourceLanguage neutralLanguage, CultureInfo culture)
     {
+        var projectFile = neutralLanguage.ProjectFile;
+
         var extension = projectFile.Extension;
         var filePath = projectFile.FilePath;
 
         if (Resx.Equals(extension, StringComparison.OrdinalIgnoreCase))
         {
-            return Path.ChangeExtension(filePath, culture.ToString()) + @".resx";
+            var baseName = Path.ChangeExtension(filePath, null);
+            string cultureTag;
+
+            if (neutralLanguage.CultureRepresentation == CultureRepresentation.Lcid)
+            {
+                // Neutral LCID based resource also includes a language tag in the file, e.g. "Strings.1033.resx" - else we would not have classified it as LCID based.
+                baseName = Path.ChangeExtension(baseName, null);
+                cultureTag = culture.LCID.ToString("D", CultureInfo.InvariantCulture);
+            }
+            else
+            {
+                cultureTag = culture.Name;
+            }
+
+            return $"{baseName}.{cultureTag}.resx";
         }
 
         if (Resw.Equals(extension, StringComparison.OrdinalIgnoreCase))
@@ -134,4 +159,4 @@ public static bool IsCSharpFile(this ProjectFile projectFile)
     {
         return Path.GetExtension(projectFile.FilePath).Equals(".cs", StringComparison.OrdinalIgnoreCase);
     }
-}
+}

src/ResXManager.Model/ResourceEntity.cs

@@ -36,7 +36,7 @@ internal ResourceEntity(ResourceManager container, string projectName, string ba
         RelativePath = GetRelativePath(files);
         DisplayName = projectName + @" - " + RelativePath + baseName;
 
-        NeutralProjectFile = files.FirstOrDefault(file => file.GetCultureKey(neutralResourcesLanguage) == CultureKey.Neutral);
+        NeutralProjectFile = files.FirstOrDefault(file => file.GetCultureDefinition(neutralResourcesLanguage).CultureKey == CultureKey.Neutral);
         NeutralResourcesLanguage = neutralResourcesLanguage;
 
         var entriesQuery = _languages.Values
@@ -56,7 +56,7 @@ internal bool Update(ICollection<ProjectFile> files, CultureInfo neutralResource
         if (!MergeItems(GetResourceLanguages(files, neutralResourcesLanguage, duplicateKeyHandling)))
             return false; // nothing has changed, no need to continue
 
-        var neutralProjectFile = files.FirstOrDefault(file => file.GetCultureKey(neutralResourcesLanguage) == CultureKey.Neutral);
+        var neutralProjectFile = files.FirstOrDefault(file => file.GetCultureDefinition(neutralResourcesLanguage).CultureKey == CultureKey.Neutral);
 
         UpdateResourceTableEntries();
 
@@ -69,7 +69,7 @@ public bool Update(ProjectFile file, [NotNullWhen(true)] out ResourceLanguage? u
     {
         var duplicateKeyHandling = Container.Configuration.DuplicateKeyHandling;
 
-        updatedLanguage = new ResourceLanguage(this, file.GetCultureKey(NeutralResourcesLanguage), file, duplicateKeyHandling);
+        updatedLanguage = new ResourceLanguage(this, file.GetCultureDefinition(NeutralResourcesLanguage), file, duplicateKeyHandling);
         if (!UpdateEntry(updatedLanguage))
         {
             updatedLanguage = null;
@@ -216,10 +216,10 @@ public void Remove(ResourceTableEntry item)
     /// <param name="file">The file.</param>
     public void AddLanguage(ProjectFile file)
     {
-        var cultureKey = file.GetCultureKey(NeutralResourcesLanguage);
-        var resourceLanguage = new ResourceLanguage(this, cultureKey, file, Container.Configuration.DuplicateKeyHandling);
+        var cultureKeyInfo = file.GetCultureDefinition(NeutralResourcesLanguage);
+        var resourceLanguage = new ResourceLanguage(this, cultureKeyInfo, file, Container.Configuration.DuplicateKeyHandling);
 
-        _languages.Add(cultureKey, resourceLanguage);
+        _languages.Add(cultureKeyInfo.CultureKey, resourceLanguage);
         _resourceTableEntries.ForEach(entry => entry.Refresh());
 
         Container.OnLanguageAdded(resourceLanguage, file);
@@ -295,11 +295,11 @@ internal bool EqualsAll(string? projectName, string? baseName, string? directory
 
     private IDictionary<CultureKey, ResourceLanguage> GetResourceLanguages(IEnumerable<ProjectFile> files, CultureInfo neutralResourcesLanguage, DuplicateKeyHandling duplicateKeyHandling)
     {
-        var languageQuery =
-            from file in files
-            let cultureKey = file.GetCultureKey(neutralResourcesLanguage)
-            orderby cultureKey
-            select new ResourceLanguage(this, cultureKey, file, duplicateKeyHandling);
+        var languageQuery = files
+            .Select(file => new { file, cultureKeyInfo = file.GetCultureDefinition(neutralResourcesLanguage) })
+            .OrderBy(item => item.cultureKeyInfo.CultureKey.IsNeutral ? 0 : 1)
+            .ThenBy(item => item.cultureKeyInfo.CultureKey)
+            .Select(item => new ResourceLanguage(this, item.cultureKeyInfo, item.file, duplicateKeyHandling));
 
         var languages = languageQuery.ToDictionary(language => language.CultureKey);
 
@@ -356,4 +356,4 @@ private bool UpdateEntry(ResourceLanguage source)
         _languages[cultureKey] = source;
         return true;
     }
-}
+}

src/ResXManager.Model/ResourceLanguage.cs

@@ -43,16 +43,17 @@ public class ResourceLanguage
     /// Initializes a new instance of the <see cref="ResourceLanguage" /> class.
     /// </summary>
     /// <param name="container">The containing resource entity.</param>
-    /// <param name="cultureKey">The culture key.</param>
+    /// <param name="cultureDefinition">Culture key and representation.</param>
     /// <param name="file">The .resx file having all the localization.</param>
     /// <param name="duplicateKeyHandling">The duplicate key handling.</param>
     /// <exception cref="InvalidOperationException">
     /// </exception>
     /// <exception cref="InvalidOperationException"></exception>
-    internal ResourceLanguage(ResourceEntity container, CultureKey cultureKey, ProjectFile file, DuplicateKeyHandling duplicateKeyHandling)
+    internal ResourceLanguage(ResourceEntity container, CultureDefinition cultureDefinition, ProjectFile file, DuplicateKeyHandling duplicateKeyHandling)
     {
         Container = container;
-        CultureKey = cultureKey;
+        CultureKey = cultureDefinition.CultureKey;
+        CultureRepresentation = cultureDefinition.CultureRepresentation;
         ProjectFile = file;
         _configuration = container.Container.Configuration;
 
@@ -130,6 +131,8 @@ private void UpdateNodes(DuplicateKeyHandling duplicateKeyHandling)
 
     public bool IsNeutralLanguage => Container.Languages.FirstOrDefault() == this;
 
+    public CultureRepresentation CultureRepresentation { get; }
+
     public CultureKey CultureKey { get; }
 
     public ResourceEntity Container { get; }
@@ -602,4 +605,4 @@ private XAttribute GetNameAttribute(XElement entry)
             return nameAttribute ?? throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, Resources.InvalidResourceFileNameAttributeMissingError, _owner.ProjectFile.FilePath));
         }
     }
-}
+}

src/ResXManager.Model/ResourceManagerExtensions.cs

@@ -27,7 +27,7 @@ void EnumerationShouldContinue()
 
         var allProjectFiles = fileInfos
             .Select(item => item.Intercept(_ => EnumerationShouldContinue()))
-            .Select(fileInfo => new ProjectFile(fileInfo.FullName, solutionFolder.FullName, @"<unknown>", null))
+            .Select(fileInfo => new ProjectFile(fileInfo.FullName, solutionFolder.FullName, "<unknown>", null))
             .Where(fileFilter.Matches)
             .ToList();
 
@@ -87,4 +87,4 @@ void EnumerationShouldContinue()
 
         return null;
     }
-}
+}

src/ResXManager.Scripting/Host.cs

@@ -142,7 +142,7 @@ private bool CanEdit(ResourceEntity entity, CultureKey? cultureKey)
         if (neutralLanguage == null)
             return false;
 
-        var languageFileName = neutralLanguage.ProjectFile.GetLanguageFileName(culture);
+        var languageFileName = neutralLanguage.GetLanguageFileName(culture);
 
         if (!File.Exists(languageFileName))
         {

src/ResXManager.Tests/ResXManager.Tests.csproj

@@ -34,4 +34,10 @@
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
+
+  <ItemGroup>
+    <Content Update="Resources\Lcid\Lcid.1033.resx">
+      <Generator></Generator>
+    </Content>
+  </ItemGroup>
 </Project>