[OSX] HybridGlobalization implement compare native function

src/libraries/Common/src/Interop/Interop.Collation.OSX.cs

@@ -0,0 +1,16 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Globalization;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class Globalization
+    {
+        [LibraryImport(Libraries.GlobalizationNative, EntryPoint = "GlobalizationNative_CompareStringNative", StringMarshalling = StringMarshalling.Utf8)]
+        internal static unsafe partial int CompareStringNative(string localeName, char* lpStr1, int cwStr1Len, char* lpStr2, int cwStr2Len, CompareOptions options);
+    }
+}

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

@@ -356,6 +356,7 @@ public static string GetDistroVersionString()
 
         public static bool IsInvariantGlobalization => m_isInvariant.Value;
         public static bool IsHybridGlobalizationOnBrowser => m_isHybrid.Value && IsBrowser;
+        public static bool IsHybridGlobalizationOnOSX => m_isHybrid.Value && (IsOSX || IsMacCatalyst || IsiOS || IstvOS);
         public static bool IsNotHybridGlobalizationOnBrowser => !IsHybridGlobalizationOnBrowser;
         public static bool IsNotInvariantGlobalization => !IsInvariantGlobalization;
         public static bool IsIcuGlobalization => ICUVersion > new Version(0, 0, 0, 0);

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

@@ -32,5 +32,7 @@
     <Compile Include="..\NumberFormatInfo\NumberFormatInfoPercentNegativePattern.cs" />
     <Compile Include="..\NumberFormatInfo\NumberFormatInfoPercentGroupSizes.cs" />
     <Compile Include="..\NumberFormatInfo\NumberFormatInfoPercentPositivePattern.cs" />
+    <Compile Include="..\CompareInfo\CompareInfoTestsBase.cs" />
+    <Compile Include="..\CompareInfo\CompareInfoTests.Compare.cs" />
   </ItemGroup>
 </Project>

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

@@ -328,6 +328,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareInfo.Invariant.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareInfo.Nls.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareInfo.WebAssembly.cs" Condition="'$(TargetsBrowser)' == 'true'" />
+    <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareInfo.OSX.cs" Condition="'$(IsOSXLike)' == 'true'" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CompareOptions.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)System\Globalization\CultureData.Icu.cs" />
@@ -1264,6 +1265,9 @@
     </Compile>
     <Compile Include="$(CommonPath)Interop\Interop.Collation.cs">
       <Link>Common\Interop\Interop.Collation.cs</Link>
+    </Compile>
+     <Compile Include="$(CommonPath)Interop\Interop.Collation.OSX.cs" Condition="'$(IsOSXLike)' == 'true'">
+      <Link>Common\Interop\Interop.Collation.OSX.cs</Link>
     </Compile>
     <Compile Include="$(CommonPath)Interop\Interop.ICU.cs">
       <Link>Common\Interop\Interop.ICU.cs</Link>

src/libraries/System.Private.CoreLib/src/System/Globalization/CompareInfo.OSX.cs

@@ -0,0 +1,34 @@
+// 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.Collections.Generic;
+using System.Diagnostics;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace System.Globalization
+{
+    public partial class CompareInfo
+    {
+        private unsafe int CompareStringNative(ReadOnlySpan<char> string1, ReadOnlySpan<char> string2, CompareOptions options)
+        {
+            Debug.Assert(!GlobalizationMode.Invariant);
+            Debug.Assert(!GlobalizationMode.UseNls);
+            Debug.Assert((options & (CompareOptions.Ordinal | CompareOptions.OrdinalIgnoreCase)) == 0);
+            string cultureName = m_name;
+
+            // GetReference may return nullptr if the input span is defaulted. The native layer handles
+            // this appropriately; no workaround is needed on the managed side.
+
+            fixed (char* pString1 = &MemoryMarshal.GetReference(string1))
+            fixed (char* pString2 = &MemoryMarshal.GetReference(string2))
+            {
+                System.Diagnostics.Debug.Write("Collation CompareStringNative is called for culture: " + cultureName + "string1: " + string1.ToString() + "string2: " + string2.ToString() + "\n");
+                var result = Interop.Globalization.CompareStringNative(cultureName, pString1, string1.Length, pString2, string2.Length, options);
+                System.Diagnostics.Debug.Write("Collation CompareStringNative result: " + result + "\n");
+                return result;
+            }
+        }
+    }
+}

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

@@ -490,6 +490,9 @@ private unsafe int CompareStringCore(ReadOnlySpan<char> string1, ReadOnlySpan<ch
 #if TARGET_BROWSER
             GlobalizationMode.Hybrid ?
                 JsCompareString(string1, string2, options) :
+#elif TARGET_OSX || TARGET_MACCATALYST || TARGET_IOS || TARGET_TVOS
+            GlobalizationMode.Hybrid ?
+                CompareStringNative(string1, string2, options) :
 #endif
                 IcuCompareString(string1, string2, options);
 

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

@@ -59,6 +59,7 @@ static const Entry s_globalizationNative[] =
     DllImportEntry(GlobalizationNative_ToUnicode)
     DllImportEntry(GlobalizationNative_WindowsIdToIanaId)
 #ifdef __APPLE__
+    DllImportEntry(GlobalizationNative_CompareStringNative)
     DllImportEntry(GlobalizationNative_GetLocaleNameNative)
     DllImportEntry(GlobalizationNative_GetLocaleInfoStringNative)
     DllImportEntry(GlobalizationNative_GetLocaleInfoIntNative)

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

@@ -61,3 +61,12 @@ PALEXPORT int32_t GlobalizationNative_GetSortKey(SortHandle* pSortHandle,
                                                  uint8_t* sortKey,
                                                  int32_t cbSortKeyLength,
                                                  int32_t options);
+
+#ifdef __APPLE__
+PALEXPORT int32_t GlobalizationNative_CompareStringNative(const char* localeName,
+                                                          const char* lpStr1,
+                                                          int32_t cwStr1Length,
+                                                          const char* lpStr2,
+                                                          int32_t cwStr2Length,
+                                                          int32_t options);
+#endif

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

@@ -5,6 +5,7 @@
 #include "pal_locale_internal.h"
 #include "pal_localeStringData.h"
 #include "pal_localeNumberData.h"
+#include "pal_collation.h"
 
 #import <Foundation/Foundation.h>
 #import <Foundation/NSFormatter.h>
@@ -568,6 +569,131 @@ Returns time format information (in native format, it needs to be converted to .
     return strdup([[dateFormatter dateFormat] UTF8String]);
 }
 
+// collation functions
+/*
+Function:
+CompareString
+*/
+int32_t GlobalizationNative_CompareStringNative(const char* localeName, const char* lpStr1, int32_t cwStr1Length, 
+                                                const char* lpStr2, int32_t cwStr2Length, int32_t comparisonOptions)
+{    
+    NSLog(@"Collation GlobalizationNative_CompareStringNative non-default case - %d", (int32_t)comparisonOptions);
+    NSLocale *currentLocale;
+    if(localeName == NULL || strlen(localeName) == 0)
+    {
+        currentLocale = [NSLocale systemLocale];
+    }
+    else
+    {
+        NSString *locName = [NSString stringWithFormat:@"%s", localeName];
+        currentLocale = [[NSLocale alloc] initWithLocaleIdentifier:locName];
+    }
+
+    NSString *firstString = [NSString stringWithCharacters: (const unichar *)lpStr1 length: cwStr1Length];
+    NSString *secondString = [NSString stringWithCharacters: (const unichar *)lpStr2 length: cwStr2Length];
+    NSRange string1Range = NSMakeRange(0, cwStr1Length);
+    NSStringCompareOptions options = 0;   
+    NSLog(@"Collation GlobalizationNative_CompareStringNative before switch");
+    switch (comparisonOptions)
+    {
+        case 0:
+            // 0: None
+            options = NSLiteralSearch;
+            break;
+        case 1:
+            // 1: IgnoreCase
+            options = NSCaseInsensitiveSearch;
+            break;
+        case 2:
+            // 2: IgnoreNonSpace
+            options = NSDiacriticInsensitiveSearch;
+            break;
+        case 3:        
+            // 3: IgnoreNonSpace | IgnoreCase
+            options = NSCaseInsensitiveSearch | NSDiacriticInsensitiveSearch;
+            break;
+        case 16:
+            // 16: IgnoreWidth
+            options = NSWidthInsensitiveSearch;
+            break;
+        case 17:
+            // 17: IgnoreWidth | IgnoreCase
+            options = NSWidthInsensitiveSearch | NSCaseInsensitiveSearch;
+            break;
+        case 18:
+            // 18: IgnoreWidth | IgnoreNonSpace
+            options = NSWidthInsensitiveSearch | NSDiacriticInsensitiveSearch;
+            break;
+        case 19:
+            // 19: IgnoreWidth | IgnoreNonSpace | IgnoreCase
+            options = NSWidthInsensitiveSearch | NSDiacriticInsensitiveSearch | NSCaseInsensitiveSearch;
+            break;
+        case 4:
+        case 5:
+        case 6:
+        case 7:
+        case 8:
+        case 9:
+        case 10:
+        case 11:
+        case 12:
+        case 13:
+        case 14:
+        case 15:
+        case 20:
+        case 21:
+        case 22:
+        case 23:
+        case 24:
+        case 25:
+        case 26:
+        case 27:
+        case 28:
+        case 29:
+        case 30:
+        case 31:
+        default:
+            // 4: IgnoreSymbols
+            // 5: IgnoreSymbols | IgnoreCase
+            // 6: IgnoreSymbols | IgnoreNonSpace
+            // 7: IgnoreSymbols | IgnoreNonSpace | IgnoreCase
+            // 8: IgnoreKanaType
+            // 9: IgnoreKanaType | IgnoreCase
+            // 10: IgnoreKanaType | IgnoreNonSpace
+            // 11: IgnoreKanaType | IgnoreNonSpace | IgnoreCase
+            // 12: IgnoreKanaType | IgnoreSymbols
+            // 13: IgnoreKanaType | IgnoreCase | IgnoreSymbols
+            // 14: IgnoreKanaType | IgnoreSymbols | IgnoreNonSpace
+            // 15: IgnoreKanaType | IgnoreSymbols | IgnoreNonSpace | IgnoreCase            
+            // 20: IgnoreWidth | IgnoreSymbols
+            // 21: IgnoreWidth | IgnoreSymbols | IgnoreCase
+            // 22: IgnoreWidth | IgnoreSymbols | IgnoreNonSpace
+            // 23: IgnoreWidth | IgnoreSymbols | IgnoreNonSpace | IgnoreCase
+            // 24: IgnoreKanaType | IgnoreWidth
+            // 25: IgnoreKanaType | IgnoreWidth | IgnoreCase
+            // 26: IgnoreKanaType | IgnoreWidth | IgnoreNonSpace
+            // 27: IgnoreKanaType | IgnoreWidth | IgnoreNonSpace | IgnoreCase
+            // 28: IgnoreKanaType | IgnoreWidth | IgnoreSymbols
+            // 29: IgnoreKanaType | IgnoreWidth | IgnoreSymbols | IgnoreCase
+            // 30: IgnoreKanaType | IgnoreWidth | IgnoreSymbols | IgnoreNonSpace
+            // 31: IgnoreKanaType | IgnoreWidth | IgnoreSymbols | IgnoreNonSpace | IgnoreCase
+            NSLog(@"Collation GlobalizationNative_CompareStringNative default case - %d", (int32_t)comparisonOptions);
+            NSComparisonResult res = [firstString compare:secondString];
+            NSLog(@"Collation GlobalizationNative_CompareStringNative default case result is - %d", (int32_t)res);
+            return (int32_t)res;
+    }
+
+    NSLog(@"Collation GlobalizationNative_CompareStringNative non-default case - %d", (int32_t)comparisonOptions);
+
+    NSComparisonResult result = [firstString compare:secondString
+                                             options:options
+                                             range:string1Range
+                                             locale:currentLocale];
+    NSLog(@"Collation GlobalizationNative_CompareStringNative non-default case - %d", (int32_t)result);
+
+    return result == NSOrderedAscending ? -1 : result == NSOrderedDescending ? 1 : 0;
+}
+
 #endif
 
 #if defined(TARGET_MACCATALYST) || defined(TARGET_IOS) || defined(TARGET_TVOS)