Add language/locale #176
Add language/locale #176
Conversation
| @@ -195,6 +197,9 @@ open class RouteOptions: NSObject, NSSecureCoding { | |||
| coder.encode(routeShapeResolution.description, forKey: "routeShapeResolution") | |||
| coder.encode(attributeOptions.description, forKey: "attributeOptions") | |||
| coder.encode(includesExitRoundaboutManeuver, forKey: "includesExitRoundaboutManeuver") | |||
| if let locale = locale, let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String { | |||
There was a problem hiding this comment.
The language code is only part of the locale. It omits the region and script, which are sometimes relevant (zh-Hans, pt-BR) and will become increasingly relevant in the future. Locale bridges cleanly to NSLocale, which conforms to NSSecureCoding, so cast locale to NSLocale and encode it directly.
| @@ -319,6 +331,10 @@ open class RouteOptions: NSObject, NSSecureCoding { | |||
| params.append(URLQueryItem(name: "roundabout_exits", value: String(includesExitRoundaboutManeuver))) | |||
| } | |||
|
|
|||
| if let locale = locale, let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String { | |||
There was a problem hiding this comment.
The language code is only the two-letter ISO 369 code. It doesn’t ever include a region or script code; for that, you need the full locale identifier. Unfortunately, the Directions API currently lacks any sort of fallback mechanism. So this code will fail for Simplified Chinese (zh-Hant), yet if we were to pass in the full locale identifier, the code would break for a Spanish speaker in Mexico (es-MX) instead.
Until the Directions API gains basic language fallback capability, we’ll need to hard-code a whitelist of locales that the Directions API supports.
|
@1ec5 updated. |
| @@ -315,6 +316,8 @@ open class RouteOptions: NSObject, NSSecureCoding { | |||
| */ | |||
| open var locale: Locale? | |||
|
|
|||
| private let supportedLocales: [String] = ["de", "en", "es", "fr", "id", "nl", "ru", "sv", "vi", "zh-hans"] | |||
There was a problem hiding this comment.
If the locale is Simplified Chinese, its locale identifier will be zh-Hans, not zh-hans. The Directions API accepts zh-Hans as a language.
| if supportedLocales.contains(languageCode) { | ||
| params.append(URLQueryItem(name: "language", value: languageCode)) | ||
| } else { | ||
| params.append(URLQueryItem(name: "language", value: "en")) |
There was a problem hiding this comment.
Is it necessary to append any language parameter in this case?
| @@ -332,7 +335,11 @@ open class RouteOptions: NSObject, NSSecureCoding { | |||
| } | |||
|
|
|||
| if let locale = locale, let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String { | |||
| params.append(URLQueryItem(name: "language", value: languageCode)) | |||
| if supportedLocales.contains(languageCode) { | |||
There was a problem hiding this comment.
This will fail for a Locale with the identifier zh-Hans, since its languageCode will be just zh.
|
Added the DO NOT MERGE label because we’re looking into whether this language fallback logic can be implemented in the Directions API itself. |
| if languageCode == "zh" { | ||
| languageCode = "zh-Hans" | ||
| } | ||
| params.append(URLQueryItem(name: "language", value: languageCode)) |
There was a problem hiding this comment.
Once we implement fallback logic on the server side, we’ll want to pass in locale.localeIdentifier here.
|
@1ec5 once Project-OSRM/osrm-text-instructions#168 is deployed, we can start to look at merging this. |
| @@ -304,6 +310,13 @@ open class RouteOptions: NSObject, NSSecureCoding { | |||
| open var includesExitRoundaboutManeuver = false | |||
|
|
|||
| /** | |||
| If set, this `Locale` will be used to translate instructions. | |||
|
|
|||
| See supported languages [here](https://www.mapbox.com/api-documentation/#instructions-languages). | |||
There was a problem hiding this comment.
The locale in which the routes’ instructions are written.
If you use MapboxDirections.swift with the Mapbox Directions API, this property affects the sentence contained within the
RouteStep.instructionsproperty, but it does not affect any road names contained in that property or other properties such asRouteStep.name.The Directions API can provide instructions in a number of languages. Set this property to
Bundle.main.preferredLocalizations.firstorLocale.autoupdatingCurrentto match the application’s language or the system language, respectively.By default, this property is set to
nil, causing instructions to be written in the default language, English.
|
|
||
| See supported languages [here](https://www.mapbox.com/api-documentation/#instructions-languages). | ||
| */ | ||
| open var locale: Locale? |
There was a problem hiding this comment.
It’d be nice to default to Locale.autoupdatingCurrent or Bundle.main.preferredLocalizations.first so the behavior is always what the user would expect, but that can happen as tail work, possibly at the same time that we set a default locale in MapboxGeocoder.swift.
There was a problem hiding this comment.
Let's keep this optional for now.
Closes: #133
/cc @1ec5