use crate::provider::*;
use crate::{ListFormatterOptions, ListLength};
use core::fmt::{self, Write};
use icu_locale_core::preferences::define_preferences;
use icu_provider::marker::ErasedMarker;
use icu_provider::prelude::*;
use writeable::*;
#[cfg(doc)]
extern crate writeable;
define_preferences!(
[Copy]
ListFormatterPreferences,
{}
);
#[derive(Debug)]
pub struct ListFormatter {
data: DataPayload<ErasedMarker<ListFormatterPatternsV2<'static>>>,
}
macro_rules! constructor {
($name: ident, $name_any: ident, $name_buffer: ident, $name_unstable: ident, $marker: ty, $doc: literal) => {
icu_provider::gen_any_buffer_data_constructors!(
(prefs: ListFormatterPreferences, options: ListFormatterOptions) -> error: DataError,
#[doc = concat!("Creates a new [`ListFormatter`] that produces a ", $doc, "-type list using compiled data.")]
functions: [
$name,
$name_any,
$name_buffer,
$name_unstable,
Self
]
);
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::$name)]
pub fn $name_unstable(
provider: &(impl DataProvider<$marker> + ?Sized),
prefs: ListFormatterPreferences,
options: ListFormatterOptions,
) -> Result<Self, DataError> {
let length = match options.length.unwrap_or_default() {
ListLength::Narrow => ListFormatterPatternsV2::NARROW,
ListLength::Short => ListFormatterPatternsV2::SHORT,
ListLength::Wide => ListFormatterPatternsV2::WIDE,
};
let locale = DataLocale::from_preferences_locale::<$marker>(prefs.locale_prefs);
let data = provider
.load(DataRequest {
id: DataIdentifierBorrowed::for_marker_attributes_and_locale(
length,
&locale
),
..Default::default()
})?
.payload
.cast();
Ok(Self { data })
}
};
}
impl ListFormatter {
constructor!(
try_new_and,
try_new_and_with_any_provider,
try_new_and_with_buffer_provider,
try_new_and_unstable,
AndListV2Marker,
"and"
);
constructor!(
try_new_or,
try_new_or_with_any_provider,
try_new_or_with_buffer_provider,
try_new_or_unstable,
OrListV2Marker,
"or"
);
constructor!(
try_new_unit,
try_new_unit_with_any_provider,
try_new_unit_with_buffer_provider,
try_new_unit_unstable,
UnitListV2Marker,
"unit"
);
pub fn format<'a, W: Writeable + 'a, I: Iterator<Item = W> + Clone + 'a>(
&'a self,
values: I,
) -> FormattedList<'a, W, I> {
FormattedList {
formatter: self,
values,
}
}
pub fn format_to_string<W: Writeable, I: Iterator<Item = W> + Clone>(
&self,
values: I,
) -> alloc::string::String {
self.format(values).write_to_string().into_owned()
}
}
pub mod parts {
use writeable::Part;
pub const ELEMENT: Part = Part {
category: "list",
value: "element",
};
pub const LITERAL: Part = Part {
category: "list",
value: "literal",
};
}
#[derive(Debug)]
pub struct FormattedList<'a, W: Writeable + 'a, I: Iterator<Item = W> + Clone + 'a> {
formatter: &'a ListFormatter,
values: I,
}
impl<'a, W: Writeable + 'a, I: Iterator<Item = W> + Clone + 'a> Writeable
for FormattedList<'a, W, I>
{
fn write_to_parts<V: PartsWrite + ?Sized>(&self, sink: &mut V) -> fmt::Result {
macro_rules! literal {
($lit:ident) => {
sink.with_part(parts::LITERAL, |l| l.write_str($lit))
};
}
macro_rules! value {
($val:expr) => {
sink.with_part(parts::ELEMENT, |e| $val.write_to_parts(e))
};
}
let patterns = self.formatter.data.get();
let mut values = self.values.clone();
if let Some(first) = values.next() {
if let Some(second) = values.next() {
if let Some(third) = values.next() {
let (start_before, start_between, _) = patterns.start.parts();
literal!(start_before)?;
value!(first)?;
literal!(start_between)?;
value!(second)?;
let mut next = third;
for next_next in values {
let between = &*patterns.middle;
literal!(between)?;
value!(next)?;
next = next_next;
}
let (_, end_between, end_after) = patterns.end.parts(&next);
literal!(end_between)?;
value!(next)?;
literal!(end_after)
} else {
let (before, between, after) = patterns
.pair
.as_ref()
.unwrap_or(&patterns.end)
.parts(&second);
literal!(before)?;
value!(first)?;
literal!(between)?;
value!(second)?;
literal!(after)
}
} else {
value!(first)
}
} else {
Ok(())
}
}
fn writeable_length_hint(&self) -> LengthHint {
let mut count = 0;
let item_length = self
.values
.clone()
.map(|w| {
count += 1;
w.writeable_length_hint()
})
.sum::<LengthHint>();
item_length + self.formatter.data.get().length_hint(count)
}
}
impl<'a, W: Writeable + 'a, I: Iterator<Item = W> + Clone + 'a> core::fmt::Display
for FormattedList<'a, W, I>
{
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
self.write_to(f)
}
}
#[cfg(all(test, feature = "datagen"))]
mod tests {
use super::*;
use writeable::{assert_writeable_eq, assert_writeable_parts_eq};
fn formatter(patterns: ListFormatterPatternsV2<'static>) -> ListFormatter {
ListFormatter {
data: DataPayload::from_owned(patterns),
}
}
#[test]
fn test_slices() {
let formatter = formatter(crate::patterns::test::test_patterns_general());
let values = ["one", "two", "three", "four", "five"];
assert_writeable_eq!(formatter.format(values[0..0].iter()), "");
assert_writeable_eq!(formatter.format(values[0..1].iter()), "one");
assert_writeable_eq!(formatter.format(values[0..2].iter()), "$one;two+");
assert_writeable_eq!(formatter.format(values[0..3].iter()), "@one:two.three!");
assert_writeable_eq!(
formatter.format(values[0..4].iter()),
"@one:two,three.four!"
);
assert_writeable_parts_eq!(
formatter.format(values.iter()),
"@one:two,three,four.five!",
[
(0, 1, parts::LITERAL),
(1, 4, parts::ELEMENT),
(4, 5, parts::LITERAL),
(5, 8, parts::ELEMENT),
(8, 9, parts::LITERAL),
(9, 14, parts::ELEMENT),
(14, 15, parts::LITERAL),
(15, 19, parts::ELEMENT),
(19, 20, parts::LITERAL),
(20, 24, parts::ELEMENT),
(24, 25, parts::LITERAL)
]
);
}
#[test]
fn test_into_iterator() {
let formatter = formatter(crate::patterns::test::test_patterns_general());
let mut vecdeque = std::collections::vec_deque::VecDeque::<u8>::new();
vecdeque.push_back(10);
vecdeque.push_front(48);
assert_writeable_parts_eq!(
formatter.format(vecdeque.iter()),
"$48;10+",
[
(0, 1, parts::LITERAL),
(1, 3, parts::ELEMENT),
(3, 4, parts::LITERAL),
(4, 6, parts::ELEMENT),
(6, 7, parts::LITERAL),
]
);
}
#[test]
fn test_iterator() {
let formatter = formatter(crate::patterns::test::test_patterns_general());
assert_writeable_parts_eq!(
formatter.format(core::iter::repeat(5).take(2)),
"$5;5+",
[
(0, 1, parts::LITERAL),
(1, 2, parts::ELEMENT),
(2, 3, parts::LITERAL),
(3, 4, parts::ELEMENT),
(4, 5, parts::LITERAL),
]
);
}
#[test]
fn test_conditional() {
let formatter = formatter(crate::patterns::test::test_patterns_conditional());
assert_writeable_eq!(formatter.format(["beta", "alpha"].iter()), "beta :o alpha");
}
macro_rules! test {
($locale:literal, $type:ident, $(($input:expr, $output:literal),)+) => {
let f = ListFormatter::$type(
icu::locale::locale!($locale).into(),
Default::default(),
).unwrap();
$(
assert_writeable_eq!(f.format($input.iter()), $output);
)+
};
}
#[test]
fn test_basic() {
test!("fr", try_new_or, (["A", "B"], "A ou B"),);
}
#[test]
fn test_spanish() {
test!(
"es",
try_new_and,
(["x", "Mallorca"], "x y Mallorca"),
(["x", "Ibiza"], "x e Ibiza"),
(["x", "Hidalgo"], "x e Hidalgo"),
(["x", "Hierva"], "x y Hierva"),
);
test!(
"es",
try_new_or,
(["x", "Ibiza"], "x o Ibiza"),
(["x", "Okinawa"], "x u Okinawa"),
(["x", "8 más"], "x u 8 más"),
(["x", "8"], "x u 8"),
(["x", "87 más"], "x u 87 más"),
(["x", "87"], "x u 87"),
(["x", "11 más"], "x u 11 más"),
(["x", "11"], "x u 11"),
(["x", "110 más"], "x o 110 más"),
(["x", "110"], "x o 110"),
(["x", "11.000 más"], "x u 11.000 más"),
(["x", "11.000"], "x u 11.000"),
(["x", "11.000,92 más"], "x u 11.000,92 más"),
(["x", "11.000,92"], "x u 11.000,92"),
);
test!("es-AR", try_new_and, (["x", "Ibiza"], "x e Ibiza"),);
}
#[test]
fn test_hebrew() {
test!(
"he",
try_new_and,
(["x", "יפו"], "x ויפו"),
(["x", "Ibiza"], "x ו‑Ibiza"),
);
}
}