Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Use a [NSLocale currentLocale] for first locale on iOS to ensure countryCode exists. Allow language-only locales. #6995

Merged
GaryQian merged 4 commits into from
Nov 28, 2018
Merged

Use a [NSLocale currentLocale] for first locale on iOS to ensure countryCode exists. Allow language-only locales. #6995

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db2b2be
Use NSLocale::currentLocale for first/default locale to avoid iOS str…
GaryQian Nov 28, 2018
789f8ee
Add explanation of why use a different API for first locale
GaryQian Nov 28, 2018
2e58639
Change currentLocale to prepend to preferredLocales list
GaryQian Nov 28, 2018
81eaa79
Autorelease the allocations
GaryQian Nov 28, 2018
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
15 changes: 12 additions & 3 deletions shell/platform/darwin/ios/framework/Source/FlutterViewController.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,17 +749,26 @@ - (void)onMemoryWarning:(NSNotification*)notification {
- (void)onLocaleUpdated:(NSNotification*)notification {
NSArray<NSString*>* preferredLocales = [NSLocale preferredLanguages];
NSMutableArray<NSString*>* data = [NSMutableArray new];
Copy link
Contributor

@dnfield dnfield Nov 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So long as you're here, this should be NSMutableArray<NSString*>* data = [[NSMutableArray new] autorelease];. I have another PR that fixes it, but might as well get it now.

bool first = true;
for (NSString* localeID in preferredLocales) {
NSLocale* currentLocale = [[NSLocale alloc] initWithLocaleIdentifier:localeID];
NSLocale* currentLocale;
if (first) {
// Use a different API for first/default locale as preferredLanguages
// may strip the region/country code from the locales.
currentLocale = [NSLocale currentLocale];
first = false;
Copy link
Contributor

@tvolkert tvolkert Nov 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't this end up skipping a preferred locale? Take the following list:

[NSLocale preferredLanguages] => ["ru_US", "en"]
[NSLocale currentLocale].localeIdentifier => "en_US"

In this case, we'll end up setting the locales to ["en_US", "en"] and skip "ru_US" altogether.

It seems like we should always add [NSLocale currentLocale] to the head of the list, then walk [NSLocale preferredLanguages], adding them to the list if they're not already covered by the current locale.

Copy link
Contributor Author

@GaryQian GaryQian Nov 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I can tell from the iOS docs, preferredLanguages is an ordered list, and currentLocale should be the first locale in it. (https://developer.apple.com/documentation/foundation/nslocale/1415614-preferredlanguages)

This implementation prevents cases where the same locale is represented twice in the list.

Copy link

@jklint-g jklint-g Nov 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first item isn't always necessarily the same as currentLocale. I believe currentLocale makes a best determination as to what language the app should use based on system preferred languages and languages declared in the app bundle.

Also iOS allows setting preferred languages which the system itself does not support, like Filipino. So the phone system language will be something else like English, but if your app declares it supports Filipino then currentLocale does indeed return Filipino.

Since our app does support Filipino, with phone language English and Filipino as top preferred language we get:
currentLocale fil_US
preferredLanguages ("fil-US", "en-US", "pl-US", "ru-US", "es-US")

But if I then add Armenian (hy) as the top preferred language, which neither the system UI nor our app support, then we get:
currentLocale fil_US
preferredLanguages ("hy-US", "fil-US", "en-US", "pl-US", "ru-US", "es-US")

Copy link
Contributor Author

@GaryQian GaryQian Nov 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh thanks for that clarification. In that case, prepending currentLocale should be consistent with what we are trying to achieve

} else {
currentLocale = [[NSLocale alloc] initWithLocaleIdentifier:localeID];
}
NSString* languageCode = [currentLocale objectForKey:NSLocaleLanguageCode];
NSString* countryCode = [currentLocale objectForKey:NSLocaleCountryCode];
NSString* scriptCode = [currentLocale objectForKey:NSLocaleScriptCode];
NSString* variantCode = [currentLocale objectForKey:NSLocaleVariantCode];
if (!languageCode || !countryCode) {
if (!languageCode) {
continue;
}
[data addObject:languageCode];
[data addObject:countryCode];
[data addObject:(countryCode ? countryCode : @"")];
[data addObject:(scriptCode ? scriptCode : @"")];
[data addObject:(variantCode ? variantCode : @"")];
}
Expand Down