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
// 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 ).
// Provider structs must be stable
#![allow(clippy::exhaustive_structs, clippy::exhaustive_enums)]
//! 🚧 \[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`]
use alloc::borrow::Cow;
use icu_provider::prelude::*;
mod serde_dfa;
pub use serde_dfa::SerdeDFA;
#[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_list_data::*;
pub mod icu {
pub use crate as list;
pub use icu_list_data::icu_locale as locale;
}
make_provider!(Baked);
impl_and_list_v2_marker!(Baked);
impl_or_list_v2_marker!(Baked);
impl_unit_list_v2_marker!(Baked);
};
#[cfg(feature = "datagen")]
/// The latest minimum set of markers required by this component.
pub const MARKERS: &[DataMarkerInfo] = &[
AndListV2Marker::INFO,
OrListV2Marker::INFO,
UnitListV2Marker::INFO,
];
/// Symbols and metadata required for [`ListFormatter`](crate::ListFormatter).
///
/// <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(
AndListV2Marker = "list/and@2",
OrListV2Marker = "list/or@2",
UnitListV2Marker = "list/unit@2"
)]
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_list::provider))]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct ListFormatterPatternsV2<'data> {
/// The start pattern
#[cfg_attr(feature = "serde", serde(borrow))]
pub start: ListJoinerPattern<'data>,
/// The middle pattern. It doesn't need to be a pattern because it has to start with `{0}`
/// and end with `{1}`, so we just store the string in between.
#[cfg_attr(feature = "serde", serde(borrow))]
pub middle: Cow<'data, str>,
/// The end pattern
#[cfg_attr(feature = "serde", serde(borrow))]
pub end: ConditionalListJoinerPattern<'data>,
/// The pair pattern, if it's different from the end pattern.
#[cfg_attr(feature = "serde", serde(borrow))]
pub pair: Option<ConditionalListJoinerPattern<'data>>,
}
impl ListFormatterPatternsV2<'_> {
/// The marker attributes for narrow lists
pub const NARROW: &'static DataMarkerAttributes = DataMarkerAttributes::from_str_or_panic("N");
#[doc(hidden)]
pub const NARROW_STR: &'static str = Self::NARROW.as_str();
/// The marker attributes for short lists
pub const SHORT: &'static DataMarkerAttributes = DataMarkerAttributes::from_str_or_panic("S");
#[doc(hidden)]
pub const SHORT_STR: &'static str = Self::SHORT.as_str();
/// The marker attributes for wide lists
pub const WIDE: &'static DataMarkerAttributes = DataMarkerAttributes::from_str_or_panic("W");
#[doc(hidden)]
pub const WIDE_STR: &'static str = Self::WIDE.as_str();
}
/// A pattern that can behave conditionally on the next element.
///
/// <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(Clone, Debug, PartialEq, yoke::Yokeable, zerofrom::ZeroFrom)]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_list::provider))]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct ConditionalListJoinerPattern<'data> {
/// The default pattern
#[cfg_attr(feature = "serde", serde(borrow))]
pub default: ListJoinerPattern<'data>,
/// And optional special case
#[cfg_attr(
feature = "serde",
serde(borrow, deserialize_with = "SpecialCasePattern::deserialize_option")
)]
pub special_case: Option<SpecialCasePattern<'data>>,
}
/// The special case of a [`ConditionalListJoinerPattern`]
///
/// <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(Clone, Debug, PartialEq, yoke::Yokeable, zerofrom::ZeroFrom)]
#[cfg_attr(feature = "datagen", derive(serde::Serialize, databake::Bake))]
#[cfg_attr(feature = "datagen", databake(path = icu_list::provider))]
pub struct SpecialCasePattern<'data> {
/// The condition on the following element
pub condition: SerdeDFA<'data>,
/// The pattern if the condition matches
pub pattern: ListJoinerPattern<'data>,
}
#[cfg(feature = "serde")]
impl<'data> SpecialCasePattern<'data> {
// If the condition doesn't deserialize, the whole special case becomes `None`
fn deserialize_option<'de: 'data, D>(deserializer: D) -> Result<Option<Self>, D::Error>
where
D: serde::de::Deserializer<'de>,
{
use serde::Deserialize;
#[derive(Deserialize)]
struct SpecialCasePatternOptionalDfa<'data> {
#[cfg_attr(
feature = "serde",
serde(borrow, deserialize_with = "SerdeDFA::maybe_deserialize")
)]
pub condition: Option<SerdeDFA<'data>>,
#[cfg_attr(feature = "serde", serde(borrow))]
pub pattern: ListJoinerPattern<'data>,
}
Ok(
match Option::<SpecialCasePatternOptionalDfa<'data>>::deserialize(deserializer)? {
Some(SpecialCasePatternOptionalDfa {
condition: Some(condition),
pattern,
}) => Some(SpecialCasePattern { condition, pattern }),
_ => None,
},
)
}
}
/// A pattern containing two numeric placeholders ("{0}, and {1}.")
///
/// <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(Clone, Debug, PartialEq, yoke::Yokeable, zerofrom::ZeroFrom)]
#[cfg_attr(feature = "datagen", derive(serde::Serialize))]
pub struct ListJoinerPattern<'data> {
/// The pattern string without the placeholders
pub(crate) string: Cow<'data, str>,
/// The index of the first placeholder. Always <= index_1.
// Always 0 for CLDR data, so we don't need to serialize it.
// In-memory we have free space for it as index_1 doesn't
// fill a word.
#[cfg_attr(feature = "datagen", serde(skip))]
pub(crate) index_0: u8,
/// The index of the second placeholder. Always < string.len().
pub(crate) index_1: u8,
}
#[cfg(feature = "serde")]
impl<'de: 'data, 'data> serde::Deserialize<'de> for ListJoinerPattern<'data> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
#[derive(serde::Deserialize)]
struct Dummy<'data> {
#[cfg_attr(feature = "serde", serde(borrow))]
string: Cow<'data, str>,
index_1: u8,
}
let Dummy { string, index_1 } = Dummy::deserialize(deserializer)?;
if index_1 as usize > string.len() {
use serde::de::Error;
Err(D::Error::custom("invalid index_1"))
} else {
Ok(ListJoinerPattern {
string,
index_0: 0,
index_1,
})
}
}
}
impl<'a> ListJoinerPattern<'a> {
/// Constructs a [`ListJoinerPattern`] from raw parts. Used by databake.
///
/// # Panics
/// If `string[..index_1]` panics.
pub const fn from_parts(string: &'a str, index_1: u8) -> Self {
assert!(string.len() <= 255 && index_1 <= string.len() as u8);
Self {
string: Cow::Borrowed(string),
index_0: 0,
index_1,
}
}
}
#[cfg(feature = "datagen")]
impl databake::Bake for ListJoinerPattern<'_> {
fn bake(&self, env: &databake::CrateEnv) -> databake::TokenStream {
env.insert("icu_list");
let string = (&*self.string).bake(env);
let index_1 = self.index_1.bake(env);
databake::quote! {
icu_list::provider::ListJoinerPattern::from_parts(#string, #index_1)
}
}
}
#[cfg(feature = "datagen")]
impl databake::BakeSize for ListJoinerPattern<'_> {
fn borrows_size(&self) -> usize {
self.string.borrows_size()
}
}
#[cfg(all(test, feature = "datagen"))]
#[test]
fn databake() {
databake::test_bake!(
ListJoinerPattern,
const,
crate::provider::ListJoinerPattern::from_parts(", ", 2u8),
icu_list
);
}