Initial changes for globalization hybrid mode

docs/workflow/trimming/feature-switches.md

@@ -14,6 +14,7 @@ configurations but their defaults might vary as any SDK can set the defaults dif
 | EventSourceSupport | System.Diagnostics.Tracing.EventSource.IsSupported | Any EventSource related code or logic is trimmed when set to false |
 | InvariantGlobalization | System.Globalization.Invariant | All globalization specific code and data is trimmed when set to true |
 | PredefinedCulturesOnly | System.Globalization.PredefinedCulturesOnly |  Don't allow creating a culture for which the platform does not have data |
+| HybridGlobalization | System.Globalization.Hybrid |  Loading ICU + native implementations |
 | UseSystemResourceKeys | System.Resources.UseSystemResourceKeys |  Any localizable resources for system assemblies is trimmed when set to true |
 | HttpActivityPropagationSupport | System.Net.Http.EnableActivityPropagation | Any dependency related to diagnostics support for System.Net.Http is trimmed when set to false |
 | UseNativeHttpHandler | System.Net.Http.UseNativeHttpHandler | HttpClient uses by default platform native implementation of HttpMessageHandler if set to true. |

eng/testing/tests.ioslike.targets

@@ -98,6 +98,7 @@
          library test project. Eg. $(InvariantGlobalization) -->
     <ItemGroup>
       <_ApplePropertyNames Include="InvariantGlobalization" />
+      <_ApplePropertyNames Include="HybridGlobalization" />
       <_ApplePropertyNames Include="AssemblyName" />
       <_ApplePropertyNames Include="MonoEnableLLVM" />
 

src/libraries/Common/src/Interop/Interop.Locale.iOS.cs

@@ -0,0 +1,17 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.InteropServices;
+using System;
+
+internal static partial class Interop
+{
+    internal static partial class Globalization
+    {
+        [LibraryImport(Libraries.GlobalizationNative, EntryPoint = "NativeGetLocaleName", StringMarshalling = StringMarshalling.Utf16)]
+        internal static unsafe partial string NativeGetLocaleName(string localeName, int valueLength);
+
+        [LibraryImport(Libraries.GlobalizationNative, EntryPoint = "NativeGetLocaleInfoString", StringMarshalling = StringMarshalling.Utf8)]
+        internal static unsafe partial string NativeGetLocaleInfoString(string localeName, uint localeStringData, int valueLength, string? uiLocaleName = null);
+    }
+}

src/libraries/Common/tests/TestUtilities/System/PlatformDetection.cs

@@ -348,13 +348,17 @@ public static string GetDistroVersionString()
         private static readonly Lazy<bool> m_isInvariant = new Lazy<bool>(()
             => (bool?)Type.GetType("System.Globalization.GlobalizationMode")?.GetProperty("Invariant", BindingFlags.NonPublic | BindingFlags.Static)?.GetValue(null) == true);
 
+        private static readonly Lazy<bool> m_isHybrid = new Lazy<bool>(()
+            => (bool?)Type.GetType("System.Globalization.GlobalizationMode")?.GetProperty("Hybrid", BindingFlags.NonPublic | BindingFlags.Static)?.GetValue(null) == true);
+
         private static readonly Lazy<Version> m_icuVersion = new Lazy<Version>(GetICUVersion);
         public static Version ICUVersion => m_icuVersion.Value;
 
         public static bool IsInvariantGlobalization => m_isInvariant.Value;
         public static bool IsNotInvariantGlobalization => !IsInvariantGlobalization;
         public static bool IsIcuGlobalization => ICUVersion > new Version(0, 0, 0, 0);
         public static bool IsNlsGlobalization => IsNotInvariantGlobalization && !IsIcuGlobalization;
+        public static bool IsHybridGlobalization => m_isHybrid.Value;
 
         public static bool IsSubstAvailable
         {

src/libraries/System.Globalization/tests/Hybrid/Hybrid.Tests.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
+    <TestRuntime>true</TestRuntime>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <InvariantGlobalization>false</InvariantGlobalization>
+    <PredefinedCulturesOnly>false</PredefinedCulturesOnly>
+    <HybridGlobalization>true</HybridGlobalization>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="HybridMode.cs" />
+  </ItemGroup>
+</Project>

src/libraries/System.Globalization/tests/Hybrid/HybridMode.cs

@@ -0,0 +1,63 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Buffers;
+using System.Reflection;
+using System.Buffers.Binary;
+using System.Collections.Generic;
+using System.IO;
+using System.Runtime.InteropServices;
+using System.Text;
+using Xunit;
+
+namespace System.Globalization.Tests
+{
+    public class HybridModeTests
+    {
+        public static IEnumerable<object[]> EnglishName_TestData()
+        {
+            yield return new object[] { "en-US", "English (United States)" };
+            yield return new object[] { "fr-FR", "French (France)" };
+        }
+
+        public static IEnumerable<object[]> NativeName_TestData()
+        {
+            yield return new object[] { "en-US", "English (United States)" };
+            yield return new object[] { "fr-FR", "français (France)" };
+            yield return new object[] { "en-CA", "English (Canada)" };
+        }
+
+        [Theory]
+        [MemberData(nameof(EnglishName_TestData))]
+        public void TestEnglishName(string cultureName, string expected)
+        {
+            CultureInfo myTestCulture = new CultureInfo(cultureName);
+            Assert.Equal(expected, myTestCulture.EnglishName);
+        }
+
+        [Theory]
+        [MemberData(nameof(NativeName_TestData))]
+        public void TestNativeName(string cultureName, string expected)
+        {
+            CultureInfo myTestCulture = new CultureInfo(cultureName);
+            Assert.Equal(expected, myTestCulture.NativeName);
+        }
+
+        [Theory]
+        [InlineData("de-DE", "de")]
+        [InlineData("en-US", "en")]
+        public void TwoLetterISOLanguageName(string name, string expected)
+        {
+            Assert.Equal(expected, new CultureInfo(name).TwoLetterISOLanguageName);
+        }
+
+        [Theory]
+        [InlineData("de-DE", "Deutsch (Deutschland)", "de (DE)")]
+        public void TestDisplayName(string cultureName, string nativeName, string englishDisplayName)
+        {
+                CultureInfo ci = CultureInfo.GetCultureInfo(cultureName);
+                Assert.Equal(nativeName, ci.NativeName);
+                Assert.Equal(englishDisplayName, ci.DisplayName);
+        }
+    }
+}

src/libraries/System.Private.CoreLib/src/ILLink/ILLink.Substitutions.Shared.xml

@@ -10,10 +10,12 @@
          to be trimmed when Invariant=true, and allows for the Settings static cctor (on Unix) to be preserved when Invariant=false. -->
     <type fullname="System.Globalization.GlobalizationMode">
       <method signature="System.Boolean get_Invariant()" body="stub" value="true" feature="System.Globalization.Invariant" featurevalue="true" />
+      <method signature="System.Boolean get_Hybrid()" body="stub" value="true" feature="System.Globalization.Hybrid" featurevalue="true" />
       <method signature="System.Boolean get_PredefinedCulturesOnly()" body="stub" value="true" feature="System.Globalization.PredefinedCulturesOnly" featurevalue="true" />
     </type>
     <type fullname="System.Globalization.GlobalizationMode/Settings">
       <method signature="System.Boolean get_Invariant()" body="stub" value="false" feature="System.Globalization.Invariant" featurevalue="false" />
+      <method signature="System.Boolean get_Hybrid()" body="stub" value="tue" feature="System.Globalization.Hybrid" featurevalue="true" />
     </type>
     <type fullname="System.LocalAppContextSwitches">
       <method signature="System.Boolean get_EnableUnsafeUTF7Encoding()" body="stub" value="false" feature="System.Text.Encoding.EnableUnsafeUTF7Encoding" featurevalue="false" />

src/libraries/System.Private.CoreLib/src/System.Private.CoreLib.Shared.projitems

@@ -346,6 +346,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareOptions.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.Icu.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.iOS.cs" Condition="'$(IsiOSLike)' == 'true'" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.Nls.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureInfo.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureNotFoundException.cs" />
@@ -1277,6 +1278,9 @@
     <Compile Include="$(CommonPath)Interop\Interop.Locale.cs">
       <Link>Common\Interop\Interop.Locale.cs</Link>
     </Compile>
+    <Compile Include="$(CommonPath)Interop\Interop.Locale.iOS.cs" Condition="'$(IsiOSLike)' == 'true'">
+      <Link>Common\Interop\Interop.Locale.iOS.cs</Link>
+    </Compile>
     <Compile Include="$(CommonPath)Interop\Interop.Normalization.cs">
       <Link>Common\Interop\Interop.Normalization.cs</Link>
     </Compile>

src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.cs

@@ -2303,7 +2303,11 @@ private string GetLocaleInfoCoreUserOverride(LocaleStringData type)
             // This is never reached but helps illinker statically remove dependencies
             if (GlobalizationMode.Invariant)
                 return null!;
-
+#if TARGET_IOS
+            return ShouldUseUserOverrideNlsData ? NlsGetLocaleInfo(type)
+                                                : GlobalizationMode.Hybrid ? NativeGetLocaleInfo(type)
+                                                : IcuGetLocaleInfo(type);
+#endif
             return ShouldUseUserOverrideNlsData ? NlsGetLocaleInfo(type) : IcuGetLocaleInfo(type);
         }
 
@@ -2312,16 +2316,24 @@ private string GetLocaleInfoCore(LocaleStringData type, string? uiCultureName =
             // This is never reached but helps illinker statically remove dependencies
             if (GlobalizationMode.Invariant)
                 return null!;
-
-            return GlobalizationMode.UseNls ? NlsGetLocaleInfo(type) : IcuGetLocaleInfo(type, uiCultureName);
+#if TARGET_IOS
+            return GlobalizationMode.UseNls ? NlsGetLocaleInfo(type)
+                                            : GlobalizationMode.Hybrid ? NativeGetLocaleInfo(type, uiCultureName)
+                                            : IcuGetLocaleInfo(type, uiCultureName);
+#endif
+        return GlobalizationMode.UseNls ? NlsGetLocaleInfo(type) : IcuGetLocaleInfo(type, uiCultureName);
         }
 
         private string GetLocaleInfoCore(string localeName, LocaleStringData type, string? uiCultureName = null)
         {
             // This is never reached but helps illinker statically remove dependencies
             if (GlobalizationMode.Invariant)
                 return null!;
-
+#if TARGET_IOS
+            return GlobalizationMode.UseNls ? NlsGetLocaleInfo(localeName, type)
+                                            : GlobalizationMode.Hybrid ? NativeGetLocaleInfo(localeName, type, uiCultureName)
+                                            : IcuGetLocaleInfo(localeName, type, uiCultureName);
+#endif
             return GlobalizationMode.UseNls ? NlsGetLocaleInfo(localeName, type) : IcuGetLocaleInfo(localeName, type, uiCultureName);
         }
 

src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.iOS.cs

@@ -0,0 +1,59 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+using System.Text;
+using System.Runtime.InteropServices;
+
+namespace System.Globalization
+{
+    internal sealed partial class CultureData
+    {
+        // Native constants, check if we need this for native
+        private const int Native_ULOC_KEYWORD_AND_VALUES_CAPACITY = 100; // max size of keyword or value
+        private const int Native_ULOC_FULLNAME_CAPACITY = 157;           // max size of locale name
+
+        /// <summary>
+        /// This method uses the sRealName field (which is initialized by the constructor before this is called) to
+        /// initialize the rest of the state of CultureData based on the underlying OS globalization library.
+        /// </summary>
+        private bool InitNativeCultureDataCore()
+        {
+            Debug.Assert(_sRealName != null);
+            Debug.Assert(!GlobalizationMode.Invariant);
+            string realNameBuffer = _sRealName;
+
+            // Get the locale name
+            NativeGetLocaleName(realNameBuffer, out _sWindowsName);
+            return true;
+        }
+
+        internal static unsafe bool NativeGetLocaleName(string localeName, out string? windowsName)
+        {
+            windowsName = Interop.Globalization.NativeGetLocaleName(localeName, Native_ULOC_FULLNAME_CAPACITY);
+            return true;
+        }
+
+        private string NativeGetLocaleInfo(LocaleStringData type, string? uiCultureName = null)
+        {
+            Debug.Assert(!GlobalizationMode.Invariant);
+            Debug.Assert(!GlobalizationMode.UseNls);
+            Debug.Assert(_sWindowsName != null, "[CultureData.NativeGetLocaleInfo] Expected _sWindowsName to be populated already");
+
+            return NativeGetLocaleInfo(_sWindowsName, type, uiCultureName);
+        }
+
+        // For LOCALE_SPARENT we need the option of using the "real" name (forcing neutral names) instead of the
+        // "windows" name, which can be specific for downlevel (< windows 7) os's.
+        private static unsafe string NativeGetLocaleInfo(string localeName, LocaleStringData type, string? uiCultureName = null)
+        {
+            Debug.Assert(!GlobalizationMode.UseNls);
+            Debug.Assert(localeName != null, "[CultureData.NativeGetLocaleInfo] Expected localeName to be not be null");
+
+            string result = Interop.Globalization.NativeGetLocaleInfoString(localeName, (uint)type, Native_ULOC_KEYWORD_AND_VALUES_CAPACITY, uiCultureName);
+            return result;
+        }
+    }
+}

src/libraries/System.Private.CoreLib/src/System/Globalization/GlobalizationMode.cs

@@ -13,13 +13,15 @@ internal static partial class GlobalizationMode
         private static partial class Settings
         {
             internal static bool Invariant { get; } = AppContextConfigHelper.GetBooleanConfig("System.Globalization.Invariant", "DOTNET_SYSTEM_GLOBALIZATION_INVARIANT");
+            internal static bool Hybrid { get; } = AppContextConfigHelper.GetBooleanConfig("System.Globalization.Hybrid", "DOTNET_SYSTEM_GLOBALIZATION_HYBRID");
             internal static bool PredefinedCulturesOnly { get; } = AppContextConfigHelper.GetBooleanConfig("System.Globalization.PredefinedCulturesOnly", "DOTNET_SYSTEM_GLOBALIZATION_PREDEFINED_CULTURES_ONLY", GlobalizationMode.Invariant);
         }
 
         // Note: Invariant=true and Invariant=false are substituted at different levels in the ILLink.Substitutions file.
         // This allows for the whole Settings nested class to be trimmed when Invariant=true, and allows for the Settings
         // static cctor (on Unix) to be preserved when Invariant=false.
         internal static bool Invariant => Settings.Invariant;
+        internal static bool Hybrid => Settings.Hybrid;
         internal static bool PredefinedCulturesOnly => Settings.PredefinedCulturesOnly;
 
         private static bool TryGetAppLocalIcuSwitchValue([NotNullWhen(true)] out string? value) =>

src/mono/msbuild/apple/build/AppleApp.targets

@@ -151,6 +151,7 @@
         ForceInterpreter="$(MonoForceInterpreter)"
         EnableAppSandbox="$(EnableAppSandbox)"
         InvariantGlobalization="$(InvariantGlobalization)"
+        HybridGlobalization="$(HybridGlobalization)"
         UseConsoleUITemplate="True"
         GenerateXcodeProject="$(GenerateXcodeProject)"
         GenerateCMakeProject="$(GenerateCMakeProject)"

src/native/libs/System.Globalization.Native/entrypoints.c

@@ -58,6 +58,10 @@ static const Entry s_globalizationNative[] =
     DllImportEntry(GlobalizationNative_ToAscii)
     DllImportEntry(GlobalizationNative_ToUnicode)
     DllImportEntry(GlobalizationNative_WindowsIdToIanaId)
+#if defined(TARGET_MACCATALYST) || defined(TARGET_IOS) || defined(TARGET_TVOS)
+    DllImportEntry(NativeGetLocaleName)
+    DllImportEntry(NativeGetLocaleInfoString)
+#endif
 };
 
 EXTERN_C const void* GlobalizationResolveDllImport(const char* name);

src/native/libs/System.Globalization.Native/pal_locale.h

@@ -9,6 +9,8 @@ PALEXPORT int32_t GlobalizationNative_GetLocales(UChar *value, int32_t valueLeng
 
 PALEXPORT int32_t GlobalizationNative_GetLocaleName(const UChar* localeName, UChar* value, int32_t valueLength);
 
+PALEXPORT const char* NativeGetLocaleName(const char* localeName, int32_t valueLength);
+
 PALEXPORT int32_t GlobalizationNative_GetDefaultLocaleName(UChar* value, int32_t valueLength);
 
 PALEXPORT int32_t GlobalizationNative_IsPredefinedLocale(const UChar* localeName);