1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 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 222 223 224 225 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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
use alloc::vec;
use alloc::vec::Vec;
use core::cmp::Ordering;
use super::plural::PatternPlurals;
use crate::{
fields::{self, components, Field, FieldLength, FieldSymbol},
options::FractionalSecondDigits,
provider::{
calendar::{
patterns::{FullLongMediumShort, GenericLengthPatternsV1},
DateSkeletonPatternsV1,
},
pattern::{naively_apply_preferences, runtime, PatternItem, TimeGranularity},
},
};
#[cfg(feature = "datagen")]
use crate::provider::calendar::{DateLengthsV1, TimeLengthsV1};
// The following scalar values are for testing the suitability of a skeleton's field for the
// given input. Per UTS 35, the better the fit of a pattern, the "lower the distance". In this
// implementation each distance type is separated by an order of magnitiude. This magnitude needs
// to be at minimum a multiple of the max length of fields. As of CLDR 38 (2021-01), the max length
// of a skeleton in the "availableFormats" contained a total of 4 fields. The scores use a multiple
// of 10, as a number that will contain the range, and be easy to reason with.
//
// The only exception is on the largest magnitude of values (MISSING_OR_SKELETON_EXTRA_SYMBOL). The
// missing or extra count BOTH the requested fields and skeleton fields. This is fine since there
// is no higher magnitude.
const MAX_SKELETON_FIELDS: u32 = 10;
// Per the skeleton matching algorithm:
// https://unicode.org/reports/tr35/tr35-dates.html#Matching_Skeletons
// > 1. "Input skeleton symbols" are replaced with the best match for a given locale.
// > - Hour: j → {H, k, h, K} + {a, b, B}
// > J → {H, k, h, K}
// > C → j + day period
// The components::Bag does not support step 1
// > 2. For fields with symbols representing the same type (year, month, day, etc):
// > A. Most symbols have a small distance from each other.
// > - Months: M ≅ L (9 ≅ 9) conjunction, vs stand-alone
// > Week: E ≅ c (Tue ≅ 2)
// > Period: a ≅ b ≅ B (am. ≅ mid. ≅ at night)
// > Hour: H ≅ k ≅ h ≅ K (23, 24, 12, 11)
// For step 2, the components::Bag will not produce "stand-alone" months, as no skeletons
// contain stand-alone months.
const NO_DISTANCE: u32 = 0;
// B. Width differences among fields, other than those marking text vs numeric, are given small
// distance from each other.
// - MMM ≅ MMMM (Sep ≅ September)
// MM ≅ M (09 ≅ 9)
const WIDTH_MISMATCH_DISTANCE: u32 = 1;
// C. Numeric and text fields are given a larger distance from each other.
// - MMM ≈ MM (Sep ≈ 09)
// MMM
const TEXT_VS_NUMERIC_DISTANCE: u32 = 10;
// D. Symbols representing substantial differences (week of year vs week of month) are given much
// larger a distances from each other.
// - d ≋ D; (12 ≋ 345) Day of month vs Day of year
const SUBSTANTIAL_DIFFERENCES_DISTANCE: u32 = 100;
// A skeleton had more symbols than what was requested.
const SKELETON_EXTRA_SYMBOL: u32 = 1000;
// A requested symbol is missing in the skeleton. Note that this final value can be more than
// MAX_SKELETON_FIELDS, as it's counting the missing requested fields, which can be longer than
// the stored skeletons. There cannot be any cases higher than this one.
const REQUESTED_SYMBOL_MISSING: u32 = 10000;
/// The best skeleton found, alongside information on how well it matches.
///
/// According to the [UTS 35 skeleton matching algorithm](https://unicode.org/reports/tr35/tr35-dates.html#Matching_Skeletons)
/// there will be a guaranteed match for a skeleton. However, with this initial implementation,
/// there is no attempt to add on missing fields. This enum encodes the variants for the current
/// search for a best skeleton.
#[derive(Debug, PartialEq, Clone)]
#[allow(missing_docs)]
pub enum BestSkeleton<T> {
AllFieldsMatch(T),
MissingOrExtraFields(T),
NoMatch,
}
/// This function swaps out the time zone name field for the appropriate one. Skeleton matching
/// only needs to find a single "v" field, and then the time zone name can expand from there.
fn naively_apply_time_zone_name(
pattern: &mut runtime::Pattern,
time_zone_name: &Option<components::TimeZoneName>,
) {
// If there is a preference overriding the hour cycle, apply it now.
if let Some(time_zone_name) = time_zone_name {
runtime::helpers::maybe_replace_first(pattern, |item| {
if let PatternItem::Field(fields::Field {
symbol: fields::FieldSymbol::TimeZone(_),
length: _,
}) = item
{
Some(PatternItem::Field((*time_zone_name).into()))
} else {
None
}
});
}
}
// TODO - This could return a Cow<'a, Pattern>, but it affects every other part of the API to
// add a lifetime here. The pattern returned here could be one that we've already constructed in
// the CLDR as an exotic type, or it could be one that was modified to meet the requirements of
// the components bag.
/// Given a set of fields (which represents a skeleton), try to create a best localized pattern
// for those fields.
///
/// * `skeletons` - The skeletons that will be matched against
/// * `length_patterns` - Contains information on how to combine date and time patterns.
/// * `fields` - The desired fields to match against.
/// * `prefer_matched_pattern` - This algorithm does some extra steps of trying to respect
/// the desired fields, even if the provider data doesn't completely match. This
/// configuration option makes it so that the final pattern won't have additional work
/// done to mutate it to match the fields. It will prefer the actual matched pattern.
pub fn create_best_pattern_for_fields<'data>(
skeletons: &DateSkeletonPatternsV1<'data>,
length_patterns: &GenericLengthPatternsV1<'data>,
fields: &[Field],
components: &components::Bag,
prefer_matched_pattern: bool,
) -> BestSkeleton<PatternPlurals<'data>> {
let first_pattern_match =
get_best_available_format_pattern(skeletons, fields, prefer_matched_pattern);
// Try to match a skeleton to all of the fields.
if let BestSkeleton::AllFieldsMatch(mut pattern_plurals) = first_pattern_match {
pattern_plurals.for_each_mut(|pattern| {
naively_apply_preferences(pattern, components.hour_cycle);
naively_apply_time_zone_name(pattern, &components.time_zone_name);
apply_fractional_seconds(pattern, components.fractional_second);
});
return BestSkeleton::AllFieldsMatch(pattern_plurals);
}
let FieldsByType { date, time } = group_fields_by_type(fields);
if date.is_empty() || time.is_empty() {
return match first_pattern_match {
BestSkeleton::AllFieldsMatch(_) => {
unreachable!("Logic error in implementation. AllFieldsMatch handled above.")
}
BestSkeleton::MissingOrExtraFields(mut pattern_plurals) => {
if date.is_empty() {
pattern_plurals.for_each_mut(|pattern| {
naively_apply_preferences(pattern, components.hour_cycle);
naively_apply_time_zone_name(pattern, &components.time_zone_name);
apply_fractional_seconds(pattern, components.fractional_second);
});
}
BestSkeleton::MissingOrExtraFields(pattern_plurals)
}
BestSkeleton::NoMatch => BestSkeleton::NoMatch,
};
}
// Match the date and time, and then simplify the combinatorial logic of the results into
// an optional values of the results, and a boolean value.
let (date_patterns, date_missing_or_extra): (Option<PatternPlurals<'data>>, bool) =
match get_best_available_format_pattern(skeletons, &date, prefer_matched_pattern) {
BestSkeleton::MissingOrExtraFields(fields) => (Some(fields), true),
BestSkeleton::AllFieldsMatch(fields) => (Some(fields), false),
BestSkeleton::NoMatch => (None, true),
};
let (time_patterns, time_missing_or_extra): (Option<PatternPlurals<'data>>, bool) =
match get_best_available_format_pattern(skeletons, &time, prefer_matched_pattern) {
BestSkeleton::MissingOrExtraFields(fields) => (Some(fields), true),
BestSkeleton::AllFieldsMatch(fields) => (Some(fields), false),
BestSkeleton::NoMatch => (None, true),
};
let time_pattern: Option<runtime::Pattern<'data>> = time_patterns.map(|pattern_plurals| {
let mut pattern =
pattern_plurals.expect_pattern("Only date patterns can contain plural variants");
naively_apply_preferences(&mut pattern, components.hour_cycle);
naively_apply_time_zone_name(&mut pattern, &components.time_zone_name);
apply_fractional_seconds(&mut pattern, components.fractional_second);
pattern
});
// Determine how to combine the date and time.
let patterns: Option<PatternPlurals<'data>> = match (date_patterns, time_pattern) {
(Some(mut date_patterns), Some(time_pattern)) => {
let month_field = fields
.iter()
.find(|f| matches!(f.symbol, FieldSymbol::Month(_)));
// Per UTS-35, choose a "length" pattern for combining the date and time.
// https://unicode.org/reports/tr35/tr35-dates.html#Matching_Skeletons
//
// 1. If the requested date fields include Wide month and weekday name of any length, use length::Date::Full
// 2. Otherwise, if the requested date fields include wide month, use length::Date::Long
// 3. Otherwise, if the requested date fields include abbreviated month, use length::Date::Medium
// 4. Otherwise use length::Date::Short
let length = match month_field {
Some(field) => match field.length {
FieldLength::Four => {
let weekday = fields
.iter()
.find(|f| matches!(f.symbol, FieldSymbol::Weekday(_)));
if weekday.is_some() {
FullLongMediumShort::Full
} else {
FullLongMediumShort::Long
}
}
FieldLength::Three => FullLongMediumShort::Medium,
_ => FullLongMediumShort::Short,
},
None => FullLongMediumShort::Short,
};
use crate::provider::pattern::runtime::GenericPattern;
let dt_pattern: &GenericPattern<'data> = match length {
FullLongMediumShort::Full => &length_patterns.full,
FullLongMediumShort::Long => &length_patterns.long,
FullLongMediumShort::Medium => &length_patterns.medium,
FullLongMediumShort::Short => &length_patterns.short,
};
date_patterns.for_each_mut(|pattern| {
let date = pattern.clone();
let time = time_pattern.clone();
// TODO(#2626) - Since this is fallible, we should make this method fallible.
#[allow(clippy::expect_used)] // Generic pattern combination should never fail.
let dt = dt_pattern
.clone()
.combined(date, time)
.expect("Failed to combine date and time");
*pattern = dt;
});
Some(date_patterns)
}
(None, Some(pattern)) => Some(pattern.into()),
(Some(patterns), None) => Some(patterns),
(None, None) => None,
};
match patterns {
Some(patterns) => {
if date_missing_or_extra || time_missing_or_extra {
BestSkeleton::MissingOrExtraFields(patterns)
} else {
BestSkeleton::AllFieldsMatch(patterns)
}
}
None => BestSkeleton::NoMatch,
}
}
struct FieldsByType {
pub date: Vec<Field>,
pub time: Vec<Field>,
}
fn group_fields_by_type(fields: &[Field]) -> FieldsByType {
let mut date = Vec::new();
let mut time = Vec::new();
for field in fields {
match field.symbol {
// Date components:
// Note: Weekdays are included in both time and date skeletons.
// - Time examples: "EBhm" "EBhms" "Ed" "Ehm" "EHm" "Ehms" "EHms"
// - Date examples: "GyMMMEd" "MEd" "MMMEd" "MMMMEd" "yMEd" "yMMMEd"
// - Solo example: "E"
FieldSymbol::Era
| FieldSymbol::Year(_)
| FieldSymbol::Month(_)
| FieldSymbol::Week(_)
| FieldSymbol::Day(_)
| FieldSymbol::Weekday(_) => date.push(*field),
// Time components:
FieldSymbol::DayPeriod(_)
| FieldSymbol::Hour(_)
| FieldSymbol::Minute
| FieldSymbol::Second(_)
| FieldSymbol::TimeZone(_)
| FieldSymbol::DecimalSecond(_) => time.push(*field),
// Other components
// TODO(#486)
// FieldSymbol::Era(_) => other.push(*field),
// Plus others...
};
}
FieldsByType { date, time }
}
/// Alters given Pattern so that its fields have the same length as 'fields'.
///
/// For example the "d MMM y" pattern will be changed to "d MMMM y" given fields ["y", "MMMM", "d"].
fn adjust_pattern_field_lengths(fields: &[Field], pattern: &mut runtime::Pattern) {
runtime::helpers::maybe_replace(pattern, |item| {
if let PatternItem::Field(pattern_field) = item {
if let Some(requested_field) = fields
.iter()
.find(|field| field.symbol.skeleton_cmp(&pattern_field.symbol).is_eq())
{
if requested_field.length != pattern_field.length
&& requested_field.get_length_type() == pattern_field.get_length_type()
{
let length = requested_field.length;
let length = if requested_field.symbol.is_at_least_abbreviated() {
length.numeric_to_abbr()
} else {
length
};
return Some(PatternItem::Field(Field {
length,
..*pattern_field
}));
}
}
}
None
})
}
/// Alters given Pattern so that it will have a fractional second field if it was requested.
///
/// If the requested skeleton included both seconds and fractional seconds and the dateFormatItem
/// skeleton included seconds but not fractional seconds, then the seconds field of the corresponding
/// pattern should be adjusted by appending the locale’s decimal separator, followed by the sequence
/// of ‘S’ characters from the requested skeleton.
/// (see <https://unicode.org/reports/tr35/tr35-dates.html#Matching_Skeletons>)
fn apply_fractional_seconds(
pattern: &mut runtime::Pattern,
fractional_seconds: Option<FractionalSecondDigits>,
) {
use FractionalSecondDigits::*;
if let Some(fractional_seconds) = fractional_seconds {
let mut items = pattern.items.to_vec();
for item in items.iter_mut() {
if let PatternItem::Field(
ref mut field @ Field {
symbol:
FieldSymbol::Second(fields::Second::Second) | FieldSymbol::DecimalSecond(_),
..
},
) = item
{
field.symbol = FieldSymbol::from_fractional_second_digits(fractional_seconds);
};
}
*pattern = runtime::Pattern::from(items);
pattern
.metadata
.set_time_granularity(if fractional_seconds == F0 {
TimeGranularity::Seconds
} else {
TimeGranularity::Nanoseconds
});
}
}
/// A partial implementation of the [UTS 35 skeleton matching algorithm](https://unicode.org/reports/tr35/tr35-dates.html#Matching_Skeletons).
///
/// The following is implemented:
///
/// * Compute a score based on the best possible match for the given fields.
/// * Select the skeleton with highest score.
/// * Modify the resulting pattern to have fields of the same length. For example requesting
/// a skeleton "yMMMMd" can have a best match of ["yMMMd", "d MMM y"]. This pattern should
/// then be modified to use the requested length to produce a pattern "d MMMM y".
/// However, fields should not be changed from numeric to text.
///
/// The following is not implemented:
///
/// * 2.6.2.2 Missing Skeleton Fields
/// - TODO(#586) - Using the CLDR appendItems field. Note: There is not agreement yet on how
/// much of this step to implement. See the issue for more information.
///
/// # Panics
///
/// Panics if `prefer_matched_pattern` is set to true in a non-datagen mode.
pub fn get_best_available_format_pattern<'data>(
skeletons: &DateSkeletonPatternsV1<'data>,
fields: &[Field],
prefer_matched_pattern: bool,
) -> BestSkeleton<PatternPlurals<'data>> {
let mut closest_format_pattern = None;
let mut closest_distance: u32 = u32::MAX;
let mut closest_missing_fields = 0;
for (skeleton, pattern) in skeletons.0.iter() {
debug_assert!(
skeleton.0.fields_len() <= MAX_SKELETON_FIELDS as usize,
"The distance mechanism assumes skeletons are less than MAX_SKELETON_FIELDS in length."
);
let mut missing_fields = 0;
let mut distance: u32 = 0;
// The distance should fit into a u32.
let mut requested_fields = fields.iter().peekable();
let mut skeleton_fields = skeleton.0.fields_iter().peekable();
loop {
let next = (requested_fields.peek(), skeleton_fields.peek());
// Try to find matching symbols.
match next {
(Some(requested_field), Some(skeleton_field)) => {
debug_assert!(
// As of the time of this writing, stand-alone months are not in the CLDR
// skeleton data. The components::Bag could produce stand-alone month fields,
// but since the CLDR does not have them, only Month::Format symbols are
// used for matching.
skeleton_field.symbol != FieldSymbol::Month(fields::Month::StandAlone)
);
match skeleton_field.symbol.skeleton_cmp(&requested_field.symbol) {
Ordering::Less => {
// Keep searching for a matching skeleton field.
skeleton_fields.next();
distance += SKELETON_EXTRA_SYMBOL;
continue;
}
Ordering::Greater => {
// The requested field symbol is missing from the skeleton.
distance += REQUESTED_SYMBOL_MISSING;
missing_fields += 1;
requested_fields.next();
continue;
}
_ => (),
}
distance += if requested_field == skeleton_field {
NO_DISTANCE
} else if requested_field.symbol != skeleton_field.symbol {
SUBSTANTIAL_DIFFERENCES_DISTANCE
} else if requested_field.get_length_type() != skeleton_field.get_length_type()
{
TEXT_VS_NUMERIC_DISTANCE
} else {
WIDTH_MISMATCH_DISTANCE
};
requested_fields.next();
skeleton_fields.next();
}
(None, Some(_)) => {
// The skeleton has additional fields that we are not matching.
distance += SKELETON_EXTRA_SYMBOL;
skeleton_fields.next();
}
(Some(_), None) => {
// The skeleton is missing requested fields.
distance += REQUESTED_SYMBOL_MISSING;
requested_fields.next();
missing_fields += 1;
}
(None, None) => {
break;
}
}
}
if distance < closest_distance {
closest_format_pattern = Some(pattern);
closest_distance = distance;
closest_missing_fields = missing_fields;
}
}
if !prefer_matched_pattern && closest_distance >= TEXT_VS_NUMERIC_DISTANCE {
if let [field] = fields {
// A single field was requested and the best pattern either includes extra fields or can't be adjusted to match
// (e.g. text vs numeric). We return the field instead of the matched pattern.
return BestSkeleton::AllFieldsMatch(
runtime::Pattern::from(vec![PatternItem::Field(*field)]).into(),
);
}
}
let mut closest_format_pattern = if let Some(pattern) = closest_format_pattern {
pattern.clone()
} else {
return BestSkeleton::NoMatch;
};
if closest_missing_fields == fields.len() {
return BestSkeleton::NoMatch;
}
if closest_distance == NO_DISTANCE {
return BestSkeleton::AllFieldsMatch(closest_format_pattern);
}
// Modify the resulting pattern to have fields of the same length.
#[allow(clippy::panic)] // guards against running this branch in non-datagen mode.
if prefer_matched_pattern {
#[cfg(not(feature = "datagen"))]
panic!("This code branch should only be run when transforming provider code.");
} else {
closest_format_pattern.for_each_mut(|pattern| {
adjust_pattern_field_lengths(fields, pattern);
});
}
if closest_distance >= SKELETON_EXTRA_SYMBOL {
return BestSkeleton::MissingOrExtraFields(closest_format_pattern);
}
BestSkeleton::AllFieldsMatch(closest_format_pattern)
}
impl components::Bag {
#[doc(hidden)] // TODO(#4467): Internal
#[cfg(feature = "datagen")]
pub fn select_pattern<'data>(
self,
skeletons: &DateSkeletonPatternsV1<'data>,
date_patterns: &DateLengthsV1<'data>,
time_patterns: &TimeLengthsV1<'data>,
) -> PatternPlurals<'data> {
use crate::provider::pattern::runtime::Pattern;
use crate::provider::pattern::CoarseHourCycle;
use icu_locale_core::preferences::extensions::unicode::keywords::HourCycle;
let default_hour_cycle = match time_patterns.preferred_hour_cycle {
CoarseHourCycle::H11H12 => HourCycle::H12,
CoarseHourCycle::H23H24 => HourCycle::H23,
};
let fields = self.to_vec_fields(default_hour_cycle);
match create_best_pattern_for_fields(
skeletons,
&date_patterns.length_combinations,
&fields,
&self,
false,
) {
BestSkeleton::AllFieldsMatch(p) => p,
_ => {
// Build a last-resort pattern that contains all of the requested fields.
// This is NOT in the CLDR standard! Better would be:
// - Use Append Items?
// - Fall back to the format from the Gregorian or Generic calendar?
// - Bubble up an error of some sort?
// See issue: <https://github.com/unicode-org/icu4x/issues/586>
let pattern_items = fields
.into_iter()
.flat_map(|field| [PatternItem::Literal(' '), PatternItem::Field(field)])
.skip(1)
.collect::<Vec<_>>();
let pattern = Pattern::from(pattern_items);
PatternPlurals::SinglePattern(pattern)
}
}
}
}