Fix remaining preferences & options in constructors (#5852)

Partially fixes #5839 --------- Co-authored-by: Shane F. Carr <shane@unicode.org>
unicode-org · Nov 22, 2024 · d38dd38 · d38dd38
1 parent 3b3fddf
commit d38dd38
Show file tree

Hide file tree

Showing 17 changed files with 201 additions and 121 deletions.
diff --git a/components/calendar/src/week_of.rs b/components/calendar/src/week_of.rs
@@ -7,11 +7,19 @@ use crate::{
     provider::*,
     types::{DayOfMonth, DayOfYearInfo, IsoWeekday, WeekOfMonth},
 };
+use icu_locale_core::preferences::define_preferences;
 use icu_provider::prelude::*;
 
 /// Minimum number of days in a month unit required for using this module
 pub const MIN_UNIT_DAYS: u16 = 14;
 
+define_preferences!(
+    /// The preferences for the week calculator.
+    [Copy]
+    WeekPreferences,
+    {}
+);
+
 /// Calculator for week-of-month and week-of-year based on locale-specific configurations.
 ///
 /// Note that things get subtly tricky for weeks that straddle the boundary between two years: different locales
@@ -32,18 +40,19 @@ pub struct WeekCalculator {
 
 impl WeekCalculator {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale) -> error: DataError,
+        (prefs: WeekPreferences) -> error: DataError,
         /// Creates a new [`WeekCalculator`] from compiled data.
     );
 
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
-    pub fn try_new_unstable<P>(provider: &P, locale: &DataLocale) -> Result<Self, DataError>
+    pub fn try_new_unstable<P>(provider: &P, prefs: WeekPreferences) -> Result<Self, DataError>
     where
         P: DataProvider<crate::provider::WeekDataV2Marker> + ?Sized,
     {
+        let locale = DataLocale::from_preferences_locale::<WeekDataV2Marker>(prefs.locale_prefs);
         provider
             .load(DataRequest {
-                id: DataIdentifierBorrowed::for_locale(locale),
+                id: DataIdentifierBorrowed::for_locale(&locale),
                 ..Default::default()
             })
             .map(|response| WeekCalculator {
@@ -68,7 +77,7 @@ impl WeekCalculator {
     /// use icu::calendar::week::WeekCalculator;
     ///
     /// let week_calculator =
-    ///     WeekCalculator::try_new(&icu::locale::locale!("und-GB").into())
+    ///     WeekCalculator::try_new(icu::locale::locale!("und-GB").into())
     ///         .expect("locale should be present");
     ///
     /// // Wednesday the 10th is in week 2:
@@ -97,7 +106,7 @@ impl WeekCalculator {
     /// use icu::calendar::Date;
     ///
     /// let week_calculator =
-    ///     WeekCalculator::try_new(&icu::locale::locale!("und-GB").into())
+    ///     WeekCalculator::try_new(icu::locale::locale!("und-GB").into())
     ///         .expect("locale should be present");
     ///
     /// let iso_date = Date::try_new_iso(2022, 8, 26).unwrap();
@@ -668,31 +677,31 @@ fn test_weekend() {
     use icu_locale_core::locale;
 
     assert_eq!(
-        WeekCalculator::try_new(&locale!("und").into())
+        WeekCalculator::try_new(locale!("und").into())
             .unwrap()
             .weekend()
             .collect::<Vec<_>>(),
         vec![IsoWeekday::Saturday, IsoWeekday::Sunday],
     );
 
     assert_eq!(
-        WeekCalculator::try_new(&locale!("und-FR").into())
+        WeekCalculator::try_new(locale!("und-FR").into())
             .unwrap()
             .weekend()
             .collect::<Vec<_>>(),
         vec![IsoWeekday::Saturday, IsoWeekday::Sunday],
     );
 
     assert_eq!(
-        WeekCalculator::try_new(&locale!("und-IQ").into())
+        WeekCalculator::try_new(locale!("und-IQ").into())
             .unwrap()
             .weekend()
             .collect::<Vec<_>>(),
         vec![IsoWeekday::Saturday, IsoWeekday::Friday],
     );
 
     assert_eq!(
-        WeekCalculator::try_new(&locale!("und-IR").into())
+        WeekCalculator::try_new(locale!("und-IR").into())
             .unwrap()
             .weekend()
             .collect::<Vec<_>>(),

diff --git a/components/experimental/src/dimension/units/formatter.rs b/components/experimental/src/dimension/units/formatter.rs
@@ -62,7 +62,7 @@ pub struct UnitsFormatter {
 
 impl UnitsFormatter {
     icu_provider::gen_any_buffer_data_constructors!(
-        (wprefs: UnitsFormatterPreferences, unit: &str, options: super::options::UnitsFormatterOptions) -> error: DataError,
+        (prefs: UnitsFormatterPreferences, unit: &str, options: super::options::UnitsFormatterOptions) -> error: DataError,
         functions: [
             try_new: skip,
             try_new_with_any_provider,

diff --git a/components/experimental/src/displaynames/displaynames.rs b/components/experimental/src/displaynames/displaynames.rs
@@ -8,13 +8,21 @@ use crate::displaynames::options::*;
 use crate::displaynames::provider::*;
 use alloc::borrow::Cow;
 use alloc::string::String;
+use icu_locale_core::preferences::define_preferences;
 use icu_locale_core::{
     subtags::Language, subtags::Region, subtags::Script, subtags::Variant, LanguageIdentifier,
     Locale,
 };
 use icu_provider::prelude::*;
 use potential_utf::PotentialUtf8;
 
+define_preferences!(
+    /// The preferences for list formatting.
+    [Copy]
+    DisplayNamesPreferences,
+    {}
+);
+
 /// Lookup of the locale-specific display names by region code.
 ///
 /// # Example
@@ -27,7 +35,7 @@ use potential_utf::PotentialUtf8;
 ///
 /// let locale = locale!("en-001").into();
 /// let options: DisplayNamesOptions = Default::default();
-/// let display_name = RegionDisplayNames::try_new(&locale, options)
+/// let display_name = RegionDisplayNames::try_new(locale, options)
 ///     .expect("Data should load successfully");
 ///
 /// assert_eq!(display_name.of(region!("AE")), Some("United Arab Emirates"));
@@ -40,7 +48,7 @@ pub struct RegionDisplayNames {
 
 impl RegionDisplayNames {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale, options: DisplayNamesOptions) -> error: DataError,
+        (prefs: DisplayNamesPreferences, options: DisplayNamesOptions) -> error: DataError,
         /// Creates a new [`RegionDisplayNames`] from locale data and an options bag using compiled data.
         functions: [
             try_new,
@@ -54,12 +62,14 @@ impl RegionDisplayNames {
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D: DataProvider<RegionDisplayNamesV1Marker> + ?Sized>(
         provider: &D,
-        locale: &DataLocale,
+        prefs: DisplayNamesPreferences,
         options: DisplayNamesOptions,
     ) -> Result<Self, DataError> {
+        let locale =
+            DataLocale::from_preferences_locale::<RegionDisplayNamesV1Marker>(prefs.locale_prefs);
         let region_data = provider
             .load(DataRequest {
-                id: DataIdentifierBorrowed::for_locale(locale),
+                id: DataIdentifierBorrowed::for_locale(&locale),
                 ..Default::default()
             })?
             .payload;
@@ -94,7 +104,7 @@ impl RegionDisplayNames {
 ///
 /// let locale = locale!("en-001").into();
 /// let options: DisplayNamesOptions = Default::default();
-/// let display_name = ScriptDisplayNames::try_new(&locale, options)
+/// let display_name = ScriptDisplayNames::try_new(locale, options)
 ///     .expect("Data should load successfully");
 ///
 /// assert_eq!(display_name.of(script!("Maya")), Some("Mayan hieroglyphs"));
@@ -107,7 +117,7 @@ pub struct ScriptDisplayNames {
 
 impl ScriptDisplayNames {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale, options: DisplayNamesOptions) -> error: DataError,
+        (prefs: DisplayNamesPreferences, options: DisplayNamesOptions) -> error: DataError,
         /// Creates a new [`ScriptDisplayNames`] from locale data and an options bag using compiled data.
         functions: [
             try_new,
@@ -121,12 +131,14 @@ impl ScriptDisplayNames {
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D: DataProvider<ScriptDisplayNamesV1Marker> + ?Sized>(
         provider: &D,
-        locale: &DataLocale,
+        prefs: DisplayNamesPreferences,
         options: DisplayNamesOptions,
     ) -> Result<Self, DataError> {
+        let locale =
+            DataLocale::from_preferences_locale::<ScriptDisplayNamesV1Marker>(prefs.locale_prefs);
         let script_data = provider
             .load(DataRequest {
-                id: DataIdentifierBorrowed::for_locale(locale),
+                id: DataIdentifierBorrowed::for_locale(&locale),
                 ..Default::default()
             })?
             .payload;
@@ -161,7 +173,7 @@ impl ScriptDisplayNames {
 ///
 /// let locale = locale!("en-001").into();
 /// let options: DisplayNamesOptions = Default::default();
-/// let display_name = VariantDisplayNames::try_new(&locale, options)
+/// let display_name = VariantDisplayNames::try_new(locale, options)
 ///     .expect("Data should load successfully");
 ///
 /// assert_eq!(display_name.of(variant!("POSIX")), Some("Computer"));
@@ -175,7 +187,7 @@ pub struct VariantDisplayNames {
 
 impl VariantDisplayNames {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale, options: DisplayNamesOptions) -> error: DataError,
+        (prefs: DisplayNamesPreferences, options: DisplayNamesOptions) -> error: DataError,
         /// Creates a new [`VariantDisplayNames`] from locale data and an options bag using compiled data.
         functions: [
             try_new,
@@ -189,12 +201,14 @@ impl VariantDisplayNames {
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D: DataProvider<VariantDisplayNamesV1Marker> + ?Sized>(
         provider: &D,
-        locale: &DataLocale,
+        prefs: DisplayNamesPreferences,
         options: DisplayNamesOptions,
     ) -> Result<Self, DataError> {
+        let locale =
+            DataLocale::from_preferences_locale::<VariantDisplayNamesV1Marker>(prefs.locale_prefs);
         let variant_data = provider
             .load(DataRequest {
-                id: DataIdentifierBorrowed::for_locale(locale),
+                id: DataIdentifierBorrowed::for_locale(&locale),
                 ..Default::default()
             })?
             .payload;
@@ -225,7 +239,7 @@ impl VariantDisplayNames {
 ///
 /// let locale = locale!("en-001").into();
 /// let options: DisplayNamesOptions = Default::default();
-/// let display_name = LanguageDisplayNames::try_new(&locale, options)
+/// let display_name = LanguageDisplayNames::try_new(locale, options)
 ///     .expect("Data should load successfully");
 ///
 /// assert_eq!(display_name.of(language!("de")), Some("German"));
@@ -238,7 +252,7 @@ pub struct LanguageDisplayNames {
 
 impl LanguageDisplayNames {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale, options: DisplayNamesOptions) -> error: DataError,
+        (prefs: DisplayNamesPreferences, options: DisplayNamesOptions) -> error: DataError,
         /// Creates a new [`LanguageDisplayNames`] from locale data and an options bag using compiled data.
         functions: [
             try_new,
@@ -252,12 +266,14 @@ impl LanguageDisplayNames {
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D: DataProvider<LanguageDisplayNamesV1Marker> + ?Sized>(
         provider: &D,
-        locale: &DataLocale,
+        prefs: DisplayNamesPreferences,
         options: DisplayNamesOptions,
     ) -> Result<Self, DataError> {
+        let locale =
+            DataLocale::from_preferences_locale::<LanguageDisplayNamesV1Marker>(prefs.locale_prefs);
         let language_data = provider
             .load(DataRequest {
-                id: DataIdentifierBorrowed::for_locale(locale),
+                id: DataIdentifierBorrowed::for_locale(&locale),
                 ..Default::default()
             })?
             .payload;
@@ -296,7 +312,7 @@ impl LanguageDisplayNames {
 ///
 /// let locale = locale!("en-001").into();
 /// let options: DisplayNamesOptions = Default::default();
-/// let display_name = LocaleDisplayNamesFormatter::try_new(&locale, options)
+/// let display_name = LocaleDisplayNamesFormatter::try_new(locale, options)
 ///     .expect("Data should load successfully");
 ///
 /// assert_eq!(display_name.of(&locale!("en-GB")), "British English");
@@ -322,7 +338,7 @@ pub struct LocaleDisplayNamesFormatter {
 
 impl LocaleDisplayNamesFormatter {
     icu_provider::gen_any_buffer_data_constructors!(
-        (locale, options: DisplayNamesOptions) -> error: DataError,
+        (prefs: DisplayNamesPreferences, options: DisplayNamesOptions) -> error: DataError,
         /// Creates a new [`LocaleDisplayNamesFormatter`] from locale data and an options bag using compiled data.
         functions: [
             try_new,
@@ -336,7 +352,7 @@ impl LocaleDisplayNamesFormatter {
     #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D>(
         provider: &D,
-        locale: &DataLocale,
+        prefs: DisplayNamesPreferences,
         options: DisplayNamesOptions,
     ) -> Result<Self, DataError>
     where
@@ -347,8 +363,10 @@ impl LocaleDisplayNamesFormatter {
             + DataProvider<VariantDisplayNamesV1Marker>
             + ?Sized,
     {
+        let locale =
+            DataLocale::from_preferences_locale::<LocaleDisplayNamesV1Marker>(prefs.locale_prefs);
         let req = DataRequest {
-            id: DataIdentifierBorrowed::for_locale(locale),
+            id: DataIdentifierBorrowed::for_locale(&locale),
             ..Default::default()
         };
 
@@ -503,15 +521,15 @@ fn test_language_display() {
     use icu_locale_core::locale;
 
     let dialect = LocaleDisplayNamesFormatter::try_new(
-        &locale!("en").into(),
+        locale!("en").into(),
         DisplayNamesOptions {
             language_display: LanguageDisplay::Dialect,
             ..Default::default()
         },
     )
     .unwrap();
     let standard = LocaleDisplayNamesFormatter::try_new(
-        &locale!("en").into(),
+        locale!("en").into(),
         DisplayNamesOptions {
             language_display: LanguageDisplay::Standard,
             ..Default::default()

diff --git a/components/experimental/src/displaynames/options.rs b/components/experimental/src/displaynames/options.rs
@@ -17,7 +17,7 @@
 /// let locale = locale!("en-001");
 /// let mut options: DisplayNamesOptions = Default::default();
 /// options.style = Some(Style::Short);
-/// let display_name = RegionDisplayNames::try_new(&locale.into(), options)
+/// let display_name = RegionDisplayNames::try_new(locale.into(), options)
 ///     .expect("Data should load successfully");
 ///
 /// // Full name would be "Bosnia & Herzegovina"

diff --git a/components/experimental/tests/displaynames/tests.rs b/components/experimental/tests/displaynames/tests.rs
@@ -82,7 +82,7 @@ fn test_concatenate() {
         let locale = locale!("en-001");
         let options: DisplayNamesOptions = Default::default();
 
-        let display_name = LocaleDisplayNamesFormatter::try_new(&locale.into(), options)
+        let display_name = LocaleDisplayNamesFormatter::try_new(locale.into(), options)
             .expect("Data should load successfully");
 
         let result = display_name.of(cas.input_1);

diff --git a/components/plurals/README.md b/components/plurals/README.md
diff --git a/components/plurals/benches/pluralrules.rs b/components/plurals/benches/pluralrules.rs
@@ -19,7 +19,8 @@ fn pluralrules(c: &mut Criterion) {
     c.bench_function("plurals/pluralrules/overview", |b| {
         b.iter(|| {
             for lang in &plurals_data.langs {
-                let pr = PluralRules::try_new(lang.into(), PluralRuleType::Cardinal).unwrap();
+                let pr =
+                    PluralRules::try_new(lang.into(), PluralRuleType::Cardinal.into()).unwrap();
                 for s in &numbers_data.usize {
                     let _ = pr.category_for(*s);
                 }
@@ -35,13 +36,14 @@ fn pluralrules(c: &mut Criterion) {
         c.bench_function("plurals/pluralrules/construct/fs", |b| {
             b.iter(|| {
                 for lang in &plurals_data.langs {
-                    PluralRules::try_new(lang.into(), PluralRuleType::Ordinal).unwrap();
-                    PluralRules::try_new(lang.into(), PluralRuleType::Cardinal).unwrap();
+                    PluralRules::try_new(lang.into(), PluralRuleType::Ordinal.into()).unwrap();
+                    PluralRules::try_new(lang.into(), PluralRuleType::Cardinal.into()).unwrap();
                 }
             });
         });
 
-        let pr = PluralRules::try_new(locale!("ru").into(), PluralRuleType::Cardinal).unwrap();
+        let pr =
+            PluralRules::try_new(locale!("ru").into(), PluralRuleType::Cardinal.into()).unwrap();
         c.bench_function("plurals/pluralrules/select/fs", |b| {
             b.iter(|| {
                 for s in &numbers_data.usize {