plurals wip

Author: robertbastian

components/plurals/Cargo.toml

@@ -17,6 +17,7 @@ categories = ["internationalization"]
 # Keep this in sync with other crates unless there are exceptions
 include = [
     "src/**/*",
+    "data/macros.rs",
     "examples/**/*",
     "benches/**/*",
     "tests/**/*",
@@ -53,6 +54,7 @@ serde = ["dep:serde", "zerovec/serde", "icu_locid/serde", "icu_provider/serde"]
 datagen = ["serde", "zerovec/databake", "dep:databake"]
 experimental = []
 bench = ["serde"]
+data = []
 
 [lib]
 path = "src/lib.rs"

components/plurals/build.rs

@@ -0,0 +1,13 @@
+// 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 ).
+
+fn main() {
+    if std::env::var("CARGO_FEATURE_DATA").is_ok() {
+        match std::env::var("ICU4X_DATA_DIR") {
+            Ok(path) => println!("cargo:rustc-env=MACROS_RS={}/macros.rs", path),
+            Err(_) => println!("cargo:rustc-env=MACROS_RS=../data/macros.rs"),
+        }
+        println!("cargo:rerun-if-env-changed=ICU4X_DATA_DIR");
+    }
+}

components/plurals/data/any.rs

@@ -0,0 +1,2 @@
+// @generated
+impl_any_provider ! (BakedDataProvider) ;

components/plurals/data/macros.rs

@@ -0,0 +1,2 @@
+// @generated
+include ! ("macros.rs") ; # [clippy :: msrv = "1.61"] pub struct BakedDataProvider ; impl_data_provider ! (BakedDataProvider) ;

components/plurals/data/mod.rs

@@ -84,6 +84,17 @@ mod operands;
 pub mod provider;
 pub mod rules;
 
+#[doc(hidden)]
+#[cfg(feature = "data")]
+pub mod data {
+    include!(core::env!("MACROS_RS"));
+
+    use crate as icu_plurals;
+    pub(crate) struct Provider;
+    impl_plurals_ordinal_v1!(Provider);
+    impl_plurals_cardinal_v1!(Provider);
+}
+
 use core::cmp::{Ord, PartialOrd};
 pub use error::PluralsError;
 use icu_provider::prelude::*;
@@ -289,30 +300,30 @@ impl PluralCategory {
 pub struct PluralRules(DataPayload<ErasedPluralRulesV1Marker>);
 
 impl PluralRules {
-    /// Constructs a new `PluralRules` for a given locale, [`type`] and [`data provider`].
-    ///
-    /// This constructor will fail if the [`Data Provider`] does not have the data.
-    ///
-    /// [📚 Help choosing a constructor](icu_provider::constructors)
-    /// <div class="stab unstable">
-    /// ⚠️ The bounds on this function may change over time, including in SemVer minor releases.
-    /// </div>
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use icu::locid::locale;
-    /// use icu::plurals::{PluralRuleType, PluralRules};
-    ///
-    /// let _ = PluralRules::try_new_unstable(
-    ///     &icu_testdata::unstable(),
-    ///     &locale!("en").into(),
-    ///     PluralRuleType::Cardinal,
-    /// );
-    /// ```
-    ///
-    /// [`type`]: PluralRuleType
-    /// [`data provider`]: icu_provider
+
+    icu_provider::gen_any_buffer_data_constructors!(
+        locale: include,
+        rule_type: PluralRuleType,
+        error: PluralsError,
+        /// Constructs a new `PluralRules` for a given locale, [`type`] and [`data provider`].
+        ///
+        /// # Examples
+        ///
+        /// ```
+        /// use icu::locid::locale;
+        /// use icu::plurals::{PluralRuleType, PluralRules};
+        ///
+        /// let _ = PluralRules::try_new(
+        ///     &locale!("en").into(),
+        ///     PluralRuleType::Cardinal,
+        /// );
+        /// ```
+        ///
+        /// [`type`]: PluralRuleType
+        /// [`data provider`]: icu_provider
+    );
+
+    #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
     pub fn try_new_unstable<D>(
         data_provider: &D,
         locale: &DataLocale,
@@ -327,44 +338,42 @@ impl PluralRules {
         }
     }
 
-    icu_provider::gen_any_buffer_constructors!(
+    icu_provider::gen_any_buffer_data_constructors!(
         locale: include,
-        rule_type: PluralRuleType,
-        error: PluralsError
+        options: skip,
+        error: PluralsError,
+        /// Constructs a new `PluralRules` for a given locale for cardinal numbers.
+        ///
+        /// Cardinal plural forms express quantities of units such as time, currency or distance,
+        /// used in conjunction with a number expressed in decimal digits (i.e. "2", not "two").
+        ///
+        /// For example, English has two forms for cardinals:
+        ///
+        /// * [`One`]: `1 day`
+        /// * [`Other`]: `0 days`, `2 days`, `10 days`, `0.3 days`
+        /// 
+        /// # Examples
+        ///
+        /// ```
+        /// use icu::locid::locale;
+        /// use icu::plurals::{PluralCategory, PluralRules};
+        ///
+        /// let rules = PluralRules::try_new_cardinal(&locale!("ru").into()).expect("Data should be present");
+        ///
+        /// assert_eq!(rules.category_for(2_usize), PluralCategory::Few);
+        /// ```
+        ///
+        /// [`One`]: PluralCategory::One
+        /// [`Other`]: PluralCategory::Other
+        functions: [
+            Self::try_new_cardinal_unstable,
+            try_new_cardinal_with_any_provider,
+            try_new_cardinal_with_buffer_provider,
+            try_new_cardinal,
+        ]
     );
 
-    /// Constructs a new `PluralRules` for a given locale for cardinal numbers.
-    ///
-    /// Cardinal plural forms express quantities of units such as time, currency or distance,
-    /// used in conjunction with a number expressed in decimal digits (i.e. "2", not "two").
-    ///
-    /// For example, English has two forms for cardinals:
-    ///
-    /// * [`One`]: `1 day`
-    /// * [`Other`]: `0 days`, `2 days`, `10 days`, `0.3 days`
-    ///
-    /// [📚 Help choosing a constructor](icu_provider::constructors)
-    /// <div class="stab unstable">
-    /// ⚠️ The bounds on this function may change over time, including in SemVer minor releases.
-    /// </div>
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use icu::locid::locale;
-    /// use icu::plurals::{PluralCategory, PluralRules};
-    ///
-    /// let rules = PluralRules::try_new_cardinal_unstable(
-    ///     &icu_testdata::unstable(),
-    ///     &locale!("ru").into(),
-    /// )
-    /// .expect("Data should be present");
-    ///
-    /// assert_eq!(rules.category_for(2_usize), PluralCategory::Few);
-    /// ```
-    ///
-    /// [`One`]: PluralCategory::One
-    /// [`Other`]: PluralCategory::Other
+    #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new_cardinal)]
     pub fn try_new_cardinal_unstable<D>(
         data_provider: &D,
         locale: &DataLocale,
@@ -383,52 +392,49 @@ impl PluralRules {
         ))
     }
 
-    icu_provider::gen_any_buffer_constructors!(
+    icu_provider::gen_any_buffer_data_constructors!(
         locale: include,
         options: skip,
         error: PluralsError,
+        /// Constructs a new `PluralRules` for a given locale for ordinal numbers.
+        ///
+        /// Ordinal plural forms denote the order of items in a set and are always integers.
+        ///
+        /// For example, English has four forms for ordinals:
+        ///
+        /// * [`One`]: `1st floor`, `21st floor`, `101st floor`
+        /// * [`Two`]: `2nd floor`, `22nd floor`, `102nd floor`
+        /// * [`Few`]: `3rd floor`, `23rd floor`, `103rd floor`
+        /// * [`Other`]: `4th floor`, `11th floor`, `96th floor`
+        ///
+        /// # Examples
+        ///
+        /// ```
+        /// use icu::locid::locale;
+        /// use icu::plurals::{PluralCategory, PluralRules};
+        ///
+        /// let rules = PluralRules::try_new_ordinal_unstable(
+        ///     &icu_testdata::unstable(),
+        ///     &locale!("ru").into(),
+        /// )
+        /// .expect("Data should be present");
+        ///
+        /// assert_eq!(rules.category_for(2_usize), PluralCategory::Other);
+        /// ```
+        ///
+        /// [`One`]: PluralCategory::One
+        /// [`Two`]: PluralCategory::Two
+        /// [`Few`]: PluralCategory::Few
+        /// [`Other`]: PluralCategory::Other
         functions: [
-            Self::try_new_cardinal_unstable,
-            try_new_cardinal_with_any_provider,
-            try_new_cardinal_with_buffer_provider
+            Self::try_new_ordinal_unstable,
+            try_new_ordinal_with_any_provider,
+            try_new_ordinal_with_buffer_provider,
+            try_new_ordinal,
         ]
     );
 
-    /// Constructs a new `PluralRules` for a given locale for ordinal numbers.
-    ///
-    /// Ordinal plural forms denote the order of items in a set and are always integers.
-    ///
-    /// For example, English has four forms for ordinals:
-    ///
-    /// * [`One`]: `1st floor`, `21st floor`, `101st floor`
-    /// * [`Two`]: `2nd floor`, `22nd floor`, `102nd floor`
-    /// * [`Few`]: `3rd floor`, `23rd floor`, `103rd floor`
-    /// * [`Other`]: `4th floor`, `11th floor`, `96th floor`
-    ///
-    /// [📚 Help choosing a constructor](icu_provider::constructors)
-    /// <div class="stab unstable">
-    /// ⚠️ The bounds on this function may change over time, including in SemVer minor releases.
-    /// </div>
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use icu::locid::locale;
-    /// use icu::plurals::{PluralCategory, PluralRules};
-    ///
-    /// let rules = PluralRules::try_new_ordinal_unstable(
-    ///     &icu_testdata::unstable(),
-    ///     &locale!("ru").into(),
-    /// )
-    /// .expect("Data should be present");
-    ///
-    /// assert_eq!(rules.category_for(2_usize), PluralCategory::Other);
-    /// ```
-    ///
-    /// [`One`]: PluralCategory::One
-    /// [`Two`]: PluralCategory::Two
-    /// [`Few`]: PluralCategory::Few
-    /// [`Other`]: PluralCategory::Other
+    #[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new_ordinal)]
     pub fn try_new_ordinal_unstable<D>(
         data_provider: &D,
         locale: &DataLocale,
@@ -447,17 +453,6 @@ impl PluralRules {
         ))
     }
 
-    icu_provider::gen_any_buffer_constructors!(
-        locale: include,
-        options: skip,
-        error: PluralsError,
-        functions: [
-            Self::try_new_ordinal_unstable,
-            try_new_ordinal_with_any_provider,
-            try_new_ordinal_with_buffer_provider
-        ]
-    );
-
     /// Returns the [`Plural Category`] appropriate for the given number.
     ///
     /// # Examples