pal_collation.m

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#include <stdlib.h>
#include "pal_locale_internal.h"
#include "pal_collation.h"

#import <Foundation/Foundation.h>

#if !__has_feature(objc_arc)
#error This file relies on ARC for memory management, but ARC is not enabled.
#endif

#if defined(APPLE_HYBRID_GLOBALIZATION)
// Enum that corresponds to C# CompareOptions
typedef enum
{
    None = 0,
    IgnoreCase = 1,
    IgnoreNonSpace = 2,
    IgnoreKanaType = 8,
    IgnoreWidth = 16,
    StringSort = 536870912,
} CompareOptions;

typedef enum
{
    ERROR_INDEX_NOT_FOUND = -1,
    ERROR_COMPARISON_OPTIONS_NOT_FOUND = -2,
    ERROR_MIXED_COMPOSITION_NOT_FOUND = -3,
} ErrorCodes;

static NSLocale* GetCurrentLocale(const uint16_t* localeName, int32_t lNameLength)
{
    NSLocale *currentLocale;
    if(localeName == NULL || lNameLength == 0)
    {
        currentLocale = [NSLocale systemLocale];
    }
    else
    {
        NSString *locName = [NSString stringWithCharacters: localeName length: (NSUInteger)lNameLength];
        currentLocale = [NSLocale localeWithLocaleIdentifier:locName];
    }
    return currentLocale;
}

static bool IsComparisonOptionSupported(int32_t comparisonOptions)
{
    int32_t supportedOptions = None | IgnoreCase | IgnoreNonSpace | IgnoreWidth | StringSort | IgnoreKanaType;
    if ((comparisonOptions | supportedOptions) != supportedOptions)
        return false;
    return true;
}

static NSStringCompareOptions ConvertFromCompareOptionsToNSStringCompareOptions(int32_t comparisonOptions, bool isLiteralSearchSupported)
{
    // To achieve an equivalent search behavior to the default in ICU,
    // NSLiteralSearch is employed as the default search option.
    NSStringCompareOptions options = isLiteralSearchSupported ? NSLiteralSearch : 0;

    if (comparisonOptions & IgnoreCase)
        options |= NSCaseInsensitiveSearch;

    if (comparisonOptions & IgnoreNonSpace)
        options |= NSDiacriticInsensitiveSearch;

    if (comparisonOptions & IgnoreWidth)
        options |= NSWidthInsensitiveSearch;

    return options;
}

static NSString *ConvertToKatakana(NSString *input)
{
    NSMutableString *mutableString = [input mutableCopy];
    CFStringTransform((__bridge CFMutableStringRef)mutableString, NULL, kCFStringTransformHiraganaKatakana, false);
    return mutableString;
}

/*
Function:
CompareString
*/
int32_t GlobalizationNative_CompareStringNative(const uint16_t* localeName, int32_t lNameLength, const uint16_t* lpSource, int32_t cwSourceLength, 
                                                const uint16_t* lpTarget, int32_t cwTargetLength, int32_t comparisonOptions)
{
    @autoreleasepool
    {
        if (!IsComparisonOptionSupported(comparisonOptions))
            return ERROR_COMPARISON_OPTIONS_NOT_FOUND;
        NSLocale *currentLocale = GetCurrentLocale(localeName, lNameLength);
        NSString *sourceString = [NSString stringWithCharacters: lpSource length: (NSUInteger)cwSourceLength];
        NSString *sourceStrPrecomposed = sourceString.precomposedStringWithCanonicalMapping;
        NSString *targetString = [NSString stringWithCharacters: lpTarget length: (NSUInteger)cwTargetLength];
        NSString *targetStrPrecomposed = targetString.precomposedStringWithCanonicalMapping;

        if (comparisonOptions & IgnoreKanaType)
        {
            sourceStrPrecomposed = ConvertToKatakana(sourceStrPrecomposed);
            targetStrPrecomposed = ConvertToKatakana(targetStrPrecomposed);
        }

        if (comparisonOptions != 0 && comparisonOptions != StringSort)
        {
            NSStringCompareOptions options = ConvertFromCompareOptionsToNSStringCompareOptions(comparisonOptions, false);
            sourceStrPrecomposed = [sourceStrPrecomposed stringByFoldingWithOptions:options locale:currentLocale];
            targetStrPrecomposed = [targetStrPrecomposed stringByFoldingWithOptions:options locale:currentLocale];
        }

        NSStringCompareOptions options = ConvertFromCompareOptionsToNSStringCompareOptions(comparisonOptions, true);
        NSRange comparisonRange = NSMakeRange(0, sourceStrPrecomposed.length);
        return (int32_t)[sourceStrPrecomposed compare:targetStrPrecomposed
                                     options:options
                                     range:comparisonRange
                                     locale:currentLocale];
    }
}

static NSString* RemoveWeightlessCharacters(NSString* source)
{
    NSError *error = nil;
    NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:@"[\u200B-\u200D\uFEFF\0]" options:NSRegularExpressionCaseInsensitive error:&error];

    if (error != nil)
        return source;

    NSString *modifiedString = [regex stringByReplacingMatchesInString:source options:0 range:NSMakeRange(0, [source length]) withTemplate:@""];

    return modifiedString;
}

static int32_t IsIndexFound(int32_t fromBeginning, int32_t foundLocation, int32_t newLocation)
{
    // last index
    if (!fromBeginning && foundLocation > newLocation)
        return 1;
    // first index
    if (fromBeginning && foundLocation > 0 && foundLocation < newLocation)
        return 1;
    return 0;
}

/*
Function: IndexOf
Find detailed explanation how this function works in https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-hybrid-mode.md
*/
Range GlobalizationNative_IndexOfNative(const uint16_t* localeName, int32_t lNameLength, const uint16_t* lpTarget, int32_t cwTargetLength,
                                        const uint16_t* lpSource, int32_t cwSourceLength, int32_t comparisonOptions, int32_t fromBeginning)
{
    @autoreleasepool
    {
        assert(cwTargetLength >= 0);
        Range result = {ERROR_INDEX_NOT_FOUND, 0};
        if (!IsComparisonOptionSupported(comparisonOptions))
        {
            result.location = ERROR_COMPARISON_OPTIONS_NOT_FOUND;
            return result;
        }
        NSStringCompareOptions options = ConvertFromCompareOptionsToNSStringCompareOptions(comparisonOptions, true);
        NSString *searchString = [NSString stringWithCharacters: lpTarget length: (NSUInteger)cwTargetLength];
        NSString *searchStrCleaned = RemoveWeightlessCharacters(searchString);
        NSString *sourceString = [NSString stringWithCharacters: lpSource length: (NSUInteger)cwSourceLength];
        NSString *sourceStrCleaned = RemoveWeightlessCharacters(sourceString);
        if (comparisonOptions & IgnoreKanaType)
        {
            sourceStrCleaned = ConvertToKatakana(sourceStrCleaned);
            searchStrCleaned = ConvertToKatakana(searchStrCleaned);
        }

        if (sourceStrCleaned.length == 0 || searchStrCleaned.length == 0)
        {
            result.location = fromBeginning ? 0 : (int32_t)sourceString.length;
            return result;
        }

        NSLocale *currentLocale = GetCurrentLocale(localeName, lNameLength);
        NSString *searchStrPrecomposed = searchStrCleaned.precomposedStringWithCanonicalMapping;
        NSString *sourceStrPrecomposed = sourceStrCleaned.precomposedStringWithCanonicalMapping;

        // last index
        if (!fromBeginning)
            options |= NSBackwardsSearch;

        // check if there is a possible match and return -1 if not
        // doesn't matter which normalization form is used here
        NSRange rangeOfReceiverToSearch = NSMakeRange(0, sourceStrPrecomposed.length);
        NSRange containsRange = [sourceStrPrecomposed rangeOfString:searchStrPrecomposed
                                                    options:options
                                                    range:rangeOfReceiverToSearch
                                                    locale:currentLocale];

        if (containsRange.location == NSNotFound)
            return result;

        // in case search string is inside source string but we can't find the index return -3
        result.location = ERROR_MIXED_COMPOSITION_NOT_FOUND;
        // sourceString and searchString possibly have the same composition of characters
        rangeOfReceiverToSearch = NSMakeRange(0, sourceStrCleaned.length);
        NSRange nsRange = [sourceStrCleaned rangeOfString:searchStrCleaned
                                            options:options
                                            range:rangeOfReceiverToSearch
                                            locale:currentLocale];

        if (nsRange.location != NSNotFound)
        {   
            result.location = (int32_t)nsRange.location;
            result.length = (int32_t)nsRange.length;
            // in case of CompareOptions.IgnoreCase if letters have different representations in source and search strings
            // and case insensitive search appears more than one time in source string take last index for LastIndexOf and first index for IndexOf
            // e.g. new CultureInfo().CompareInfo.LastIndexOf("Is \u0055\u0308 or \u0075\u0308 the same as \u00DC or \u00FC?", "U\u0308", 25,18, CompareOptions.IgnoreCase);
            // should return 24 but here it will be 9
            if (!(comparisonOptions & IgnoreCase))
                return result;
        }

        // check if sourceString has precomposed form of characters and searchString has decomposed form of characters
        // convert searchString to a precomposed form
        NSRange precomposedRange = [sourceStrCleaned rangeOfString:searchStrPrecomposed
                                                    options:options
                                                    range:rangeOfReceiverToSearch
                                                    locale:currentLocale];

        if (precomposedRange.location != NSNotFound)
        {
            // in case of CompareOptions.IgnoreCase if letters have different representations in source and search strings
            // and search appears more than one time in source string take last index for LastIndexOf and first index for IndexOf
            // e.g. new CultureInfo().CompareInfo.LastIndexOf("Is \u0055\u0308 or \u0075\u0308 the same as \u00DC or \u00FC?", "U\u0308", 25,18, CompareOptions.IgnoreCase);
            // this will return 24
            if ((comparisonOptions & IgnoreCase) && IsIndexFound(fromBeginning, (int32_t)result.location, (int32_t)precomposedRange.location))
                return result;

            result.location = (int32_t)precomposedRange.location;
            result.length = (int32_t)precomposedRange.length;
            if (!(comparisonOptions & IgnoreCase))
            return result;
        }

        // check if sourceString has decomposed form of characters and searchString has precomposed form of characters
        // convert searchString to a decomposed form
        NSString *searchStrDecomposed = searchStrCleaned.decomposedStringWithCanonicalMapping;
        NSRange decomposedRange = [sourceStrCleaned rangeOfString:searchStrDecomposed
                                                    options:options
                                                    range:rangeOfReceiverToSearch
                                                    locale:currentLocale];

        if (decomposedRange.location != NSNotFound)
        {
            if ((comparisonOptions & IgnoreCase) && IsIndexFound(fromBeginning, (int32_t)result.location, (int32_t)decomposedRange.location))
                return result;

            result.location = (int32_t)decomposedRange.location;
            result.length = (int32_t)decomposedRange.length;
            return result;
        }

        return result;
    }
}

/*
 Return value is a "Win32 BOOL" (1 = true, 0 = false)
 */
int32_t GlobalizationNative_StartsWithNative(const uint16_t* localeName, int32_t lNameLength, const uint16_t* lpPrefix, int32_t cwPrefixLength, 
                                             const uint16_t* lpSource, int32_t cwSourceLength, int32_t comparisonOptions)          
{
    @autoreleasepool
    {
        if (!IsComparisonOptionSupported(comparisonOptions))
            return ERROR_COMPARISON_OPTIONS_NOT_FOUND;
        NSStringCompareOptions options = ConvertFromCompareOptionsToNSStringCompareOptions(comparisonOptions, true);
        NSLocale *currentLocale = GetCurrentLocale(localeName, lNameLength);
        NSString *prefixString = [NSString stringWithCharacters: lpPrefix length: (NSUInteger)cwPrefixLength];
        NSString *prefixStrComposed = RemoveWeightlessCharacters(prefixString.precomposedStringWithCanonicalMapping);
        NSString *sourceString = [NSString stringWithCharacters: lpSource length: (NSUInteger)cwSourceLength];
        NSString *sourceStrComposed = RemoveWeightlessCharacters(sourceString.precomposedStringWithCanonicalMapping);
        if (comparisonOptions & IgnoreKanaType)
        {
            prefixStrComposed = ConvertToKatakana(prefixStrComposed);
            sourceStrComposed = ConvertToKatakana(sourceStrComposed);
        }

        NSRange sourceRange = NSMakeRange(0, prefixStrComposed.length > sourceStrComposed.length ? sourceStrComposed.length : prefixStrComposed.length);
            
        int32_t result = (int32_t)[sourceStrComposed compare:prefixStrComposed
                                            options:options
                                            range:sourceRange
                                            locale:currentLocale];
        return result == NSOrderedSame ? 1 : 0;
    }
}

/*
 Return value is a "Win32 BOOL" (1 = true, 0 = false)
 */
int32_t GlobalizationNative_EndsWithNative(const uint16_t* localeName, int32_t lNameLength, const uint16_t* lpSuffix, int32_t cwSuffixLength,
                                           const uint16_t* lpSource, int32_t cwSourceLength, int32_t comparisonOptions)                
{
    @autoreleasepool
    {
        if (!IsComparisonOptionSupported(comparisonOptions))
            return ERROR_COMPARISON_OPTIONS_NOT_FOUND;
        NSStringCompareOptions options = ConvertFromCompareOptionsToNSStringCompareOptions(comparisonOptions, true);
        NSLocale *currentLocale = GetCurrentLocale(localeName, lNameLength);
        NSString *suffixString = [NSString stringWithCharacters: lpSuffix length: (NSUInteger)cwSuffixLength];
        NSString *suffixStrComposed = RemoveWeightlessCharacters(suffixString.precomposedStringWithCanonicalMapping);
        NSString *sourceString = [NSString stringWithCharacters: lpSource length: (NSUInteger)cwSourceLength];
        NSString *sourceStrComposed = RemoveWeightlessCharacters(sourceString.precomposedStringWithCanonicalMapping);
        if (comparisonOptions & IgnoreKanaType)
        {
            suffixStrComposed = ConvertToKatakana(suffixStrComposed);
            sourceStrComposed = ConvertToKatakana(sourceStrComposed);
        }
        NSUInteger startIndex = suffixStrComposed.length > sourceStrComposed.length ? 0 : sourceStrComposed.length - suffixStrComposed.length;
        NSRange sourceRange = NSMakeRange(startIndex, sourceStrComposed.length - startIndex);
        
        int32_t result = (int32_t)[sourceStrComposed compare:suffixStrComposed
                                            options:options
                                            range:sourceRange
                                            locale:currentLocale];
        return result == NSOrderedSame ? 1 : 0;
    }
}

int32_t GlobalizationNative_GetSortKeyNative(const uint16_t* localeName, int32_t lNameLength, const UChar* lpStr, int32_t cwStrLength,
                                             uint8_t* sortKey, int32_t cbSortKeyLength, int32_t options)
{
    @autoreleasepool {
        if (cwStrLength == 0)
        {
            if (sortKey != NULL && cbSortKeyLength > 0)
                sortKey[0] = '\0';
            return 1;
        }
        if (!IsComparisonOptionSupported(options))
            return 0;
        NSString *sourceString = [NSString stringWithCharacters: lpStr length: (NSUInteger)cwStrLength];
        if (options & IgnoreKanaType)
        {
            sourceString = ConvertToKatakana(sourceString);
        }
        NSString *sourceStringCleaned = RemoveWeightlessCharacters(sourceString).precomposedStringWithCanonicalMapping;
        // If the string is empty after removing weightless characters, return 1
        if(sourceStringCleaned.length == 0)
        {
            if (sortKey != NULL && cbSortKeyLength > 0)
                sortKey[0] = '\0';
            return 1;
        }

        NSLocale *locale = GetCurrentLocale(localeName, lNameLength);
        NSStringCompareOptions comparisonOptions = options == 0 ? 0 : ConvertFromCompareOptionsToNSStringCompareOptions(options, false);

        // Generate a sort key for the original string based on the locale
        NSString *transformedString = [sourceStringCleaned stringByFoldingWithOptions:comparisonOptions locale:locale];

        NSUInteger transformedStringBytes = [transformedString lengthOfBytesUsingEncoding: NSUTF16StringEncoding];
        if (sortKey == NULL)
            return (int32_t)transformedStringBytes;

        // If the buffer is too small, return the required buffer size
        // and throw exception in managed code
        if (cbSortKeyLength < (int32_t)transformedStringBytes)
            return (int32_t)transformedStringBytes;
        NSRange range = NSMakeRange(0, [transformedString length]);
        NSUInteger usedLength = 0;
        BOOL result = [transformedString getBytes:sortKey maxLength:transformedStringBytes usedLength:&usedLength encoding:NSUTF16StringEncoding options:0 range:range remainingRange:NULL];
        if (result)
            return (int32_t)usedLength;
        return 0;
    }
}

#endif