Skip to content

Commit

Permalink
Adjust icu_normalizer::properties to constructor conventions (#5547)
Browse files Browse the repository at this point in the history
  • Loading branch information
@hsivonen
hsivonen authored Sep 18, 2024
1 parent 987c364 commit 47ba490
Show file tree
Hide file tree
Showing 8 changed files with 181 additions and 138 deletions.
211 changes: 107 additions & 104 deletions components/normalizer/src/properties.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,37 @@ pub struct CanonicalCompositionBorrowed<'a> {
}

#[cfg(feature = "compiled_data")]
impl<'a> Default for CanonicalCompositionBorrowed<'a> {
impl Default for CanonicalCompositionBorrowed<'static> {
fn default() -> Self {
Self::new()
}
}

impl CanonicalCompositionBorrowed<'static> {
/// Cheaply converts a [`CanonicalCompositionBorrowed<'static>`] into a [`CanonicalComposition`].
///
/// Note: Due to branching and indirection, using [`CanonicalComposition`] might inhibit some
/// compile-time optimizations that are possible with [`CanonicalCompositionBorrowed`].
pub const fn static_to_owned(self) -> CanonicalComposition {
CanonicalComposition {
canonical_compositions: DataPayload::from_static_ref(self.canonical_compositions),
}
}

/// Constructs a new `CanonicalComposition` using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
Self {
canonical_compositions:
crate::provider::Baked::SINGLETON_CANONICAL_COMPOSITIONS_V1_MARKER,
}
}
}

impl<'a> CanonicalCompositionBorrowed<'a> {
/// Performs canonical composition (including Hangul) on a pair of
/// characters or returns `None` if these characters don't compose.
Expand All @@ -83,19 +108,6 @@ impl<'a> CanonicalCompositionBorrowed<'a> {
second,
)
}

/// Constructs a new `CanonicalComposition` using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
Self {
canonical_compositions:
crate::provider::Baked::SINGLETON_CANONICAL_COMPOSITIONS_V1_MARKER,
}
}
}

/// The raw canonical composition operation.
Expand All @@ -112,7 +124,7 @@ pub struct CanonicalComposition {
#[cfg(feature = "compiled_data")]
impl Default for CanonicalComposition {
fn default() -> Self {
Self::new()
Self::new().static_to_owned()
}
}

Expand All @@ -124,21 +136,15 @@ impl CanonicalComposition {
}
}

/// Constructs a new `CanonicalComposition` using compiled data.
///
/// Unless you know you need this constructor, using
/// `CanonicalCompositionBorrowed::new()` is likely a better idea.
/// Constructs a new `CanonicalCompositionBorrowed` using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
Self {
canonical_compositions: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_CANONICAL_COMPOSITIONS_V1_MARKER,
),
}
#[allow(clippy::new_ret_no_self)]
pub const fn new() -> CanonicalCompositionBorrowed<'static> {
CanonicalCompositionBorrowed::new()
}

icu_provider::gen_any_buffer_data_constructors!(() -> error: DataError,
Expand Down Expand Up @@ -190,12 +196,53 @@ pub struct CanonicalDecompositionBorrowed<'a> {
}

#[cfg(feature = "compiled_data")]
impl<'a> Default for CanonicalDecompositionBorrowed<'a> {
impl Default for CanonicalDecompositionBorrowed<'static> {
fn default() -> Self {
Self::new()
}
}

impl CanonicalDecompositionBorrowed<'static> {
/// Cheaply converts a [`CanonicalDecompositionBorrowed<'static>`] into a [`CanonicalDecomposition`].
///
/// Note: Due to branching and indirection, using [`CanonicalDecomposition`] might inhibit some
/// compile-time optimizations that are possible with [`CanonicalDecompositionBorrowed`].
pub const fn static_to_owned(self) -> CanonicalDecomposition {
CanonicalDecomposition {
decompositions: DataPayload::from_static_ref(self.decompositions),
tables: DataPayload::from_static_ref(self.tables),
non_recursive: DataPayload::from_static_ref(self.non_recursive),
}
}

/// Construct from compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
const _: () = assert!(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars16
.const_len()
+ crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars24
.const_len()
<= 0xFFF,
"future extension"
);

Self {
decompositions:
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
tables: crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER,
non_recursive:
crate::provider::Baked::SINGLETON_NON_RECURSIVE_DECOMPOSITION_SUPPLEMENT_V1_MARKER,
}
}
}

impl<'a> CanonicalDecompositionBorrowed<'a> {
/// Performs non-recursive canonical decomposition (including for Hangul).
///
Expand Down Expand Up @@ -400,33 +447,6 @@ impl<'a> CanonicalDecompositionBorrowed<'a> {
debug_assert!(false);
Decomposed::Default
}

/// Construct from compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
const _: () = assert!(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars16
.const_len()
+ crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars24
.const_len()
<= 0xFFF,
"future extension"
);

Self {
decompositions:
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
tables: crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER,
non_recursive:
crate::provider::Baked::SINGLETON_NON_RECURSIVE_DECOMPOSITION_SUPPLEMENT_V1_MARKER,
}
}
}

/// The raw (non-recursive) canonical decomposition operation.
Expand All @@ -445,7 +465,7 @@ pub struct CanonicalDecomposition {
#[cfg(feature = "compiled_data")]
impl Default for CanonicalDecomposition {
fn default() -> Self {
Self::new()
Self::new().static_to_owned()
}
}

Expand All @@ -461,36 +481,13 @@ impl CanonicalDecomposition {

/// Construct from compiled data.
///
/// Unless you know you need this constructor, using
/// `CanonicalDecompositionBorrowed::new()` is likely a better idea.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
const _: () = assert!(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars16
.const_len()
+ crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER
.scalars24
.const_len()
<= 0xFFF,
"future extension"
);

Self {
decompositions: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
),
tables: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_TABLES_V1_MARKER,
),
non_recursive: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_NON_RECURSIVE_DECOMPOSITION_SUPPLEMENT_V1_MARKER,
),
}
#[allow(clippy::new_ret_no_self)]
pub const fn new() -> CanonicalDecompositionBorrowed<'static> {
CanonicalDecompositionBorrowed::new()
}

icu_provider::gen_any_buffer_data_constructors!(() -> error: DataError,
Expand Down Expand Up @@ -556,12 +553,37 @@ pub struct CanonicalCombiningClassMapBorrowed<'a> {
}

#[cfg(feature = "compiled_data")]
impl<'a> Default for CanonicalCombiningClassMapBorrowed<'a> {
impl Default for CanonicalCombiningClassMapBorrowed<'static> {
fn default() -> Self {
Self::new()
}
}

impl CanonicalCombiningClassMapBorrowed<'static> {
/// Cheaply converts a [`CanonicalCombiningClassMapBorrowed<'static>`] into a [`CanonicalCombiningClassMap`].
///
/// Note: Due to branching and indirection, using [`CanonicalCombiningClassMap`] might inhibit some
/// compile-time optimizations that are possible with [`CanonicalCombiningClassMapBorrowed`].
pub const fn static_to_owned(self) -> CanonicalCombiningClassMap {
CanonicalCombiningClassMap {
decompositions: DataPayload::from_static_ref(self.decompositions),
}
}

/// Construct from compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
CanonicalCombiningClassMapBorrowed {
decompositions:
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
}
}
}

impl<'a> CanonicalCombiningClassMapBorrowed<'a> {
/// Look up the canonical combining class for a scalar value
#[inline(always)]
Expand All @@ -585,19 +607,6 @@ impl<'a> CanonicalCombiningClassMapBorrowed<'a> {
CanonicalCombiningClass::NotReordered
}
}

/// Construct from compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
CanonicalCombiningClassMapBorrowed {
decompositions:
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
}
}
}

/// Lookup of the Canonical_Combining_Class Unicode property.
Expand All @@ -610,7 +619,7 @@ pub struct CanonicalCombiningClassMap {
#[cfg(feature = "compiled_data")]
impl Default for CanonicalCombiningClassMap {
fn default() -> Self {
Self::new()
Self::new().static_to_owned()
}
}

Expand All @@ -624,19 +633,13 @@ impl CanonicalCombiningClassMap {

/// Construct from compiled data.
///
/// Unless you know you need this constructor, using
/// `CanonicalCombiningClassMapBorrowed::new()` is likely a better idea.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
CanonicalCombiningClassMap {
decompositions: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_CANONICAL_DECOMPOSITION_DATA_V1_MARKER,
),
}
#[allow(clippy::new_ret_no_self)]
pub const fn new() -> CanonicalCombiningClassMapBorrowed<'static> {
CanonicalCombiningClassMapBorrowed::new()
}

icu_provider::gen_any_buffer_data_constructors!(() -> error: DataError,
Expand Down
7 changes: 4 additions & 3 deletions components/normalizer/tests/tests.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1535,7 +1535,7 @@ fn test_canonical_composition() {

#[test]
fn test_canonical_composition_owned() {
let owned = CanonicalComposition::new();
let owned = CanonicalComposition::try_new_unstable(&icu_normalizer::provider::Baked).unwrap();
let comp = owned.as_borrowed();

assert_eq!(comp.compose('a', 'b'), None); // Just two starters
Expand Down Expand Up @@ -1598,7 +1598,7 @@ fn test_canonical_decomposition() {

#[test]
fn test_canonical_decomposition_owned() {
let owned = CanonicalDecomposition::new();
let owned = CanonicalDecomposition::try_new_unstable(&icu_normalizer::provider::Baked).unwrap();
let decomp = owned.as_borrowed();

assert_eq!(
Expand Down Expand Up @@ -1653,7 +1653,8 @@ fn test_ccc() {

#[test]
fn test_ccc_owned() {
let owned = CanonicalCombiningClassMap::new();
let owned =
CanonicalCombiningClassMap::try_new_unstable(&icu_normalizer::provider::Baked).unwrap();
let map = owned.as_borrowed();
for u in 0..=0x10FFFF {
assert_eq!(
Expand Down
2 changes: 1 addition & 1 deletion ffi/capi/bindings/dart/CanonicalComposition.g.dart
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ffi/capi/bindings/dart/DecomposingNormalizer.g.dart
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 47ba490

Please sign in to comment.