Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarekgh merged 4 commits into from
May 6, 2022
Merged

Deprecate ICU ucol_safeClone and support ucol_clone #68847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7c5479
Deprecate ICU ucol_safeClone and support ucol_clone
tarekgh May 4, 2022
bdba2ed
remove un-needed declaration from Android header
tarekgh May 4, 2022
b7b0eb7
Add the calling convention to the defined functions
tarekgh May 5, 2022
2c37180
Fix Android build
tarekgh May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/native/libs/System.Globalization.Native/configure.cmake
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
"unicode/ucol.h"
HAVE_SET_MAX_VARIABLE)

check_symbol_exists(
ucol_clone
"unicode/ucol.h"
HAVE_UCOL_CLONE)

unset(CMAKE_REQUIRED_LIBRARIES)
unset(CMAKE_REQUIRED_INCLUDES)
endif()
Expand Down
17 changes: 17 additions & 0 deletions src/native/libs/System.Globalization.Native/pal_collation.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

if (customRuleLength == 0)
{
#if !defined(STATIC_ICU)
if (ucol_clone_ptr != NULL)
{
pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.
}
else
{
pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
}
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
pClonedCollator = ucol_clone(pCollator, pErr);
#else
pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
}
else
{
Expand Down
27 changes: 26 additions & 1 deletion src/native/libs/System.Globalization.Native/pal_icushim.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
}
}

static void InitializeUColClonePointers(char* symbolVersion)
{
if (ucol_clone_ptr != NULL)
{
return;
}

#if defined(TARGET_WINDOWS)
char symbolName[SYMBOL_NAME_SIZE];
sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
char symbolName[SYMBOL_NAME_SIZE];
sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

if (ucol_safeClone_ptr == NULL)
{
fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
abort();
}
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
ValidateICUDataCanLoad();

InitializeVariableMaxAndTopPointers(symbolVersion);
InitializeUColClonePointers(symbolVersion);

return true;
}
Expand Down
35 changes: 26 additions & 9 deletions src/native/libs/System.Globalization.Native/pal_icushim_internal.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down
2 changes: 1 addition & 1 deletion src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Deprecate ICU ucol_safeClone and support ucol_clone#68847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarekgh
merged 4 commits into

from

May 6, 2022
 Merged


Deprecate ICU ucol_safeClone and support ucol_clone
#68847
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
a7c5479

Deprecate ICU ucol_safeClone and support ucol_clone


tarekgh May 4, 2022
bdba2ed

remove un-needed declaration from Android header


tarekgh May 4, 2022
b7b0eb7

Add the calling convention to the defined functions


tarekgh May 5, 2022
2c37180

Fix Android build


tarekgh May 6, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
src/native/libs/System.Globalization.Native/configure.cmake

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ else()
 "unicode/ucol.h"
 HAVE_SET_MAX_VARIABLE)

 check_symbol_exists(
 ucol_clone
 "unicode/ucol.h"
 HAVE_UCOL_CLONE)

 unset(CMAKE_REQUIRED_LIBRARIES)
 unset(CMAKE_REQUIRED_INCLUDES)
 endif()
Expand Down

17 changes: 17 additions & 0 deletions
src/native/libs/System.Globalization.Native/pal_collation.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -321,7 +321,24 @@ static UCollator* CloneCollatorWithOptions(const UCollator* pCollator, int32_t o

 if (customRuleLength == 0)
 {
#if !defined(STATIC_ICU)
 if (ucol_clone_ptr != NULL)
 {
 pClonedCollator = ucol_clone(pCollator, pErr);
Comment thread
janvorli marked this conversation as resolved.

 }
 else
 {
 pClonedCollator = ucol_safeClone_ptr(pCollator, NULL, NULL, pErr);
 }
#else // !defined(STATIC_ICU)

#if HAVE_UCOL_CLONE
 pClonedCollator = ucol_clone(pCollator, pErr);
#else
 pClonedCollator = ucol_safeClone(pCollator, NULL, NULL, pErr);
#endif // HAVE_UCOL_CLONE

#endif // !defined(STATIC_ICU)
 }
 else
 {
Expand Down

27 changes: 26 additions & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim.c

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@ FOR_ALL_ICU_FUNCTIONS
#define SYMBOL_NAME_SIZE (128 + SYMBOL_CUSTOM_SUFFIX_SIZE)
#define MaxICUVersionStringWithSuffixLength (MaxICUVersionStringLength + SYMBOL_CUSTOM_SUFFIX_SIZE)


#if defined(TARGET_WINDOWS) || defined(TARGET_OSX) || defined(TARGET_ANDROID)

#define MaxICUVersionStringLength 33
Expand All@@ -39,6 +38,7 @@ FOR_ALL_ICU_FUNCTIONS
static void* libicuuc = NULL;
static void* libicui18n = NULL;
ucol_setVariableTop_func ucol_setVariableTop_ptr = NULL;
ucol_safeClone_func ucol_safeClone_ptr = NULL;

#if defined (TARGET_UNIX)

Expand DownExpand Up@@ -381,6 +381,30 @@ static void ValidateICUDataCanLoad(void)
 }
}

static void InitializeUColClonePointers(char* symbolVersion)
{
 if (ucol_clone_ptr != NULL)
 {
 return;
 }

#if defined(TARGET_WINDOWS)
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf_s(symbolName, SYMBOL_NAME_SIZE, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)GetProcAddress((HMODULE)libicui18n, symbolName);
#else
 char symbolName[SYMBOL_NAME_SIZE];
 sprintf(symbolName, "ucol_safeClone%s", symbolVersion);
 ucol_safeClone_ptr = (ucol_safeClone_func)dlsym(libicui18n, symbolName);
#endif // defined(TARGET_WINDOWS)

 if (ucol_safeClone_ptr == NULL)
 {
 fprintf(stderr, "Cannot get the symbols of ICU APIs ucol_safeClone or ucol_clone.\n");
 abort();
 }
}

static void InitializeVariableMaxAndTopPointers(char* symbolVersion)
{
 if (ucol_setMaxVariable_ptr != NULL)
Expand DownExpand Up@@ -444,6 +468,7 @@ int32_t GlobalizationNative_LoadICU()
 ValidateICUDataCanLoad();

 InitializeVariableMaxAndTopPointers(symbolVersion);
 InitializeUColClonePointers(symbolVersion);

 return true;
}
Expand Down

35 changes: 26 additions & 9 deletions
src/native/libs/System.Globalization.Native/pal_icushim_internal.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,6 @@
#include "pal_compiler.h"

#if !defined(STATIC_ICU)
// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
extern ucol_setVariableTop_func ucol_setVariableTop_ptr;

#if !defined(TARGET_ANDROID)
// (U_ICU_VERSION_MAJOR_NUM < 52)
Expand All@@ -66,7 +61,29 @@ extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
U_CAPI void U_EXPORT2 ucol_setMaxVariable(UCollator* coll, UColReorderCode group, UErrorCode* pErrorCode);
U_CAPI int32_t U_EXPORT2 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region, UChar* id, int32_t idCapacity, UErrorCode* status);
U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len, UChar* winid, int32_t winidCapacity, UErrorCode* status);
#endif

// (U_ICU_VERSION_MAJOR_NUM < 71)
// The following API is not supported in the ICU versions less than 71. We need to define it manually.
// We have to do runtime check before using the pointers to this API. That is why these are listed in the FOR_ALL_OPTIONAL_ICU_FUNCTIONS list.
U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator* coll, UErrorCode* status);

// ucol_setVariableTop is a deprecated function on the newer ICU versions and ucol_setMaxVariable should be used instead.
// As can run against ICU versions which not supported ucol_setMaxVariable, we'll dynamically try to get the pointer to ucol_setVariableTop
// when we couldn't get a pointer to ucol_setMaxVariable.
typedef uint32_t (U_EXPORT2 *ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);

// ucol_safeClone is deprecated in ICU version 71. We have to handle it manually to avoid getting a build break when referencing it in the code.
typedef UCollator* (U_EXPORT2 *ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#else // !defined(TARGET_ANDROID)

typedef uint32_t (*ucol_setVariableTop_func)(UCollator* coll, const UChar* varTop, int32_t len, UErrorCode* status);
typedef UCollator* (*ucol_safeClone_func)(const UCollator* coll, void* stackBuffer, int32_t* pBufferSize, UErrorCode* status);

#endif // !defined(TARGET_ANDROID)

extern ucol_setVariableTop_func ucol_setVariableTop_ptr;
extern ucol_safeClone_func ucol_safeClone_ptr;

// List of all functions from the ICU libraries that are used in the System.Globalization.Native.so
#define FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -105,7 +122,6 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
 PER_FUNCTION_BLOCK(ucol_open, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openElements, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_openRules, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_safeClone, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_setAttribute, libicui18n, true) \
 PER_FUNCTION_BLOCK(ucol_strcoll, libicui18n, true) \
 PER_FUNCTION_BLOCK(udat_close, libicui18n, true) \
Expand DownExpand Up@@ -193,7 +209,8 @@ U_CAPI int32_t U_EXPORT2 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
#define FOR_ALL_OPTIONAL_ICU_FUNCTIONS \
 PER_FUNCTION_BLOCK(ucal_getWindowsTimeZoneID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucal_getTimeZoneIDForWindowsID, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false)
 PER_FUNCTION_BLOCK(ucol_setMaxVariable, libicui18n, false) \
 PER_FUNCTION_BLOCK(ucol_clone, libicui18n, false)

#define FOR_ALL_ICU_FUNCTIONS \
 FOR_ALL_UNCONDITIONAL_ICU_FUNCTIONS \
Expand DownExpand Up@@ -232,6 +249,7 @@ FOR_ALL_ICU_FUNCTIONS
#define ucal_openTimeZoneIDEnumeration(...) ucal_openTimeZoneIDEnumeration_ptr(__VA_ARGS__)
#define ucal_set(...) ucal_set_ptr(__VA_ARGS__)
#define ucal_setMillis(...) ucal_setMillis_ptr(__VA_ARGS__)
#define ucol_clone(...) ucol_clone_ptr(__VA_ARGS__)
#define ucol_close(...) ucol_close_ptr(__VA_ARGS__)
#define ucol_closeElements(...) ucol_closeElements_ptr(__VA_ARGS__)
#define ucol_getOffset(...) ucol_getOffset_ptr(__VA_ARGS__)
Expand All@@ -244,7 +262,6 @@ FOR_ALL_ICU_FUNCTIONS
#define ucol_open(...) ucol_open_ptr(__VA_ARGS__)
#define ucol_openElements(...) ucol_openElements_ptr(__VA_ARGS__)
#define ucol_openRules(...) ucol_openRules_ptr(__VA_ARGS__)
#define ucol_safeClone(...) ucol_safeClone_ptr(__VA_ARGS__)
#define ucol_setAttribute(...) ucol_setAttribute_ptr(__VA_ARGS__)
#define ucol_setMaxVariable(...) ucol_setMaxVariable_ptr(__VA_ARGS__)
#define ucol_strcoll(...) ucol_strcoll_ptr(__VA_ARGS__)
Expand Down

2 changes: 1 addition & 1 deletion
src/native/libs/System.Globalization.Native/pal_icushim_internal_android.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -470,7 +470,7 @@ int32_t ucol_previous(UCollationElements * elems, UErrorCode * status);
UCollator * ucol_open(const char * loc, UErrorCode * status);
UCollationElements * ucol_openElements(const UCollator * coll, const UChar * text, int32_t textLength, UErrorCode * status);
UCollator * ucol_openRules(const UChar * rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError * parseError, UErrorCode * status);
UCollator * ucol_safeClone(const UCollator * coll, void * stackBuffer, int32_t * pBufferSize, UErrorCode * status);
UCollator * ucol_clone(const UCollator * coll, UErrorCode * status);
void ucol_setAttribute(UCollator * coll, UColAttribute attr, UColAttributeValue value, UErrorCode * status);
UCollationResult ucol_strcoll(const UCollator * coll, const UChar * source, int32_t sourceLength, const UChar * target, int32_t targetLength);
int32_t ucurr_forLocale(const char * locale, UChar * buff, int32_t buffCapacity, UErrorCode * ec);
Expand Down