Feature/localization #480
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import UIKit | ||
| import MapboxMaps | ||
|
|
||
| @objc(LocalizationExample) | ||
|
|
||
| public class LocalizationExample: UIViewController, ExampleProtocol { | ||
|
|
||
| internal var mapView: MapView! | ||
|
|
||
| override public func viewDidLoad() { | ||
| super.viewDidLoad() | ||
|
|
||
| mapView = MapView(frame: view.bounds) | ||
| mapView.autoresizingMask = [.flexibleWidth, .flexibleHeight] | ||
| view.addSubview(mapView) | ||
|
|
||
| configureLanguageButton() | ||
|
|
||
| // Allows the delegate to receive information about map events. | ||
| mapView.mapboxMap.onNext(.mapLoaded) { _ in | ||
| self.finish() // Needed for internal testing purposes. | ||
| } | ||
| } | ||
|
|
||
| private func configureLanguageButton() { | ||
| // Set up layer postion change button | ||
| let button = UIButton(type: .system) | ||
| button.setTitle("Change Language", for: .normal) | ||
| button.setTitleColor(.white, for: .normal) | ||
| button.backgroundColor = #colorLiteral(red: 0, green: 0.4784313725, blue: 0.9882352941, alpha: 1) | ||
| button.translatesAutoresizingMaskIntoConstraints = false | ||
| button.layer.cornerRadius = 20 | ||
| button.clipsToBounds = true | ||
| button.addTarget(self, action: #selector(changeLanguage(sender:)), for: .touchUpInside) | ||
| view.addSubview(button) | ||
|
|
||
| // Set button location | ||
| let horizontalConstraint = button.bottomAnchor.constraint(equalTo: view.safeAreaLayoutGuide.bottomAnchor, constant: -24) | ||
| let verticalConstraint = button.centerXAnchor.constraint(equalTo: view.centerXAnchor) | ||
| let widthConstraint = button.widthAnchor.constraint(equalToConstant: 200) | ||
| let heightConstraint = button.heightAnchor.constraint(equalToConstant: 40) | ||
| NSLayoutConstraint.activate([horizontalConstraint, verticalConstraint, widthConstraint, heightConstraint]) | ||
| } | ||
|
|
||
| @objc public func changeLanguage(sender: UIButton) { | ||
| let alert = UIAlertController(title: "Languages", | ||
| message: "Please select a language to localize to.", | ||
| preferredStyle: .actionSheet) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "Spanish", style: .default, handler: { [weak self] _ in | ||
| guard let self = self else { return } | ||
| self.mapView.locale = Locale(identifier: SupportedLanguage.spanish.rawValue) | ||
| })) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "French", style: .default, handler: { [weak self] _ in | ||
| guard let self = self else { return } | ||
| self.mapView.locale = Locale(identifier: SupportedLanguage.french.rawValue) | ||
| })) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "Traditional Chinese", style: .default, handler: { [weak self] _ in | ||
| guard let self = self else { return } | ||
| self.mapView.locale = Locale(identifier: SupportedLanguage.traditionalChinese.rawValue) | ||
| })) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "Arabic", style: .default, handler: { [weak self] _ in | ||
| guard let self = self else { return } | ||
| self.mapView.locale = Locale(identifier: SupportedLanguage.arabic.rawValue) | ||
| })) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "English", style: .default, handler: { [weak self] _ in | ||
| guard let self = self else { return } | ||
| self.mapView.locale = Locale(identifier: SupportedLanguage.english.rawValue) | ||
| })) | ||
|
|
||
| alert.addAction(UIAlertAction(title: "Cancel", style: .cancel)) | ||
|
|
||
| present(alert, animated: true) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| @_implementationOnly import MapboxCommon_Private | ||
|
|
||
| /// Support for localization of labels | ||
| extension Style { | ||
|
|
||
| /// This function creates an expression that will localize the `textField` property of a `SymbolLayer` | ||
| /// - Parameter locale: A `SupportedLanguage` based `Locale` | ||
| internal func localizeLabels(into locale: Locale) throws { | ||
|
|
||
| /// Get all symbol layers that are currently on the map | ||
| let symbolLayers = allLayerIdentifiers.filter { layer in | ||
| return layer.type == .symbol | ||
| } | ||
|
Comment on lines
+11
to
+13
There was a problem hiding this comment. Not every symbol layer should be forced to have a |
||
|
|
||
| /// Expression to be applied to the `SymbolLayer.textField`to localize the language | ||
| /// Sample Expression JSON: `["format",["coalesce",["get","name_en"],["get","name"]],{}]` | ||
| let replacement = "[\"get\",\"name_\(getLocaleValue(locale: locale))\"]" | ||
|
|
||
| let expressionCoalesce = try NSRegularExpression(pattern: "\\[\"get\",\\s*\"(name_.{2,7})\"\\]", | ||
| options: .caseInsensitive) | ||
| let expressionAbbr = try NSRegularExpression(pattern: "\\[\"get\",\\s*\"abbr\"\\]", | ||
| options: .caseInsensitive) | ||
|
Comment on lines
+19
to
+22
There was a problem hiding this comment. It’s unnecessary to convert the entire expression to JSON, then to a string, then monkeypatch the string. That defeats the purpose of having a structured, type-safe representation of an expression. Consider adapting the implementation in mapbox/mapbox-navigation-ios#2933 that recurses into the expression, surgically replacing occurrences of |
||
|
|
||
| for layerInfo in symbolLayers { | ||
| let tempLayer = try layer(withId: layerInfo.id) as SymbolLayer | ||
|
|
||
| if var stringExpression = String(data: try JSONEncoder().encode(tempLayer.textField), encoding: .utf8), | ||
| stringExpression != "null" { | ||
| stringExpression.updateExpression(replacement: replacement, regex: expressionCoalesce) | ||
| stringExpression.updateExpression(replacement: replacement, regex: expressionAbbr) | ||
|
|
||
| // Turn the new json string back into an Expression | ||
| let data = stringExpression.data(using: .utf8) | ||
| let convertedExpression = try JSONSerialization.jsonObject(with: data!, options: []) | ||
|
|
||
| try setLayerProperty(for: tempLayer.id, property: "text-field", value: convertedExpression) | ||
| } | ||
|
Comment on lines
+25
to
+37
There was a problem hiding this comment. This code should be extracted into a public method, so that a map optimized for turn-by-turn navigation can localize place and POI labels but not road labels. |
||
| } | ||
| } | ||
|
|
||
| /// Filters through source to determine supported locale styles. | ||
| /// This is needed for v7 support | ||
| internal func getLocaleValue(locale: Locale) -> String { | ||
| let vectorSources = allSourceIdentifiers.filter { source in | ||
| return source.type == .vector | ||
| } | ||
|
|
||
| for sourceInfo in vectorSources { | ||
| do { | ||
| let tempSource = try source(withId: sourceInfo.id) as VectorSource | ||
|
|
||
| if tempSource.url?.contains("mapbox.mapbox-streets-v7") == true { | ||
|
There was a problem hiding this comment. The tileset ID always occurs in the hostname part of the URL, so compare against |
||
| if locale.identifier.contains("zh") { | ||
| // v7 styles does not support value of "name_zh-Hant" | ||
| if locale.identifier == SupportedLanguage.traditionalChinese.rawValue { | ||
|
There was a problem hiding this comment. Replace SupportedLanguage with an array of |
||
| return SupportedLanguage.chinese.rawValue | ||
| } | ||
| } | ||
| } | ||
| } catch { | ||
| Log.warning(forMessage: "Error localizing textField for Symbol Layer", category: "Style") | ||
| } | ||
| } | ||
|
|
||
| return locale.identifier | ||
| } | ||
| } | ||
|
|
||
| extension String { | ||
|
|
||
| /// Updates string using a regex | ||
| /// - Parameters: | ||
| /// - replacement: New string to replace the matched pattern | ||
| /// - regex: The regex pattern that will be matched for replacement | ||
| internal mutating func updateExpression(replacement: String, regex: NSRegularExpression) { | ||
| let range = NSRange(location: 0, length: self.count) | ||
|
|
||
| self = regex.stringByReplacingMatches(in: self, | ||
| options: [], | ||
| range: range, | ||
| withTemplate: replacement) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Locale.currentonly matches the language that the iOS UI is currently displayed in, which can differ from both the surrounding application and the user’s preference.Bundle.preferredLocalizationshas the advantage of matching the language that the rest of the application is currently displayed in.Locale.preferredLanguageshas the advantage of matching the user’s preferred content language settings, even if the application is unavailable in the preferred language.