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 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
// 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 ).
// Various collation-related algorithms and constants in this file are
// adapted from ICU4C and, therefore, are subject to the ICU license as
// described in LICENSE.
//! This module holds the `Collator` struct whose `compare_impl()` contains
//! the comparison of collation element sequences.
use crate::elements::{
CollationElement, CollationElements, NonPrimary, JAMO_COUNT, NO_CE, NO_CE_PRIMARY,
NO_CE_SECONDARY, NO_CE_TERTIARY, OPTIMIZED_DIACRITICS_MAX_COUNT, QUATERNARY_MASK,
};
use crate::options::CollatorOptionsBitField;
use crate::provider::CollationDataV1;
use crate::provider::CollationDiacriticsV1;
use crate::provider::CollationDiacriticsV1Marker;
use crate::provider::CollationJamoV1;
use crate::provider::CollationJamoV1Marker;
use crate::provider::CollationMetadataV1Marker;
use crate::provider::CollationReorderingV1;
use crate::provider::CollationReorderingV1Marker;
use crate::provider::CollationRootV1Marker;
use crate::provider::CollationSpecialPrimariesV1;
use crate::provider::CollationSpecialPrimariesV1Marker;
use crate::provider::CollationTailoringV1Marker;
use crate::{AlternateHandling, CollatorOptions, MaxVariable, ResolvedCollatorOptions, Strength};
use core::cmp::Ordering;
use core::convert::TryFrom;
use icu_normalizer::provider::CanonicalDecompositionDataV2Marker;
use icu_normalizer::provider::CanonicalDecompositionTablesV1Marker;
use icu_normalizer::provider::DecompositionDataV2;
use icu_normalizer::provider::DecompositionTablesV1;
use icu_normalizer::Decomposition;
use icu_provider::prelude::*;
use smallvec::SmallVec;
use utf16_iter::Utf16CharsEx;
use utf8_iter::Utf8CharsEx;
use zerovec::ule::AsULE;
const MERGE_SEPARATOR_PRIMARY: u32 = 0x02000000; // for U+FFFE
struct AnyQuaternaryAccumulator(u32);
impl AnyQuaternaryAccumulator {
#[inline(always)]
pub fn new() -> Self {
AnyQuaternaryAccumulator(0)
}
#[inline(always)]
pub fn accumulate(&mut self, non_primary: NonPrimary) {
self.0 |= non_primary.bits()
}
#[inline(always)]
pub fn has_quaternary(&self) -> bool {
self.0 & u32::from(QUATERNARY_MASK) != 0
}
}
/// Holder struct for payloads that are locale-dependent. (For code
/// reuse between owned and borrowed cases.)
#[derive(Debug)]
struct LocaleSpecificDataHolder {
tailoring: Option<DataPayload<CollationTailoringV1Marker>>,
diacritics: DataPayload<CollationDiacriticsV1Marker>,
reordering: Option<DataPayload<CollationReorderingV1Marker>>,
merged_options: CollatorOptionsBitField,
lithuanian_dot_above: bool,
}
icu_locale_core::preferences::define_preferences!(
/// The preferences for collation.
[Copy]
CollatorPreferences,
{
/// The collation type. This corresponds to the `-u-co` BCP-47 tag.
collation_type: icu_locale_core::preferences::extensions::unicode::keywords::CollationType
}
);
impl LocaleSpecificDataHolder {
/// The constructor code reused between owned and borrowed cases.
fn try_new_unstable_internal<D>(
provider: &D,
prefs: CollatorPreferences,
options: CollatorOptions,
) -> Result<Self, DataError>
where
D: DataProvider<CollationTailoringV1Marker>
+ DataProvider<CollationDiacriticsV1Marker>
+ DataProvider<CollationMetadataV1Marker>
+ DataProvider<CollationReorderingV1Marker>
+ ?Sized,
{
let marker_attributes = prefs
.collation_type
.as_ref()
// all collation types are valid marker attributes
.map(|c| DataMarkerAttributes::from_str_or_panic(c.as_str()))
.unwrap_or_default();
let data_locale =
DataLocale::from_preferences_locale::<CollationTailoringV1Marker>(prefs.locale_prefs);
let id = DataIdentifierCow::from_borrowed_and_owned(marker_attributes, data_locale.clone());
let req = DataRequest {
id: id.as_borrowed(),
metadata: {
let mut metadata = DataRequestMetadata::default();
metadata.silent = true;
metadata
},
};
let fallback_id =
DataIdentifierCow::from_borrowed_and_owned(Default::default(), data_locale);
let fallback_req = DataRequest {
id: fallback_id.as_borrowed(),
..Default::default()
};
let metadata_payload: DataPayload<crate::provider::CollationMetadataV1Marker> = provider
.load(req)
.or_else(|_| provider.load(fallback_req))?
.payload;
let metadata = metadata_payload.get();
let tailoring: Option<DataPayload<crate::provider::CollationTailoringV1Marker>> =
if metadata.tailored() {
Some(
provider
.load(req)
.or_else(|_| provider.load(fallback_req))?
.payload,
)
} else {
None
};
let reordering: Option<DataPayload<crate::provider::CollationReorderingV1Marker>> =
if metadata.reordering() {
Some(
provider
.load(req)
.or_else(|_| provider.load(fallback_req))?
.payload,
)
} else {
None
};
if let Some(reordering) = &reordering {
if reordering.get().reorder_table.len() != 256 {
return Err(
DataError::custom("invalid").with_marker(CollationReorderingV1Marker::INFO)
);
}
}
let tailored_diacritics = metadata.tailored_diacritics();
let diacritics: DataPayload<CollationDiacriticsV1Marker> = provider
.load(if tailored_diacritics {
req
} else {
Default::default()
})?
.payload;
if tailored_diacritics {
// In the tailored case we accept a shorter table in which case the tailoring is
// responsible for supplying the missing values in the trie.
// As of June 2022, none of the collations actually use a shortened table.
// Vietnamese and Ewe load a full-length alternative table and the rest use
// the default one.
if diacritics.get().secondaries.len() > OPTIMIZED_DIACRITICS_MAX_COUNT {
return Err(
DataError::custom("invalid").with_marker(CollationDiacriticsV1Marker::INFO)
);
}
} else if diacritics.get().secondaries.len() != OPTIMIZED_DIACRITICS_MAX_COUNT {
return Err(DataError::custom("invalid").with_marker(CollationDiacriticsV1Marker::INFO));
}
let mut altered_defaults = CollatorOptionsBitField::default();
if metadata.alternate_shifted() {
altered_defaults.set_alternate_handling(Some(AlternateHandling::Shifted));
}
if metadata.backward_second_level() {
altered_defaults.set_backward_second_level(Some(true));
}
altered_defaults.set_case_first(Some(metadata.case_first()));
altered_defaults.set_max_variable(Some(metadata.max_variable()));
let mut merged_options = CollatorOptionsBitField::from(options);
merged_options.set_defaults(altered_defaults);
Ok(LocaleSpecificDataHolder {
tailoring,
diacritics,
merged_options,
reordering,
lithuanian_dot_above: metadata.lithuanian_dot_above(),
})
}
}
/// Compares strings according to culturally-relevant ordering.
#[derive(Debug)]
pub struct Collator {
special_primaries: Option<DataPayload<CollationSpecialPrimariesV1Marker>>,
root: DataPayload<CollationRootV1Marker>,
tailoring: Option<DataPayload<CollationTailoringV1Marker>>,
jamo: DataPayload<CollationJamoV1Marker>,
diacritics: DataPayload<CollationDiacriticsV1Marker>,
options: CollatorOptionsBitField,
reordering: Option<DataPayload<CollationReorderingV1Marker>>,
decompositions: DataPayload<CanonicalDecompositionDataV2Marker>,
tables: DataPayload<CanonicalDecompositionTablesV1Marker>,
lithuanian_dot_above: bool,
}
impl Collator {
/// Constructs a borrowed version of this type for more efficient querying.
pub fn as_borrowed(&self) -> CollatorBorrowed {
CollatorBorrowed {
special_primaries: self.special_primaries.as_ref().map(|s| s.get()),
root: self.root.get(),
tailoring: self.tailoring.as_ref().map(|s| s.get()),
jamo: self.jamo.get(),
diacritics: self.diacritics.get(),
options: self.options,
reordering: self.reordering.as_ref().map(|s| s.get()),
decompositions: self.decompositions.get(),
tables: self.tables.get(),
lithuanian_dot_above: self.lithuanian_dot_above,
}
}
/// Creates `CollatorBorrowed` for the given locale and options from compiled data.
#[cfg(feature = "compiled_data")]
pub fn try_new(
prefs: CollatorPreferences,
options: CollatorOptions,
) -> Result<CollatorBorrowed<'static>, DataError> {
CollatorBorrowed::try_new(prefs, options)
}
icu_provider::gen_any_buffer_data_constructors!(
(prefs: CollatorPreferences, options: CollatorOptions) -> error: DataError,
functions: [
try_new: skip,
try_new_with_any_provider,
try_new_with_buffer_provider,
try_new_unstable,
Self
]
);
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
pub fn try_new_unstable<D>(
provider: &D,
prefs: CollatorPreferences,
options: CollatorOptions,
) -> Result<Self, DataError>
where
D: DataProvider<CollationSpecialPrimariesV1Marker>
+ DataProvider<CollationRootV1Marker>
+ DataProvider<CollationTailoringV1Marker>
+ DataProvider<CollationDiacriticsV1Marker>
+ DataProvider<CollationJamoV1Marker>
+ DataProvider<CollationMetadataV1Marker>
+ DataProvider<CollationReorderingV1Marker>
+ DataProvider<CanonicalDecompositionDataV2Marker>
+ DataProvider<CanonicalDecompositionTablesV1Marker>
+ ?Sized,
{
Self::try_new_unstable_internal(
provider,
provider.load(Default::default())?.payload,
provider.load(Default::default())?.payload,
provider.load(Default::default())?.payload,
provider.load(Default::default())?.payload,
|| provider.load(Default::default()).map(|r| r.payload),
prefs,
options,
)
}
#[allow(clippy::too_many_arguments)]
fn try_new_unstable_internal<D>(
provider: &D,
root: DataPayload<CollationRootV1Marker>,
decompositions: DataPayload<CanonicalDecompositionDataV2Marker>,
tables: DataPayload<CanonicalDecompositionTablesV1Marker>,
jamo: DataPayload<CollationJamoV1Marker>,
special_primaries: impl FnOnce() -> Result<
DataPayload<CollationSpecialPrimariesV1Marker>,
DataError,
>,
prefs: CollatorPreferences,
options: CollatorOptions,
) -> Result<Self, DataError>
where
D: DataProvider<CollationRootV1Marker>
+ DataProvider<CollationTailoringV1Marker>
+ DataProvider<CollationDiacriticsV1Marker>
+ DataProvider<CollationMetadataV1Marker>
+ DataProvider<CollationReorderingV1Marker>
+ ?Sized,
{
let locale_dependent =
LocaleSpecificDataHolder::try_new_unstable_internal(provider, prefs, options)?;
// TODO: redesign Korean search collation handling
if jamo.get().ce32s.len() != JAMO_COUNT {
return Err(DataError::custom("invalid").with_marker(CollationJamoV1Marker::INFO));
}
let special_primaries = if locale_dependent.merged_options.alternate_handling()
== AlternateHandling::Shifted
|| locale_dependent.merged_options.numeric()
{
let special_primaries = special_primaries()?;
// `variant_count` isn't stable yet:
// https://github.com/rust-lang/rust/issues/73662
if special_primaries.get().last_primaries.len() <= (MaxVariable::Currency as usize) {
return Err(DataError::custom("invalid")
.with_marker(CollationSpecialPrimariesV1Marker::INFO));
}
Some(special_primaries)
} else {
None
};
Ok(Collator {
special_primaries,
root,
tailoring: locale_dependent.tailoring,
jamo,
diacritics: locale_dependent.diacritics,
options: locale_dependent.merged_options,
reordering: locale_dependent.reordering,
decompositions,
tables,
lithuanian_dot_above: locale_dependent.lithuanian_dot_above,
})
}
}
/// Compares strings according to culturally-relevant ordering,
/// borrowed version.
#[derive(Debug)]
pub struct CollatorBorrowed<'a> {
special_primaries: Option<&'a CollationSpecialPrimariesV1<'a>>,
root: &'a CollationDataV1<'a>,
tailoring: Option<&'a CollationDataV1<'a>>,
jamo: &'a CollationJamoV1<'a>,
diacritics: &'a CollationDiacriticsV1<'a>,
options: CollatorOptionsBitField,
reordering: Option<&'a CollationReorderingV1<'a>>,
decompositions: &'a DecompositionDataV2<'a>,
tables: &'a DecompositionTablesV1<'a>,
lithuanian_dot_above: bool,
}
impl CollatorBorrowed<'static> {
/// Creates a collator for the given locale and options from compiled data.
#[cfg(feature = "compiled_data")]
pub fn try_new(
prefs: CollatorPreferences,
options: CollatorOptions,
) -> Result<Self, DataError> {
// These are assigned to locals in order to keep the code after these assignments
// copypaste-compatible with `Collator::try_new_unstable_internal`.
let provider = &crate::provider::Baked;
let decompositions =
icu_normalizer::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V2_MARKER;
let tables =
icu_normalizer::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER;
let root = crate::provider::Baked::SINGLETON_COLLATION_ROOT_V1_MARKER;
let jamo = crate::provider::Baked::SINGLETON_COLLATION_JAMO_V1_MARKER;
let locale_dependent =
LocaleSpecificDataHolder::try_new_unstable_internal(provider, prefs, options)?;
// TODO: redesign Korean search collation handling
if jamo.ce32s.len() != JAMO_COUNT {
return Err(DataError::custom("invalid").with_marker(CollationJamoV1Marker::INFO));
}
let special_primaries = if locale_dependent.merged_options.alternate_handling()
== AlternateHandling::Shifted
|| locale_dependent.merged_options.numeric()
{
let special_primaries =
crate::provider::Baked::SINGLETON_COLLATION_SPECIAL_PRIMARIES_V1_MARKER;
// `variant_count` isn't stable yet:
// https://github.com/rust-lang/rust/issues/73662
if special_primaries.last_primaries.len() <= (MaxVariable::Currency as usize) {
return Err(DataError::custom("invalid")
.with_marker(CollationSpecialPrimariesV1Marker::INFO));
}
Some(special_primaries)
} else {
None
};
// Attribute belongs closer to `unwrap`, but
// https://github.com/rust-lang/rust/issues/15701
#[allow(clippy::unwrap_used)]
Ok(CollatorBorrowed {
special_primaries,
root,
// Unwrap is OK, because we know we have the baked provider.
tailoring: locale_dependent.tailoring.map(|s| s.get_static().unwrap()),
jamo,
// Unwrap is OK, because we know we have the baked provider.
diacritics: locale_dependent.diacritics.get_static().unwrap(),
options: locale_dependent.merged_options,
// Unwrap is OK, because we know we have the baked provider.
reordering: locale_dependent.reordering.map(|s| s.get_static().unwrap()),
decompositions,
tables,
lithuanian_dot_above: locale_dependent.lithuanian_dot_above,
})
}
/// Cheaply converts a [`CollatorBorrowed<'static>`] into a [`Collator`].
///
/// Note: Due to branching and indirection, using [`Collator`] might inhibit some
/// compile-time optimizations that are possible with [`CollatorBorrowed`].
pub const fn static_to_owned(self) -> Collator {
Collator {
special_primaries: if let Some(s) = self.special_primaries {
// `map` not available in const context
Some(DataPayload::from_static_ref(s))
} else {
None
},
root: DataPayload::from_static_ref(self.root),
tailoring: if let Some(s) = self.tailoring {
// `map` not available in const context
Some(DataPayload::from_static_ref(s))
} else {
None
},
jamo: DataPayload::from_static_ref(self.jamo),
diacritics: DataPayload::from_static_ref(self.diacritics),
options: self.options,
reordering: if let Some(s) = self.reordering {
// `map` not available in const context
Some(DataPayload::from_static_ref(s))
} else {
None
},
decompositions: DataPayload::from_static_ref(self.decompositions),
tables: DataPayload::from_static_ref(self.tables),
lithuanian_dot_above: self.lithuanian_dot_above,
}
}
}
impl CollatorBorrowed<'_> {
/// The resolved options showing how the default options, the requested options,
/// and the options from locale data were combined.
pub fn resolved_options(&self) -> ResolvedCollatorOptions {
self.options.into()
}
/// Compare potentially ill-formed UTF-16 slices. Unpaired surrogates
/// are compared as if each one was a REPLACEMENT CHARACTER.
pub fn compare_utf16(&self, left: &[u16], right: &[u16]) -> Ordering {
// TODO(#2010): Identical prefix skipping not implemented.
let ret = self.compare_impl(left.chars(), right.chars());
if self.options.strength() == Strength::Identical && ret == Ordering::Equal {
return Decomposition::new(left.chars(), self.decompositions, self.tables).cmp(
Decomposition::new(right.chars(), self.decompositions, self.tables),
);
}
ret
}
/// Compare guaranteed well-formed UTF-8 slices.
pub fn compare(&self, left: &str, right: &str) -> Ordering {
// TODO(#2010): Identical prefix skipping not implemented.
let ret = self.compare_impl(left.chars(), right.chars());
if self.options.strength() == Strength::Identical && ret == Ordering::Equal {
return Decomposition::new(left.chars(), self.decompositions, self.tables).cmp(
Decomposition::new(right.chars(), self.decompositions, self.tables),
);
}
ret
}
/// Compare potentially well-formed UTF-8 slices. Ill-formed input is compared
/// as if errors had been replaced with REPLACEMENT CHARACTERs according
/// to the WHATWG Encoding Standard.
pub fn compare_utf8(&self, left: &[u8], right: &[u8]) -> Ordering {
// TODO(#2010): Identical prefix skipping not implemented.
let ret = self.compare_impl(left.chars(), right.chars());
if self.options.strength() == Strength::Identical && ret == Ordering::Equal {
return Decomposition::new(left.chars(), self.decompositions, self.tables).cmp(
Decomposition::new(right.chars(), self.decompositions, self.tables),
);
}
ret
}
fn compare_impl<I: Iterator<Item = char>>(&self, left_chars: I, right_chars: I) -> Ordering {
let tailoring: &CollationDataV1 = if let Some(tailoring) = &self.tailoring {
tailoring
} else {
// If the root collation is valid for the locale,
// use the root as the tailoring so that reads from the
// tailoring always succeed.
//
// TODO(#2011): Do we instead want to have an untailored
// copypaste of the iterator that omits the tailoring
// branches for performance at the expense of code size
// and having to maintain both a tailoring-capable and
// a tailoring-incapable version of the iterator?
// Or, in order not to flip the branch prediction around,
// should we have a no-op tailoring that contains a
// specially-crafted CodePointTrie that always returns
// a FALLBACK_CE32 after a single branch?
self.root
};
// Sadly, it looks like variable CEs and backward second level
// require us to store the full 64-bit CEs instead of storing only
// the NonPrimary part.
//
// TODO(#2008): Consider having two monomorphizations of this method:
// one that can deal with variables shifted to quaternary and
// backward second level and another that doesn't support that
// and only stores `NonPrimary` in `left_ces` and `right_ces`
// with double the number of stack allocated elements.
// TODO(#2007): figure out a proper stack buffer length for these
let mut left_ces: SmallVec<[CollationElement; 8]> = SmallVec::new();
let mut right_ces: SmallVec<[CollationElement; 8]> = SmallVec::new();
// The algorithm comes from CollationCompare::compareUpToQuaternary in ICU4C.
let mut any_variable = false;
// Attribute belongs closer to `unwrap`, but
// https://github.com/rust-lang/rust/issues/15701
#[allow(clippy::unwrap_used)]
let variable_top = if self.options.alternate_handling() == AlternateHandling::NonIgnorable {
0
} else {
// +1 so that we can use "<" and primary ignorables test out early.
self.special_primaries
.as_ref()
// `unwrap()` is OK, because we've ensured in the constructor that value
// is `Some` if we have alternate handling.
.unwrap()
.last_primary_for_group(self.options.max_variable())
+ 1
};
// Attribute belongs on inner expression, but
// https://github.com/rust-lang/rust/issues/15701
#[allow(clippy::unwrap_used)]
let numeric_primary = if self.options.numeric() {
Some(
self.special_primaries
.as_ref()
// `unwrap` is OK, because we've ensured `Some` in the constructor
.unwrap()
.numeric_primary,
)
} else {
None
};
// Attribute belongs on inner expression, but
// https://github.com/rust-lang/rust/issues/15701
#[allow(clippy::unwrap_used)]
let mut left = CollationElements::new(
left_chars,
self.root,
tailoring,
<&[<u32 as AsULE>::ULE; JAMO_COUNT]>::try_from(self.jamo.ce32s.as_ule_slice()).unwrap(), // `unwrap` OK, because length already validated
&self.diacritics.secondaries,
self.decompositions,
self.tables,
numeric_primary,
self.lithuanian_dot_above,
);
// Attribute belongs on inner expression, but
// https://github.com/rust-lang/rust/issues/15701
#[allow(clippy::unwrap_used)]
let mut right = CollationElements::new(
right_chars,
self.root,
tailoring,
<&[<u32 as AsULE>::ULE; JAMO_COUNT]>::try_from(self.jamo.ce32s.as_ule_slice()).unwrap(), // `unwrap` OK, because length already validated
&self.diacritics.secondaries,
self.decompositions,
self.tables,
numeric_primary,
self.lithuanian_dot_above,
);
loop {
let mut left_primary;
'left_primary_loop: loop {
let ce = left.next();
left_primary = ce.primary();
// TODO(#2008): Consider compiling out the variable handling when we know we aren't
// shifting variable CEs.
if !(left_primary < variable_top && left_primary > MERGE_SEPARATOR_PRIMARY) {
left_ces.push(ce);
} else {
// Variable CE, shift it to quaternary level.
// Ignore all following primary ignorables, and shift further variable CEs.
any_variable = true;
// Relative to ICU4C, the next line is hoisted out of the following loop
// in order to keep the variables called `ce` immutable to make it easier
// to reason about each assignment into `ce` resulting in exactly a single
// push into `left_ces`.
left_ces.push(ce.clone_with_non_primary_zeroed());
loop {
// This loop is simpler than in ICU4C; unlike in C++, we get to break by label.
let ce = left.next();
left_primary = ce.primary();
if left_primary != 0
&& !(left_primary < variable_top
&& left_primary > MERGE_SEPARATOR_PRIMARY)
{
// Neither a primary ignorable nor a variable CE.
left_ces.push(ce);
break 'left_primary_loop;
}
// If `left_primary == 0`, the following line ignores a primary-ignorable.
// Otherwise, it shifts a variable CE.
left_ces.push(ce.clone_with_non_primary_zeroed());
}
}
if left_primary != 0 {
break;
}
}
let mut right_primary;
'right_primary_loop: loop {
let ce = right.next();
right_primary = ce.primary();
// TODO(#2008): Consider compiling out the variable handling when we know we aren't
// shifting variable CEs.
if !(right_primary < variable_top && right_primary > MERGE_SEPARATOR_PRIMARY) {
right_ces.push(ce);
} else {
// Variable CE, shift it to quaternary level.
// Ignore all following primary ignorables, and shift further variable CEs.
any_variable = true;
// Relative to ICU4C, the next line is hoisted out of the following loop
// in order to keep the variables called `ce` immutable to make it easier
// to reason about each assignment into `ce` resulting in exactly a single
// push into `right_ces`.
right_ces.push(ce.clone_with_non_primary_zeroed());
loop {
// This loop is simpler than in ICU4C; unlike in C++, we get to break by label.
let ce = right.next();
right_primary = ce.primary();
if right_primary != 0
&& !(right_primary < variable_top
&& right_primary > MERGE_SEPARATOR_PRIMARY)
{
// Neither a primary ignorable nor a variable CE.
right_ces.push(ce);
break 'right_primary_loop;
}
// If `right_primary == 0`, the following line ignores a primary-ignorable.
// Otherwise, it shifts a variable CE.
right_ces.push(ce.clone_with_non_primary_zeroed());
}
}
if right_primary != 0 {
break;
}
}
if left_primary != right_primary {
if let Some(reordering) = &self.reordering {
left_primary = reordering.reorder(left_primary);
right_primary = reordering.reorder(right_primary);
}
if left_primary < right_primary {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_primary == NO_CE_PRIMARY {
break;
}
}
// Sadly, we end up pushing the sentinel value, which means these
// `SmallVec`s allocate more often than if we didn't actually
// store the sentinel.
debug_assert_eq!(left_ces.last(), Some(&NO_CE));
debug_assert_eq!(right_ces.last(), Some(&NO_CE));
// Note: `unwrap_or_default` in the iterations below should never
// actually end up using the "_or_default" part, because the sentinel
// is in the `SmallVec`s. These could be changed to `unwrap()` if we
// preferred panic in case of a bug.
// TODO(#2009): Should we save one slot by not putting the sentinel in
// the `SmallVec`s? So far, the answer seems "no", as it would complicate
// the primary comparison above.
// Compare the buffered secondary & tertiary weights.
// We might skip the secondary level but continue with the case level
// which is turned on separately.
if self.options.strength() >= Strength::Secondary {
if !self.options.backward_second_level() {
let mut left_iter = left_ces.iter();
let mut right_iter = right_ces.iter();
let mut left_secondary;
let mut right_secondary;
loop {
loop {
left_secondary = left_iter.next().unwrap_or_default().secondary();
if left_secondary != 0 {
break;
}
}
loop {
right_secondary = right_iter.next().unwrap_or_default().secondary();
if right_secondary != 0 {
break;
}
}
if left_secondary != right_secondary {
if left_secondary < right_secondary {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_secondary == NO_CE_SECONDARY {
break;
}
}
} else {
let mut left_remaining = &left_ces[..];
let mut right_remaining = &right_ces[..];
loop {
if left_remaining.is_empty() {
debug_assert!(right_remaining.is_empty());
break;
}
let (left_prefix, right_prefix) = {
let mut left_iter = left_remaining.iter();
loop {
let left_primary = left_iter.next().unwrap_or_default().primary();
if left_primary != 0 && left_primary <= MERGE_SEPARATOR_PRIMARY {
break;
}
debug_assert_ne!(left_primary, NO_CE_PRIMARY);
}
let left_new_remaining = left_iter.as_slice();
// Index in range by construction
#[allow(clippy::indexing_slicing)]
let left_prefix =
&left_remaining[..left_remaining.len() - 1 - left_new_remaining.len()];
left_remaining = left_new_remaining;
let mut right_iter = right_remaining.iter();
loop {
let right_primary = right_iter.next().unwrap_or_default().primary();
if right_primary != 0 && right_primary <= MERGE_SEPARATOR_PRIMARY {
break;
}
debug_assert_ne!(right_primary, NO_CE_PRIMARY);
}
let right_new_remaining = right_iter.as_slice();
// Index in range by construction
#[allow(clippy::indexing_slicing)]
let right_prefix = &right_remaining
[..right_remaining.len() - 1 - right_new_remaining.len()];
right_remaining = right_new_remaining;
(left_prefix, right_prefix)
};
let mut left_iter = left_prefix.iter();
let mut right_iter = right_prefix.iter();
let mut left_secondary;
let mut right_secondary;
loop {
loop {
left_secondary = left_iter.next_back().unwrap_or_default().secondary();
if left_secondary != 0 {
break;
}
}
loop {
right_secondary =
right_iter.next_back().unwrap_or_default().secondary();
if right_secondary != 0 {
break;
}
}
if left_secondary != right_secondary {
if left_secondary < right_secondary {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_secondary == NO_CE_SECONDARY {
break;
}
}
}
}
}
if self.options.case_level() {
if self.options.strength() == Strength::Primary {
// Primary+caseLevel: Ignore case level weights of primary ignorables.
// Otherwise we would get a-umlaut > a
// which is not desirable for accent-insensitive sorting.
// Check for (lower 32 bits) == 0 as well because variable CEs are stored
// with only primary weights.
let mut left_non_primary;
let mut right_non_primary;
let mut left_case;
let mut right_case;
let mut left_iter = left_ces.iter();
let mut right_iter = right_ces.iter();
loop {
loop {
let ce = left_iter.next().unwrap_or_default();
left_non_primary = ce.non_primary();
if !ce.either_half_zero() {
break;
}
}
left_case = left_non_primary.case();
loop {
let ce = right_iter.next().unwrap_or_default();
right_non_primary = ce.non_primary();
if !ce.either_half_zero() {
break;
}
}
right_case = right_non_primary.case();
// No need to handle NO_CE and MERGE_SEPARATOR specially:
// There is one case weight for each previous-level weight,
// so level length differences were handled there.
if left_case != right_case {
if !self.options.upper_first() {
if left_case < right_case {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_case < right_case {
return Ordering::Greater;
}
return Ordering::Less;
}
if left_non_primary.secondary() == NO_CE_SECONDARY {
break;
}
}
} else {
// Secondary+caseLevel: By analogy with the above,
// ignore case level weights of secondary ignorables.
//
// Note: A tertiary CE has uppercase case bits (0.0.ut)
// to keep tertiary+caseFirst well-formed.
//
// Tertiary+caseLevel: Also ignore case level weights of secondary ignorables.
// Otherwise a tertiary CE's uppercase would be no greater than
// a primary/secondary CE's uppercase.
// (See UCA well-formedness condition 2.)
// We could construct a special case weight higher than uppercase,
// but it's simpler to always ignore case weights of secondary ignorables,
// turning 0.0.ut into 0.0.0.t.
// (See LDML Collation, Case Parameters.)
let mut left_non_primary;
let mut right_non_primary;
let mut left_case;
let mut right_case;
let mut left_iter = left_ces.iter();
let mut right_iter = right_ces.iter();
loop {
loop {
left_non_primary = left_iter.next().unwrap_or_default().non_primary();
if left_non_primary.secondary() != 0 {
break;
}
}
left_case = left_non_primary.case();
loop {
right_non_primary = right_iter.next().unwrap_or_default().non_primary();
if right_non_primary.secondary() != 0 {
break;
}
}
right_case = right_non_primary.case();
// No need to handle NO_CE and MERGE_SEPARATOR specially:
// There is one case weight for each previous-level weight,
// so level length differences were handled there.
if left_case != right_case {
if !self.options.upper_first() {
if left_case < right_case {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_case < right_case {
return Ordering::Greater;
}
return Ordering::Less;
}
if left_non_primary.secondary() == NO_CE_SECONDARY {
break;
}
}
}
}
if let Some(tertiary_mask) = self.options.tertiary_mask() {
let mut any_quaternaries = AnyQuaternaryAccumulator::new();
let mut left_iter = left_ces.iter();
let mut right_iter = right_ces.iter();
loop {
let mut left_non_primary;
let mut left_tertiary;
loop {
left_non_primary = left_iter.next().unwrap_or_default().non_primary();
any_quaternaries.accumulate(left_non_primary);
debug_assert!(
left_non_primary.tertiary() != 0 || left_non_primary.case_quaternary() == 0
);
left_tertiary = left_non_primary.tertiary_case_quarternary(tertiary_mask);
if left_tertiary != 0 {
break;
}
}
let mut right_non_primary;
let mut right_tertiary;
loop {
right_non_primary = right_iter.next().unwrap_or_default().non_primary();
any_quaternaries.accumulate(right_non_primary);
debug_assert!(
right_non_primary.tertiary() != 0
|| right_non_primary.case_quaternary() == 0
);
right_tertiary = right_non_primary.tertiary_case_quarternary(tertiary_mask);
if right_tertiary != 0 {
break;
}
}
if left_tertiary != right_tertiary {
if self.options.upper_first() {
// Pass through NO_CE and keep real tertiary weights larger than that.
// Do not change the artificial uppercase weight of a tertiary CE (0.0.ut),
// to keep tertiary CEs well-formed.
// Their case+tertiary weights must be greater than those of
// primary and secondary CEs.
// Magic numbers from ICU4C.
if left_tertiary > NO_CE_TERTIARY {
if left_non_primary.secondary() != 0 {
left_tertiary ^= 0xC000;
} else {
left_tertiary += 0x4000;
}
}
if right_tertiary > NO_CE_TERTIARY {
if right_non_primary.secondary() != 0 {
right_tertiary ^= 0xC000;
} else {
right_tertiary += 0x4000;
}
}
}
if left_tertiary < right_tertiary {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_tertiary == NO_CE_TERTIARY {
break;
}
}
if !any_variable && !any_quaternaries.has_quaternary() {
return Ordering::Equal;
}
} else {
return Ordering::Equal;
}
if self.options.strength() <= Strength::Tertiary {
return Ordering::Equal;
}
let mut left_iter = left_ces.iter();
let mut right_iter = right_ces.iter();
loop {
let mut left_quaternary;
loop {
let ce = left_iter.next().unwrap_or_default();
if ce.tertiary_ignorable() {
left_quaternary = ce.primary();
} else {
left_quaternary = ce.quaternary();
}
if left_quaternary != 0 {
break;
}
}
let mut right_quaternary;
loop {
let ce = right_iter.next().unwrap_or_default();
if ce.tertiary_ignorable() {
right_quaternary = ce.primary();
} else {
right_quaternary = ce.quaternary();
}
if right_quaternary != 0 {
break;
}
}
if left_quaternary != right_quaternary {
if let Some(reordering) = &self.reordering {
left_quaternary = reordering.reorder(left_quaternary);
right_quaternary = reordering.reorder(right_quaternary);
}
if left_quaternary < right_quaternary {
return Ordering::Less;
}
return Ordering::Greater;
}
if left_quaternary == NO_CE_PRIMARY {
break;
}
}
Ordering::Equal
}
}