cupertino_localizations.dart 20.6 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7 8
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/cupertino.dart';
import 'package:flutter/foundation.dart';
import 'package:intl/intl.dart' as intl;

9
import 'l10n/generated_cupertino_localizations.dart';
10 11 12 13 14 15 16
import 'utils/date_localizations.dart' as util;
import 'widgets_localizations.dart';

/// Implementation of localized strings for Cupertino widgets using the `intl`
/// package for date and time formatting.
///
/// Further localization of strings beyond date time formatting are provided
17 18 19 20 21 22 23 24
/// by language specific subclasses of [GlobalCupertinoLocalizations].
///
/// ## Supported languages
///
/// This class supports locales with the following [Locale.languageCode]s:
///
/// {@macro flutter.localizations.cupertino.languages}
///
25
/// This list is available programmatically via [kCupertinoSupportedLanguages].
26 27 28 29 30 31 32 33 34
///
/// ## Sample code
///
/// To include the localizations provided by this class in a [CupertinoApp],
/// add [GlobalCupertinoLocalizations.delegates] to
/// [CupertinoApp.localizationsDelegates], and specify the locales your
/// app supports with [CupertinoApp.supportedLocales]:
///
/// ```dart
35
/// CupertinoApp(
36 37 38 39 40 41 42 43 44
///   localizationsDelegates: GlobalCupertinoLocalizations.delegates,
///   supportedLocales: [
///     const Locale('en', 'US'), // American English
///     const Locale('he', 'IL'), // Israeli Hebrew
///     // ...
///   ],
///   // ...
/// )
/// ```
45 46 47 48 49 50 51 52 53 54 55 56
///
/// See also:
///
///  * [DefaultCupertinoLocalizations], which provides US English localizations
///    for Cupertino widgets.
abstract class GlobalCupertinoLocalizations implements CupertinoLocalizations {
  /// Initializes an object that defines the Cupertino widgets' localized
  /// strings for the given `localeName`.
  ///
  /// The remaining '*Format' arguments uses the intl package to provide
  /// [DateFormat] configurations for the `localeName`.
  const GlobalCupertinoLocalizations({
57 58 59 60 61 62 63 64 65
    required String localeName,
    required intl.DateFormat fullYearFormat,
    required intl.DateFormat dayFormat,
    required intl.DateFormat mediumDateFormat,
    required intl.DateFormat singleDigitHourFormat,
    required intl.DateFormat singleDigitMinuteFormat,
    required intl.DateFormat doubleDigitMinuteFormat,
    required intl.DateFormat singleDigitSecondFormat,
    required intl.NumberFormat decimalFormat,
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  }) : assert(localeName != null),
       _localeName = localeName,
       assert(fullYearFormat != null),
       _fullYearFormat = fullYearFormat,
       assert(dayFormat != null),
       _dayFormat = dayFormat,
       assert(mediumDateFormat != null),
       _mediumDateFormat = mediumDateFormat,
       assert(singleDigitHourFormat != null),
       _singleDigitHourFormat = singleDigitHourFormat,
       assert(singleDigitMinuteFormat != null),
       _singleDigitMinuteFormat = singleDigitMinuteFormat,
       assert(doubleDigitMinuteFormat != null),
       _doubleDigitMinuteFormat = doubleDigitMinuteFormat,
       assert(singleDigitSecondFormat != null),
       _singleDigitSecondFormat = singleDigitSecondFormat,
       assert(decimalFormat != null),
       _decimalFormat =decimalFormat;

  final String _localeName;
  final intl.DateFormat _fullYearFormat;
  final intl.DateFormat _dayFormat;
  final intl.DateFormat _mediumDateFormat;
  final intl.DateFormat _singleDigitHourFormat;
  final intl.DateFormat _singleDigitMinuteFormat;
  final intl.DateFormat _doubleDigitMinuteFormat;
  final intl.DateFormat _singleDigitSecondFormat;
  final intl.NumberFormat _decimalFormat;

  @override
  String datePickerYear(int yearIndex) {
    return _fullYearFormat.format(DateTime.utc(yearIndex));
  }

  @override
  String datePickerMonth(int monthIndex) {
    // It doesn't actually have anything to do with _fullYearFormat. It's just
    // taking advantage of the fact that _fullYearFormat loaded the needed
    // locale's symbols.
    return _fullYearFormat.dateSymbols.MONTHS[monthIndex - 1];
  }

  @override
  String datePickerDayOfMonth(int dayIndex) {
    // Year and month doesn't matter since we just want to day formatted.
    return _dayFormat.format(DateTime.utc(0, 0, dayIndex));
  }

  @override
  String datePickerMediumDate(DateTime date) {
    return _mediumDateFormat.format(date);
  }

  @override
  String datePickerHour(int hour) {
    return _singleDigitHourFormat.format(DateTime.utc(0, 0, 0, hour));
  }

  @override
  String datePickerMinute(int minute) {
    return _doubleDigitMinuteFormat.format(DateTime.utc(0, 0, 0, 0, minute));
  }

  /// Subclasses should provide the optional zero pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
130 131
  @protected
  String? get datePickerHourSemanticsLabelZero => null;
132
  /// Subclasses should provide the optional one pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
133 134
  @protected
  String? get datePickerHourSemanticsLabelOne => null;
135
  /// Subclasses should provide the optional two pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
136 137
  @protected
  String? get datePickerHourSemanticsLabelTwo => null;
138
  /// Subclasses should provide the optional few pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
139 140
  @protected
  String? get datePickerHourSemanticsLabelFew => null;
141
  /// Subclasses should provide the optional many pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
142 143
  @protected
  String? get datePickerHourSemanticsLabelMany => null;
144
  /// Subclasses should provide the required other pluralization of [datePickerHourSemanticsLabel] based on the ARB file.
145 146
  @protected
  String? get datePickerHourSemanticsLabelOther;
147 148

  @override
149
  String? datePickerHourSemanticsLabel(int hour) {
150 151 152 153 154 155 156 157 158
    return intl.Intl.pluralLogic(
      hour,
      zero: datePickerHourSemanticsLabelZero,
      one: datePickerHourSemanticsLabelOne,
      two: datePickerHourSemanticsLabelTwo,
      few: datePickerHourSemanticsLabelFew,
      many: datePickerHourSemanticsLabelMany,
      other: datePickerHourSemanticsLabelOther,
      locale: _localeName,
159
    )?.replaceFirst(r'$hour', _decimalFormat.format(hour));
160 161 162
  }

  /// Subclasses should provide the optional zero pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
163 164
  @protected
  String? get datePickerMinuteSemanticsLabelZero => null;
165
  /// Subclasses should provide the optional one pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
166 167
  @protected
  String? get datePickerMinuteSemanticsLabelOne => null;
168
  /// Subclasses should provide the optional two pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
169 170
  @protected
  String? get datePickerMinuteSemanticsLabelTwo => null;
171
  /// Subclasses should provide the optional few pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
172 173
  @protected
  String? get datePickerMinuteSemanticsLabelFew => null;
174
  /// Subclasses should provide the optional many pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
175 176
  @protected
  String? get datePickerMinuteSemanticsLabelMany => null;
177
  /// Subclasses should provide the required other pluralization of [datePickerMinuteSemanticsLabel] based on the ARB file.
178 179
  @protected
  String? get datePickerMinuteSemanticsLabelOther;
180 181

  @override
182
  String? datePickerMinuteSemanticsLabel(int minute) {
183 184 185 186 187 188 189 190 191
    return intl.Intl.pluralLogic(
      minute,
      zero: datePickerMinuteSemanticsLabelZero,
      one: datePickerMinuteSemanticsLabelOne,
      two: datePickerMinuteSemanticsLabelTwo,
      few: datePickerMinuteSemanticsLabelFew,
      many: datePickerMinuteSemanticsLabelMany,
      other: datePickerMinuteSemanticsLabelOther,
      locale: _localeName,
192
    )?.replaceFirst(r'$minute', _decimalFormat.format(minute));
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  }

  /// A string describing the [DatePickerDateOrder] enum value.
  ///
  /// Subclasses should provide this string value based on the ARB file for
  /// the locale.
  ///
  /// See also:
  ///
  ///  * [datePickerDateOrder], which provides the [DatePickerDateOrder]
  ///    enum value for [CupertinoLocalizations] based on this string value
  @protected
  String get datePickerDateOrderString;

  @override
  DatePickerDateOrder get datePickerDateOrder {
    switch (datePickerDateOrderString) {
      case 'dmy':
        return DatePickerDateOrder.dmy;
      case 'mdy':
        return DatePickerDateOrder.mdy;
      case 'ymd':
        return DatePickerDateOrder.ymd;
      case 'ydm':
        return DatePickerDateOrder.ydm;
      default:
        assert(
          false,
          'Failed to load DatePickerDateOrder $datePickerDateOrderString for '
222
          "locale $_localeName.\nNon conforming string for $_localeName's "
223 224
          '.arb file',
        );
225
        return DatePickerDateOrder.mdy;
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    }
  }

  /// A string describing the [DatePickerDateTimeOrder] enum value.
  ///
  /// Subclasses should provide this string value based on the ARB file for
  /// the locale.
  ///
  /// See also:
  ///
  ///  * [datePickerDateTimeOrder], which provides the [DatePickerDateTimeOrder]
  ///    enum value for [CupertinoLocalizations] based on this string value.
  @protected
  String get datePickerDateTimeOrderString;

  @override
  DatePickerDateTimeOrder get datePickerDateTimeOrder {
    switch (datePickerDateTimeOrderString) {
      case 'date_time_dayPeriod':
        return DatePickerDateTimeOrder.date_time_dayPeriod;
      case 'date_dayPeriod_time':
        return DatePickerDateTimeOrder.date_dayPeriod_time;
      case 'time_dayPeriod_date':
        return DatePickerDateTimeOrder.time_dayPeriod_date;
      case 'dayPeriod_time_date':
        return DatePickerDateTimeOrder.dayPeriod_time_date;
      default:
        assert(
          false,
          'Failed to load DatePickerDateTimeOrder $datePickerDateTimeOrderString '
256
          "for locale $_localeName.\nNon conforming string for $_localeName's "
257 258
          '.arb file',
        );
259
        return DatePickerDateTimeOrder.date_time_dayPeriod;
260 261 262
    }
  }

263 264 265 266 267 268
  /// The raw version of [tabSemanticsLabel], with `$tabIndex` and `$tabCount` verbatim
  /// in the string.
  @protected
  String get tabSemanticsLabelRaw;

  @override
269
  String tabSemanticsLabel({ required int tabIndex, required int tabCount }) {
270 271 272 273 274 275 276 277
    assert(tabIndex >= 1);
    assert(tabCount >= 1);
    final String template = tabSemanticsLabelRaw;
    return template
      .replaceFirst(r'$tabIndex', _decimalFormat.format(tabIndex))
      .replaceFirst(r'$tabCount', _decimalFormat.format(tabCount));
  }

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  @override
  String timerPickerHour(int hour) {
    return _singleDigitHourFormat.format(DateTime.utc(0, 0, 0, hour));
  }

  @override
  String timerPickerMinute(int minute) {
    return _singleDigitMinuteFormat.format(DateTime.utc(0, 0, 0, 0, minute));
  }

  @override
  String timerPickerSecond(int second) {
    return _singleDigitSecondFormat.format(DateTime.utc(0, 0, 0, 0, 0, second));
  }

  /// Subclasses should provide the optional zero pluralization of [timerPickerHourLabel] based on the ARB file.
294 295
  @protected
  String? get timerPickerHourLabelZero => null;
296
  /// Subclasses should provide the optional one pluralization of [timerPickerHourLabel] based on the ARB file.
297 298
  @protected
  String? get timerPickerHourLabelOne => null;
299
  /// Subclasses should provide the optional two pluralization of [timerPickerHourLabel] based on the ARB file.
300 301
  @protected
  String? get timerPickerHourLabelTwo => null;
302
  /// Subclasses should provide the optional few pluralization of [timerPickerHourLabel] based on the ARB file.
303 304
  @protected
  String? get timerPickerHourLabelFew => null;
305
  /// Subclasses should provide the optional many pluralization of [timerPickerHourLabel] based on the ARB file.
306 307
  @protected
  String? get timerPickerHourLabelMany => null;
308
  /// Subclasses should provide the required other pluralization of [timerPickerHourLabel] based on the ARB file.
309 310
  @protected
  String? get timerPickerHourLabelOther;
311 312

  @override
313
  String? timerPickerHourLabel(int hour) {
314 315 316 317 318 319 320 321 322
    return intl.Intl.pluralLogic(
      hour,
      zero: timerPickerHourLabelZero,
      one: timerPickerHourLabelOne,
      two: timerPickerHourLabelTwo,
      few: timerPickerHourLabelFew,
      many: timerPickerHourLabelMany,
      other: timerPickerHourLabelOther,
      locale: _localeName,
323
    )?.replaceFirst(r'$hour', _decimalFormat.format(hour));
324 325
  }

326 327
  @override
  List<String> get timerPickerHourLabels => <String>[
328 329 330 331 332 333
    if (timerPickerHourLabelZero != null) timerPickerHourLabelZero!,
    if (timerPickerHourLabelOne != null) timerPickerHourLabelOne!,
    if (timerPickerHourLabelTwo != null) timerPickerHourLabelTwo!,
    if (timerPickerHourLabelFew != null) timerPickerHourLabelFew!,
    if (timerPickerHourLabelMany != null) timerPickerHourLabelMany!,
    if (timerPickerHourLabelOther != null) timerPickerHourLabelOther!,
334 335
  ];

336
  /// Subclasses should provide the optional zero pluralization of [timerPickerMinuteLabel] based on the ARB file.
337 338
  @protected
  String? get timerPickerMinuteLabelZero => null;
339
  /// Subclasses should provide the optional one pluralization of [timerPickerMinuteLabel] based on the ARB file.
340 341
  @protected
  String? get timerPickerMinuteLabelOne => null;
342
  /// Subclasses should provide the optional two pluralization of [timerPickerMinuteLabel] based on the ARB file.
343 344
  @protected
  String? get timerPickerMinuteLabelTwo => null;
345
  /// Subclasses should provide the optional few pluralization of [timerPickerMinuteLabel] based on the ARB file.
346 347
  @protected
  String? get timerPickerMinuteLabelFew => null;
348
  /// Subclasses should provide the optional many pluralization of [timerPickerMinuteLabel] based on the ARB file.
349 350
  @protected
  String? get timerPickerMinuteLabelMany => null;
351
  /// Subclasses should provide the required other pluralization of [timerPickerMinuteLabel] based on the ARB file.
352 353
  @protected
  String? get timerPickerMinuteLabelOther;
354 355

  @override
356
  String? timerPickerMinuteLabel(int minute) {
357 358 359 360 361 362 363 364 365
    return intl.Intl.pluralLogic(
      minute,
      zero: timerPickerMinuteLabelZero,
      one: timerPickerMinuteLabelOne,
      two: timerPickerMinuteLabelTwo,
      few: timerPickerMinuteLabelFew,
      many: timerPickerMinuteLabelMany,
      other: timerPickerMinuteLabelOther,
      locale: _localeName,
366
    )?.replaceFirst(r'$minute', _decimalFormat.format(minute));
367 368
  }

369 370
  @override
  List<String> get timerPickerMinuteLabels => <String>[
371 372 373 374 375 376
    if (timerPickerMinuteLabelZero != null) timerPickerMinuteLabelZero!,
    if (timerPickerMinuteLabelOne != null) timerPickerMinuteLabelOne!,
    if (timerPickerMinuteLabelTwo != null) timerPickerMinuteLabelTwo!,
    if (timerPickerMinuteLabelFew != null) timerPickerMinuteLabelFew!,
    if (timerPickerMinuteLabelMany != null) timerPickerMinuteLabelMany!,
    if (timerPickerMinuteLabelOther != null) timerPickerMinuteLabelOther!,
377 378
  ];

379
  /// Subclasses should provide the optional zero pluralization of [timerPickerSecondLabel] based on the ARB file.
380 381
  @protected
  String? get timerPickerSecondLabelZero => null;
382
  /// Subclasses should provide the optional one pluralization of [timerPickerSecondLabel] based on the ARB file.
383 384
  @protected
  String? get timerPickerSecondLabelOne => null;
385
  /// Subclasses should provide the optional two pluralization of [timerPickerSecondLabel] based on the ARB file.
386 387
  @protected
  String? get timerPickerSecondLabelTwo => null;
388
  /// Subclasses should provide the optional few pluralization of [timerPickerSecondLabel] based on the ARB file.
389 390
  @protected
  String? get timerPickerSecondLabelFew => null;
391
  /// Subclasses should provide the optional many pluralization of [timerPickerSecondLabel] based on the ARB file.
392 393
  @protected
  String? get timerPickerSecondLabelMany => null;
394
  /// Subclasses should provide the required other pluralization of [timerPickerSecondLabel] based on the ARB file.
395 396
  @protected
  String? get timerPickerSecondLabelOther;
397 398

  @override
399
  String? timerPickerSecondLabel(int second) {
400 401 402 403 404 405 406 407 408
    return intl.Intl.pluralLogic(
      second,
      zero: timerPickerSecondLabelZero,
      one: timerPickerSecondLabelOne,
      two: timerPickerSecondLabelTwo,
      few: timerPickerSecondLabelFew,
      many: timerPickerSecondLabelMany,
      other: timerPickerSecondLabelOther,
      locale: _localeName,
409
    )?.replaceFirst(r'$second', _decimalFormat.format(second));
410 411
  }

412 413
  @override
  List<String> get timerPickerSecondLabels => <String>[
414 415 416 417 418 419
    if (timerPickerSecondLabelZero != null) timerPickerSecondLabelZero!,
    if (timerPickerSecondLabelOne != null) timerPickerSecondLabelOne!,
    if (timerPickerSecondLabelTwo != null) timerPickerSecondLabelTwo!,
    if (timerPickerSecondLabelFew != null) timerPickerSecondLabelFew!,
    if (timerPickerSecondLabelMany != null) timerPickerSecondLabelMany!,
    if (timerPickerSecondLabelOther != null) timerPickerSecondLabelOther!,
420 421
  ];

422
  /// A [LocalizationsDelegate] for [CupertinoLocalizations].
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  ///
  /// Most internationalized apps will use [GlobalCupertinoLocalizations.delegates]
  /// as the value of [CupertinoApp.localizationsDelegates] to include
  /// the localizations for both the cupertino and widget libraries.
  static const LocalizationsDelegate<CupertinoLocalizations> delegate = _GlobalCupertinoLocalizationsDelegate();

  /// A value for [CupertinoApp.localizationsDelegates] that's typically used by
  /// internationalized apps.
  ///
  /// ## Sample code
  ///
  /// To include the localizations provided by this class and by
  /// [GlobalWidgetsLocalizations] in a [CupertinoApp],
  /// use [GlobalCupertinoLocalizations.delegates] as the value of
  /// [CupertinoApp.localizationsDelegates], and specify the locales your
  /// app supports with [CupertinoApp.supportedLocales]:
  ///
  /// ```dart
441
  /// CupertinoApp(
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
  ///   localizationsDelegates: GlobalCupertinoLocalizations.delegates,
  ///   supportedLocales: [
  ///     const Locale('en', 'US'), // English
  ///     const Locale('he', 'IL'), // Hebrew
  ///   ],
  ///   // ...
  /// )
  /// ```
  static const List<LocalizationsDelegate<dynamic>> delegates = <LocalizationsDelegate<dynamic>>[
    GlobalCupertinoLocalizations.delegate,
    GlobalWidgetsLocalizations.delegate,
  ];
}

class _GlobalCupertinoLocalizationsDelegate extends LocalizationsDelegate<CupertinoLocalizations> {
  const _GlobalCupertinoLocalizationsDelegate();

  @override
460
  bool isSupported(Locale locale) => kCupertinoSupportedLanguages.contains(locale.languageCode);
461 462 463 464 465

  static final Map<Locale, Future<CupertinoLocalizations>> _loadedTranslations = <Locale, Future<CupertinoLocalizations>>{};

  @override
  Future<CupertinoLocalizations> load(Locale locale) {
466
    assert(isSupported(locale));
467 468 469 470 471 472 473 474 475 476
    return _loadedTranslations.putIfAbsent(locale, () {
      util.loadDateIntlDataIfNotLoaded();

      final String localeName = intl.Intl.canonicalizedLocale(locale.toString());
      assert(
        locale.toString() == localeName,
        'Flutter does not support the non-standard locale form $locale (which '
        'might be $localeName',
      );

477 478 479
      late intl.DateFormat fullYearFormat;
      late intl.DateFormat dayFormat;
      late intl.DateFormat mediumDateFormat;
480 481
      // We don't want any additional decoration here. The am/pm is handled in
      // the date picker. We just want an hour number localized.
482 483 484 485 486
      late intl.DateFormat singleDigitHourFormat;
      late intl.DateFormat singleDigitMinuteFormat;
      late intl.DateFormat doubleDigitMinuteFormat;
      late intl.DateFormat singleDigitSecondFormat;
      late intl.NumberFormat decimalFormat;
487

488
      void loadFormats(String? locale) {
489 490 491 492 493 494 495 496
        fullYearFormat = intl.DateFormat.y(locale);
        dayFormat = intl.DateFormat.d(locale);
        mediumDateFormat = intl.DateFormat.MMMEd(locale);
        // TODO(xster): fix when https://github.com/dart-lang/intl/issues/207 is resolved.
        singleDigitHourFormat = intl.DateFormat('HH', locale);
        singleDigitMinuteFormat = intl.DateFormat.m(locale);
        doubleDigitMinuteFormat = intl.DateFormat('mm', locale);
        singleDigitSecondFormat = intl.DateFormat.s(locale);
497
        decimalFormat = intl.NumberFormat.decimalPattern(locale);
498 499 500 501 502 503 504 505 506 507
      }

      if (intl.DateFormat.localeExists(localeName)) {
        loadFormats(localeName);
      } else if (intl.DateFormat.localeExists(locale.languageCode)) {
        loadFormats(locale.languageCode);
      } else {
        loadFormats(null);
      }

508 509
      return SynchronousFuture<CupertinoLocalizations>(getCupertinoTranslation(
        locale,
510 511 512 513 514 515 516 517
        fullYearFormat,
        dayFormat,
        mediumDateFormat,
        singleDigitHourFormat,
        singleDigitMinuteFormat,
        doubleDigitMinuteFormat,
        singleDigitSecondFormat,
        decimalFormat,
518
      )!);
519 520 521 522 523 524
    });
  }

  @override
  bool shouldReload(_GlobalCupertinoLocalizationsDelegate old) => false;

525 526
  @override
  String toString() => 'GlobalCupertinoLocalizations.delegate(${kCupertinoSupportedLanguages.length} locales)';
527
}