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
// 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 ).
//! 🚧 \[Unstable\] Data provider struct definitions for this ICU4X component.
//!
//! <div class="stab unstable">
//! 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
//! including in SemVer minor releases. While the serde representation of data structs is guaranteed
//! to be stable, their Rust representation might not be. Use with caution.
//! </div>
//!
//! Read more about data providers: [`icu_provider`]
//!
//! # Examples
//!
//! ## Get the resolved numbering system
//!
//! In a constructor call, the _last_ request for [`DecimalDigitsV1Marker`]
//! contains the resolved numbering system as its attribute:
//!
//! ```
//! use icu_provider::prelude::*;
//! use icu::decimal::FixedDecimalFormatter;
//! use icu::decimal::provider::DecimalDigitsV1Marker;
//! use icu::locale::locale;
//! use std::any::TypeId;
//! use std::cell::RefCell;
//!
//! struct NumberingSystemInspectionProvider<P> {
//! inner: P,
//! numbering_system: RefCell<Option<Box<DataMarkerAttributes>>>,
//! }
//!
//! impl<M, P> DataProvider<M> for NumberingSystemInspectionProvider<P>
//! where
//! M: DataMarker,
//! P: DataProvider<M>,
//! {
//! fn load(&self, req: DataRequest) -> Result<DataResponse<M>, DataError> {
//! if TypeId::of::<M>() == TypeId::of::<DecimalDigitsV1Marker>() {
//! *self.numbering_system.try_borrow_mut().unwrap() = Some(req.id.marker_attributes.to_owned());
//! }
//! self.inner.load(req)
//! }
//! }
//!
//! let provider = NumberingSystemInspectionProvider {
//! inner: icu::decimal::provider::Baked,
//! numbering_system: RefCell::new(None),
//! };
//!
//! let fdf = FixedDecimalFormatter::try_new_unstable(
//! &provider,
//! locale!("th").into(),
//! Default::default(),
//! )
//! .unwrap();
//!
//! assert_eq!(provider.numbering_system.borrow().as_ref().map(|x| x.as_str()), Some("latn"));
//!
//! let fdf = FixedDecimalFormatter::try_new_unstable(
//! &provider,
//! locale!("th-u-nu-thai").into(),
//! Default::default(),
//! )
//! .unwrap();
//!
//! assert_eq!(provider.numbering_system.borrow().as_ref().map(|x| x.as_str()), Some("thai"));
//!
//! let fdf = FixedDecimalFormatter::try_new_unstable(
//! &provider,
//! locale!("th-u-nu-adlm").into(),
//! Default::default(),
//! )
//! .unwrap();
//!
//! assert_eq!(provider.numbering_system.borrow().as_ref().map(|x| x.as_str()), Some("adlm"));
//! ```
// Provider structs must be stable
#![allow(clippy::exhaustive_structs)]
#![allow(clippy::exhaustive_enums)]
use alloc::borrow::Cow;
use icu_provider::prelude::*;
use zerovec::VarZeroCow;
#[cfg(feature = "compiled_data")]
#[derive(Debug)]
/// Baked data
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. In particular, the `DataProvider` implementations are only
/// guaranteed to match with this version's `*_unstable` providers. Use with caution.
/// </div>
pub struct Baked;
#[cfg(feature = "compiled_data")]
#[allow(unused_imports)]
const _: () = {
use icu_decimal_data::*;
pub mod icu {
pub use crate as decimal;
pub use icu_decimal_data::icu_locale as locale;
}
make_provider!(Baked);
impl_decimal_symbols_v2_marker!(Baked);
impl_decimal_digits_v1_marker!(Baked);
};
#[cfg(feature = "datagen")]
/// The latest minimum set of markers required by this component.
pub const MARKERS: &[DataMarkerInfo] = &[DecimalSymbolsV2Marker::INFO, DecimalDigitsV1Marker::INFO];
/// A collection of settings expressing where to put grouping separators in a decimal number.
/// For example, `1,000,000` has two grouping separators, positioned along every 3 digits.
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[derive(Debug, PartialEq, Clone, yoke::Yokeable, Copy, zerofrom::ZeroFrom)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_decimal::provider))]
pub struct GroupingSizesV1 {
/// The size of the first (lowest-magnitude) group.
///
/// If 0, grouping separators will never be shown.
pub primary: u8,
/// The size of groups after the first group.
///
/// If 0, defaults to be the same as `primary`.
pub secondary: u8,
/// The minimum number of digits required before the first group. For example, if `primary=3`
/// and `min_grouping=2`, grouping separators will be present on 10,000 and above.
pub min_grouping: u8,
}
/// A stack representation of the strings used in [`DecimalSymbolsV2`], i.e. a builder type
/// for [`DecimalSymbolsStrs`]. This type can be obtained from a [`DecimalSymbolsStrs`]
/// the `From`/`Into` traits.
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[derive(Debug, PartialEq, Clone, yoke::Yokeable, zerofrom::ZeroFrom)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
#[cfg_attr(feature = "datagen", derive(serde::Serialize))]
#[zerovec::make_varule(DecimalSymbolsStrs)]
#[zerovec::derive(Debug)]
#[zerovec::skip_derive(Ord)]
#[cfg_attr(feature = "serde", zerovec::derive(Deserialize))]
#[cfg_attr(feature = "datagen", zerovec::derive(Serialize))]
// Each affix/separator is at most three characters, which tends to be around 3-12 bytes each
// and the numbering system is at most 8 ascii bytes, All put together the indexing is extremely
// unlikely to have to go past 256.
#[zerovec::format(zerovec::vecs::Index8)]
pub struct DecimalSymbolStrsBuilder<'data> {
/// Prefix to apply when a negative sign is needed.
#[cfg_attr(feature = "serde", serde(borrow))]
pub minus_sign_prefix: Cow<'data, str>,
/// Suffix to apply when a negative sign is needed.
#[cfg_attr(feature = "serde", serde(borrow))]
pub minus_sign_suffix: Cow<'data, str>,
/// Prefix to apply when a positive sign is needed.
#[cfg_attr(feature = "serde", serde(borrow))]
pub plus_sign_prefix: Cow<'data, str>,
/// Suffix to apply when a positive sign is needed.
#[cfg_attr(feature = "serde", serde(borrow))]
pub plus_sign_suffix: Cow<'data, str>,
/// Character used to separate the integer and fraction parts of the number.
#[cfg_attr(feature = "serde", serde(borrow))]
pub decimal_separator: Cow<'data, str>,
/// Character used to separate groups in the integer part of the number.
#[cfg_attr(feature = "serde", serde(borrow))]
pub grouping_separator: Cow<'data, str>,
/// The numbering system to use.
#[cfg_attr(feature = "serde", serde(borrow))]
pub numsys: Cow<'data, str>,
}
impl<'data> DecimalSymbolStrsBuilder<'data> {
/// Build a [`DecimalSymbolsStrs`]
pub fn build(&self) -> VarZeroCow<'static, DecimalSymbolsStrs> {
VarZeroCow::from_encodeable(self)
}
}
/// Symbols and metadata required for formatting a [`SignedFixedDecimal`](crate::SignedFixedDecimal).
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[icu_provider::data_struct(DecimalSymbolsV2Marker = "decimal/symbols@2")]
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_decimal::provider))]
pub struct DecimalSymbolsV2<'data> {
/// String data for the symbols: +/- affixes and separators
#[cfg_attr(feature = "serde", serde(borrow))]
// We use a VarZeroCow here to reduce the stack size of DecimalSymbolsV2: instead of serializing multiple strs,
// this type will now serialize as a single u8 buffer with optimized indexing that packs all the data together
pub strings: VarZeroCow<'data, DecimalSymbolsStrs>,
/// Settings used to determine where to place groups in the integer part of the number.
pub grouping_sizes: GroupingSizesV1,
}
/// The digits for a given numbering system. This data ought to be stored in the `und` locale with an auxiliary key
/// set to the numbering system code.
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[icu_provider::data_struct(DecimalDigitsV1Marker = "decimal/digits@1")]
#[derive(Debug, PartialEq, Clone, Copy)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_decimal::provider))]
pub struct DecimalDigitsV1 {
/// Digit characters for the current numbering system. In most systems, these digits are
/// contiguous, but in some systems, such as *hanidec*, they are not contiguous.
pub digits: [char; 10],
}
impl<'data> DecimalSymbolsV2<'data> {
/// Return (prefix, suffix) for the minus sign
pub fn minus_sign_affixes(&self) -> (&str, &str) {
(
self.strings.minus_sign_prefix(),
self.strings.minus_sign_suffix(),
)
}
/// Return (prefix, suffix) for the minus sign
pub fn plus_sign_affixes(&self) -> (&str, &str) {
(
self.strings.plus_sign_prefix(),
self.strings.plus_sign_suffix(),
)
}
/// Return thhe decimal separator
pub fn decimal_separator(&self) -> &str {
self.strings.decimal_separator()
}
/// Return thhe decimal separator
pub fn grouping_separator(&self) -> &str {
self.strings.grouping_separator()
}
/// Return the numbering system
pub fn numsys(&self) -> &str {
self.strings.numsys()
}
}
impl DecimalSymbolsV2<'static> {
#[cfg(test)]
/// Create a new en-US format for use in testing
pub(crate) fn new_en_for_testing() -> Self {
let strings = DecimalSymbolStrsBuilder {
minus_sign_prefix: Cow::Borrowed("-"),
minus_sign_suffix: Cow::Borrowed(""),
plus_sign_prefix: Cow::Borrowed("+"),
plus_sign_suffix: Cow::Borrowed(""),
decimal_separator: ".".into(),
grouping_separator: ",".into(),
numsys: Cow::Borrowed("latn"),
};
Self {
strings: VarZeroCow::from_encodeable(&strings),
grouping_sizes: GroupingSizesV1 {
primary: 3,
secondary: 3,
min_grouping: 1,
},
}
}
}